ENVIExtractExamplesFromRasterTask

This task returns a reference to 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 task is used:

Example

See the following topics:

Syntax

Result = ENVITask('ExtractExamplesFromRaster')

Input properties (Set, Get): INPUT_RASTER, INPUT_ROIS, OUTPUT_EXAMPLES_URI

Output properties (Get only): OUTPUT_EXAMPLES

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Methods

This task inherits the following methods from ENVITask:

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

INPUT_RASTER (required)

Specify an ENVIRaster to extract examples from.

INPUT_ROIS (required)

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

OUTPUT_EXAMPLES

This is a reference to the output ENVIExamples object. This object will contain examples, class values, and other properties derived from the input raster and ROIs.

OUTPUT_EXAMPLES_URI (optional)

Specify a string with the fully qualified filename and path of the output object. If you do not specify this property, the output object (.epo) is only temporary. Once ENVI is closed, it deletes the temporary file. Restore the object later using ENVIRestoreObject.ENVIExamples is a persistable object that can be saved and restored.

Version History

ENVI 5.4

Introduced

API Version

3.3