The SelectSpectralSignature function method displays a dialog for selecting regions of interest (ROIs).

Example


; Launch the application
e = ENVI()
 
; Select a spectral signature
spectralSignature = e.UI.SelectSpectralSignature()
PRINT, spectralSignature

Syntax


Result = ENVIUI.SelectSpectralSignature([, Keywords=value])

Return Value


This method returns an ENVISpectralSignature object defined by the parameters entered in the dialog. If users close the dialog before making a selection, or if they click the Cancel button, !NULL is returned.

Arguments


None

Keywords


Keywords are applied only during the initial creation of the object.

ALLOW_MULTIPLE (optional)

Set this keyword to allow multiple selection in the dialog. The method will return an array of ENVISpectralSignature objects.

DIALOG_PARENT (optional)

Set this keyword to the widget ID of a widget that will be used as the parent of the selection dialog. If you close the parent dialog, the ROI selection dialog will also close.

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

See Also


ENVIUI, ENVIUI::SelectSpectralLibrarySignature, ENVIUI::PlotSpectralSignature