ENVIExtractExamplesFromRaster

This function creates an ENVIExamples object that contains examples, class values, and other properties from an input raster and regions of interest (ROIs). See Prepare Data for Classification for more information on how examples and class values are used in classification.

The following diagrams show typical workflows where this function is used:

Example

See Code Example: Softmax Regression Classification Using API Objects.

Syntax

Result = ENVIExtractExamplesFromRaster(Input_Raster, Input_ROIs [, Keywords=value])

Return Value

This function returns a reference to an ENVIExamples object.

Arguments

Input_Raster

Specify an ENVIRaster to extract examples from.

Input_ROIs

Specify an array of ENVIROIs to extract examples from the input raster.

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 5.4

Introduced

API Version

3.3