com.esri.arcgis.datasourcesraster

Class SpectralLibrary

java.lang.Object

com.esri.arcgis.datasourcesraster.SpectralLibrary

All Implemented Interfaces:

ISpectralLibrary, com.esri.arcgis.interop.RemoteObjRef, IXMLSerialize, java.io.Serializable

public class SpectralLibrary
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISpectralLibrary, IXMLSerialize

COM Class 'SpectralLibrary'. Generated 9/23/2025 7:46:19 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'The spectral library class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISpectralLibrary

IID, IID024048ca_eb92_4334_be34_a4f2bf607f05, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

Constructors

Constructor and Description
SpectralLibrary() Constructs a SpectralLibrary using ArcGIS Engine.
SpectralLibrary(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SpectralLibrary theSpectralLibrary = (SpectralLibrary) obj;

Method Summary

Modifier and Type	Method and Description
void	addSample(ISpectralSample pSpectralSample) Adds a Spectral Sample to the spectral library.
void	addSensor(ISpectralSensor pSpectralSensor) Adds a Spectral Sensor to the spectral library.
void	buildMatchedFilters(IDoubleArray pCovMatArray, IDoubleArray pTargetArray, int numBands, int numTargets, int method, IDoubleArray[] ppBandWeights, ILongArray[] ppBandIsValid) Compute matched filters for target spectra using background covariance.
void	computeBackgroundStats(java.lang.Object pRas, ITrackCancel pTrackCancel, IDoubleArray[] ppCovMatArray, IDoubleArray[] ppMeanArray) Compute background statistics from the input raster.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	esri_getSource() Gets the Spectral Library source path.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IArray	getSamples() Gets the Spectral Library array of Samples.
IArray	getSensors() Gets the Spectral Library array of Sensors.
int	getSpecLibType() Gets the Spectral Library Type.
java.lang.String	getVersion() Gets the Spectral Library Version.
int	hashCode() the hashcode for this object
void	loadENVISpectralLibrary(java.lang.String path) Loads the ENVI Spectral Libary located in the specified file path.
void	loadESRISpectralLibrary(java.lang.String path) Loads the ESRI Spectral Libary located in the specified file path.
void	loadUSGSSpectralLibrary(java.lang.String path, boolean fullyLoad) Loads the USGS Spectral Libary located in the specified folder path.
void	release() Release this COM object reference
void	removeContinuum() Remove continuum from a spectral library.
void	removeSample(GUID sampleId) Removes a Spectral Sample from the spectral library specified by its ID.
void	removeSensor(GUID sensorId) Removes a Spectral Sensor from the spectral library specified by its ID.
void	resample(IDoubleArray pTargetMinWavelengths, IDoubleArray pTargetMaxWavelengths, int targetWlut, GUID targetSensorId, java.lang.String targetSensorName, int method) Resample a spectral library to target min / max wavelengths.
void	resampleCenter(IDoubleArray pTargetCenterWavelengths, int targetWlut, GUID targetSensorId, java.lang.String targetSensorName, int method) Resample a spectral library to target center wavelengths.
void	resampleToTargetRaster(IRaster pRaster, int method) Resample a spectral library to target raster.
void	resampleToTargetSensor(ISpectralSensor pSpectralSensor, int method) Resample a spectral library to target sensor.
void	saveAsESRISpectralLibrary(java.lang.String path) Saves the Spectral Library as ESRI Spectral Library file (.esl) in the specified path
void	serialize(IXMLSerializeData data) Serializes an object to XML.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpectralLibrary

public SpectralLibrary()
                throws java.io.IOException,
                       java.net.UnknownHostException

Constructs a SpectralLibrary using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SpectralLibrary

public SpectralLibrary(java.lang.Object obj)
                throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SpectralLibrary theSpectralLibrary = (SpectralLibrary) obj;

Construct a SpectralLibrary using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SpectralLibrary.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

esri_getSource

public java.lang.String esri_getSource()
                                throws java.io.IOException,
                                       AutomationException

Gets the Spectral Library source path.

Specified by:

esri_getSource in interface ISpectralLibrary

Returns:

The pPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecLibType

public int getSpecLibType()
                   throws java.io.IOException,
                          AutomationException

Gets the Spectral Library Type.

Specified by:

getSpecLibType in interface ISpectralLibrary

Returns:

A com.esri.arcgis.datasourcesraster.SpectralLibraryType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

public java.lang.String getVersion()
                            throws java.io.IOException,
                                   AutomationException

Gets the Spectral Library Version.

Specified by:

getVersion in interface ISpectralLibrary

Returns:

The pVersion

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSensors

public IArray getSensors()
                  throws java.io.IOException,
                         AutomationException

Gets the Spectral Library array of Sensors.

Specified by:

getSensors in interface ISpectralLibrary

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSamples

public IArray getSamples()
                  throws java.io.IOException,
                         AutomationException

Gets the Spectral Library array of Samples.

Specified by:

getSamples in interface ISpectralLibrary

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadUSGSSpectralLibrary

public void loadUSGSSpectralLibrary(java.lang.String path,
                                    boolean fullyLoad)
                             throws java.io.IOException,
                                    AutomationException

Loads the USGS Spectral Libary located in the specified folder path.

Specified by:

loadUSGSSpectralLibrary in interface ISpectralLibrary

Parameters:

path - The path (in)

fullyLoad - The fullyLoad (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadESRISpectralLibrary

public void loadESRISpectralLibrary(java.lang.String path)
                             throws java.io.IOException,
                                    AutomationException

Loads the ESRI Spectral Libary located in the specified file path.

Specified by:

loadESRISpectralLibrary in interface ISpectralLibrary

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resampleToTargetSensor

public void resampleToTargetSensor(ISpectralSensor pSpectralSensor,
                                   int method)
                            throws java.io.IOException,
                                   AutomationException

Resample a spectral library to target sensor.

Specified by:

resampleToTargetSensor in interface ISpectralLibrary

Parameters:

pSpectralSensor - A reference to a com.esri.arcgis.datasourcesraster.ISpectralSensor (in)

method - A com.esri.arcgis.datasourcesraster.SpectralResampleMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resampleToTargetRaster

public void resampleToTargetRaster(IRaster pRaster,
                                   int method)
                            throws java.io.IOException,
                                   AutomationException

Resample a spectral library to target raster.

Specified by:

resampleToTargetRaster in interface ISpectralLibrary

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

method - A com.esri.arcgis.datasourcesraster.SpectralResampleMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resampleCenter

public void resampleCenter(IDoubleArray pTargetCenterWavelengths,
                           int targetWlut,
                           GUID targetSensorId,
                           java.lang.String targetSensorName,
                           int method)
                    throws java.io.IOException,
                           AutomationException

Resample a spectral library to target center wavelengths.

Specified by:

resampleCenter in interface ISpectralLibrary

Parameters:

pTargetCenterWavelengths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

targetWlut - A com.esri.arcgis.datasourcesraster.WavelengthUnitType constant (in)

targetSensorId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

targetSensorName - The targetSensorName (in)

method - A com.esri.arcgis.datasourcesraster.SpectralResampleMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resample

public void resample(IDoubleArray pTargetMinWavelengths,
                     IDoubleArray pTargetMaxWavelengths,
                     int targetWlut,
                     GUID targetSensorId,
                     java.lang.String targetSensorName,
                     int method)
              throws java.io.IOException,
                     AutomationException

Resample a spectral library to target min / max wavelengths.

Specified by:

resample in interface ISpectralLibrary

Parameters:

pTargetMinWavelengths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

pTargetMaxWavelengths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

targetWlut - A com.esri.arcgis.datasourcesraster.WavelengthUnitType constant (in)

targetSensorId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

targetSensorName - The targetSensorName (in)

method - A com.esri.arcgis.datasourcesraster.SpectralResampleMethod constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeContinuum

public void removeContinuum()
                     throws java.io.IOException,
                            AutomationException

Remove continuum from a spectral library.

Specified by:

removeContinuum in interface ISpectralLibrary

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadENVISpectralLibrary

public void loadENVISpectralLibrary(java.lang.String path)
                             throws java.io.IOException,
                                    AutomationException

Loads the ENVI Spectral Libary located in the specified file path.

Specified by:

loadENVISpectralLibrary in interface ISpectralLibrary

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSensor

public void addSensor(ISpectralSensor pSpectralSensor)
               throws java.io.IOException,
                      AutomationException

Adds a Spectral Sensor to the spectral library.

Specified by:

addSensor in interface ISpectralLibrary

Parameters:

pSpectralSensor - A reference to a com.esri.arcgis.datasourcesraster.ISpectralSensor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addSample

public void addSample(ISpectralSample pSpectralSample)
               throws java.io.IOException,
                      AutomationException

Adds a Spectral Sample to the spectral library.

Specified by:

addSample in interface ISpectralLibrary

Parameters:

pSpectralSample - A reference to a com.esri.arcgis.datasourcesraster.ISpectralSample (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSensor

public void removeSensor(GUID sensorId)
                  throws java.io.IOException,
                         AutomationException

Removes a Spectral Sensor from the spectral library specified by its ID.

Specified by:

removeSensor in interface ISpectralLibrary

Parameters:

sensorId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeSample

public void removeSample(GUID sampleId)
                  throws java.io.IOException,
                         AutomationException

Removes a Spectral Sample from the spectral library specified by its ID.

Specified by:

removeSample in interface ISpectralLibrary

Parameters:

sampleId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsESRISpectralLibrary

public void saveAsESRISpectralLibrary(java.lang.String path)
                               throws java.io.IOException,
                                      AutomationException

Saves the Spectral Library as ESRI Spectral Library file (.esl) in the specified path

Specified by:

saveAsESRISpectralLibrary in interface ISpectralLibrary

Parameters:

path - The path (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildMatchedFilters

public void buildMatchedFilters(IDoubleArray pCovMatArray,
                                IDoubleArray pTargetArray,
                                int numBands,
                                int numTargets,
                                int method,
                                IDoubleArray[] ppBandWeights,
                                ILongArray[] ppBandIsValid)
                         throws java.io.IOException,
                                AutomationException

Compute matched filters for target spectra using background covariance.

Specified by:

buildMatchedFilters in interface ISpectralLibrary

Parameters:

pCovMatArray - A reference to a com.esri.arcgis.system.IDoubleArray (in)

pTargetArray - A reference to a com.esri.arcgis.system.IDoubleArray (in)

numBands - The numBands (in)

numTargets - The numTargets (in)

method - A com.esri.arcgis.datasourcesraster.SpectralMatchingMethod constant (in)

ppBandWeights - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

ppBandIsValid - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeBackgroundStats

public void computeBackgroundStats(java.lang.Object pRas,
                                   ITrackCancel pTrackCancel,
                                   IDoubleArray[] ppCovMatArray,
                                   IDoubleArray[] ppMeanArray)
                            throws java.io.IOException,
                                   AutomationException

Compute background statistics from the input raster.

Specified by:

computeBackgroundStats in interface ISpectralLibrary

Parameters:

pRas - A reference to another Object (IUnknown) (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

ppCovMatArray - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

ppMeanArray - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.