ExtractROIsFromFile Task

This task opens one or more ROIs given an input URI.

Example

; Start the application

e = ENVI(/HEADLESS)

 

; Open an ROI file

File = Filepath('qb_boulder_roi.xml', Subdir=['data'], $

  Root_Dir=e.Root_Dir)

 

; Get the task from the catalog of ENVITasks

Task = ENVITask('ExtractROIsFromFile')

 

; Define task inputs

Task.INPUT_URI = File

Task.ROI_NAMES = ['Water', 'Disturbed Earth']

 

; Run the task

Task.Execute

 

; Print the output ROI names

FOREACH roi, Task.OUTPUT_ROIS DO Print, roi.Name

Syntax

Result = ENVITask('ExtractROIsFromFile')

Input parameters (Set, Get): INPUT_URI, ROI_NAMES

Output parameters (Get only): OUTPUT_ROIS

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

Input Parameters

INPUT_URI (required)

Specify the input URI.

ROI_NAMES (optional)

Specify a string array with the names of the ROIs to open. If not set, all of the ROIs in the URI will be returned. The order of the output ROIs will be determined by this parameter.

Output Parameters

OUTPUT_ROIS

This is an array of ROIs extracted from the URI.

Methods

Execute

Parameter

ParameterNames

Properties

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

Version History

ENVI 5.5.2

Introduced

See Also

ENVITask, ENVIROI