Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Data Control / ENVISpectralLibrary

ENVISpectralLibrary

ENVISpectralLibrary

This is a reference to an ENVISpectralLibrary object.

Example


; Start the application
e = ENVI()
 
; 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 names
Print, specLib.SPECTRA_NAMES

Syntax


Result = ENVISpectralLibrary(URI [, ERROR=variable] [, Properties=value])

Return Value


This function returns a reference to an ENVISpectralLibrary object.

Arguments


URI

Specify a fully qualified path and filename to a spectral library file (.sli).

Methods


Dehydrate

GetSpectrum

Hydrate

Keywords


ERROR

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.

Properties


Properties marked as (Get) can be retrieved, but not set.

DESCRIPTION (Get)

A description of the library.

SPECTRA_NAMES (Get)

A string array containing the spectra names in the library.

Version History


ENVI 5.3

Introduced

ENVI 5.3, Service Pack 1

Added Dehydrate method

ENVI 5.4

Added Hydrate method

API Version


3.1.0

See Also


ENVISpectralLibrary::GetSpectrum, ENVIGetSpectrumFromLibraryTask, ENVIQuerySpectralLibraryTask, ENVIResampleSpectrumTask



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us