ENVISpectralLibrary::GetSpectralSignature

The GetSpectralSignature function method returns an ENVISpectralSignature object associated with a specified spectrum.

Example

; Start the application

e = ENVI(/HEADLESS)

; Open a spectral library from the distribution

specLibFile = FILEPATH('veg_1dry.sli', ROOT_DIR=e.ROOT_DIR, $

  SUBDIR=['resource', 'speclib', 'veg_lib'])

specLib = ENVISpectralLibrary(specLibFile)

; print the spectra

Print, specLib.SPECTRA_NAMES

Name = 'CDE054: Pinyon Pine (Sap)'

; Get the pinyon pine (sap) spectrum

PinyonPineSap = specLib.GetSpectralSignature(Name)

; Plot the spectrum

envi.UI.PlotSpectralSignature, PinyonPineSap, PLOT_TITLE=name

Syntax

Result = ENVISpectralLibrary.GetSpectralSignature(SpectrumName [, ERROR=variable])

Return Value

This method returns an ENVISpectralSignature object representing the chosen signature from the library.

Arguments

SpectrumName

Specify a string with the spectrum name to query within an ENVISpectralLibrary. Issuing a PRINT command on the library's SPECTRA_NAMES property is a convenient way to get the spectra names.

Keywords

ERROR (optional)

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 6.1

Introduced

API Version

4.3