>  Docs Center  >  ENVI API  >  Processing  >  ENVIVectorMaskRasterTask

ENVIVectorMaskRasterTask

ENVIVectorMaskRasterTask

This task masks a raster using a vector.

The virtual raster associated with this task is ENVIVectorMaskRaster.

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)
 
; Select input vector data
vectorName = Filepath('qb_boulder_msi_vectors.shp', SUBDIR=['data'], $
  ROOT_DIR=e.Root_Dir)
Vector = e.OpenVector(vectorName)
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('VectorMaskRaster')
 
; Define inputs
Task.DATA_IGNORE_VALUE = 0
Task.INPUT_MASK_VECTOR = Vector
Task.INPUT_RASTER = Raster
 
; 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
View = e.GetView()
Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax


Result = ENVITask('VectorMaskRaster')

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

Output properties (Get only): 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


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:

DATA_IGNORE_VALUE (required)

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

INPUT_MASK_VECTOR (required)

Specify the input vector as a mask. Each pixel inside the polygon, along the polyline, or under the point 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.

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 to export the associated OUTPUT_RASTER.

  • If you set this property to an asterisk symbol (*), the output raster will be virtual and not written to disk.
  • If you do not specify this property, or set it to an exclamation symbol (!), a temporary file will be created.

Version History


ENVI 5.3

Introduced

ENVI 5.5

OUTPUT_RASTER_URI now supports '*', which allows OUTPUT_RASTER to be virtual output.

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIVectorMaskRaster , ENVICalculateCloudTaskUsingFmaskTask, ENVIDataValuesMaskRasterTask, ENVIMaskRasterTask, ENVIROIMaskRasterTask, Masks



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