Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Processing / ENVIROIMaskRasterTask

ENVIROIMaskRasterTask

ENVIROIMaskRasterTask

This task exports an ROI mask raster to an ENVI-format file.

Example


; Start the application
e = ENVI()
 
; Open an input file
File = Filepath('qb_boulder_msi', Subdir=['data'], $
  Root_Dir=e.Root_Dir)
Raster = e.OpenRaster(File)
 
; Process a spatial subset
Subset = ENVISubsetRaster(Raster, Sub_Rect=[270,240,1010,1020])
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('ROIMaskRaster')
 
; Open an ROI
roifile = Filepath('qb_boulder_roi.xml', ROOT_DIR=e.Root_Dir, $
  SUBDIRECTORY=['data'])
Rois = e.OpenRoi(roifile)
 
; Define inputs
Task.DATA_IGNORE_VALUE = 0
Task.INPUT_MASK_ROI = Rois
Task.INPUT_RASTER = Subset
 
; Define outputs
Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()
 
; Run the task
Task.Execute
 
; Get the collection of data objects currently available 
; in the Data Manager
DataColl = e.Data
 
; Add the output to the Data Manager
DataColl.Add, Task.Output_Raster
 
; Display the result
View1 = e.GetView()
Layer1 = View1.CreateLayer(Task.Output_Raster)

Syntax


Result = ENVITask('ROIMaskRaster')

Input properties (Set, Get): DATA_IGNORE_VALUE, IGNORE_VALIDATE, INPUT_MASK_ROI, INPUT_RASTER, INVERSE, OUTPUT_RASTER_URI

Output properties (Get only): DESCRIPTION, NAME, OUTPUT_RASTER

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


DATA_IGNORE_VALUE (required)

Specify a unique data value for pixels in the output raster that have a non-zero pixel state value.

DESCRIPTION

This property describes the task.

IGNORE_VALIDATE (optional)

This property is now deprecated and has no effect on task behavior. All task property values are validated when they are set, and they throw an error with bad input.

INPUT_MASK_ROI (required)

Specify an array of one or more ENVIROIs. Each pixel in the ROI will not be masked.

INPUT_RASTER (required)

Specify a raster on which to perform masking.

INVERSE (optional)

Set this property to invert the input mask.

NAME

This property contains the name of the task.

OUTPUT_RASTER

This is a reference to the output raster of filetype ENVI.

OUTPUT_RASTER_URI (optional)

Specify a string with the fully qualified filename and path of the output raster. If you do not specify this property, the output raster is only temporary. Once the raster has no remaining references, ENVI deletes the temporary file.

Version History


ENVI 5.3

Introduced

API Version


3.1.0

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIROIMaskRaster, ENVICalculateCloudMaskUsingFmaskTask, ENVIDataValuesMaskRasterTask, ENVIMaskRasterTask, ENVIVectorMaskRasterTask, Masks, How do I process the pixels within a region of interest (ROI)?



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us