>  Docs Center  >  ENVI API  >  Processing  >  ENVIVectorRecordsToROITask

ENVIVectorRecordsToROITask

ENVIVectorRecordsToROITask

This task creates a single region of interest (ROI) from all geometry records in a vector.

Example


; Start the application
e = ENVI()
 
; Open an input file
File = Filepath('qb_boulder_msi_vectors.shp', Subdir=['data'], $
  Root_Dir=e.Root_Dir)
Vector = e.OpenVector(File)
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('VectorRecordsToROI')
 
; Define inputs
Task.INPUT_VECTOR = Vector
 
; Run the task
Task.Execute
 
; Display the result
DisplayFile = Filepath('qb_boulder_msi', Subdir=['data'], $
  Root_Dir=e.Root_Dir)
Raster = e.OpenRaster(DisplayFile)
View = e.GetView()
Layer = View.CreateLayer(Raster)
VisRoi = Layer.AddRoi(Task.OUTPUT_ROI)

Syntax


Result = ENVITask('VectorRecordsToROI')

Input properties (Set, Get): INPUT_VECTOR, OUTPUT_ROI_URI

Output properties (Get only): OUTPUT_ROI

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:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties


This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

This task also contains the following properties:

INPUT_VECTOR (required)

Specify the input vector that contains the geometry records.

OUTPUT_ROI

This is a reference to the output ROI.

OUTPUT_ROI_URI (optional)

Specify a string with the fully qualified path and filename for OUTPUT_ROI.

Version History


ENVI 5.2

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVIROI



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us