GenerateMaskFromVector Task

This task generates a mask from a rasterized point, multi-point, polyline, or polygon vector layer.

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

vectorFile = Filepath('qb_boulder_msi_vectors.shp', SUBDIR=['data'], $

  ROOT_DIR=e.Root_Dir)

Vector = e.OpenVector(vectorFile)

; Get the task from the catalog of ENVITasks

Task = ENVITask('GenerateMaskFromVector')

; Define task inputs

Task.INPUT_RASTER = Raster

Task.INPUT_VECTOR = Vector

; Run the task

Task.Execute

; Add the output to the Data Manager

e.Data.Add, Task.OUTPUT_RASTER

; Display the result

View = e.GetView()

Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax

Result = ENVITask('GenerateMaskFromVector')

Input properties (Set, Get): INPUT_RASTER, INPUT_VECTOR, LINE_THICKNESS, 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:

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

INPUT_RASTER (required)

Specify the input raster.

INPUT_VECTOR (required)

Specify the input point, multi-point, polyline, or polygon vector.

LINE_THICKNESS (optional)

Specify the line thickness (in pixels) for polylines. The default value is 1.

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 associated OUTPUT_RASTER. If you do not specify this property, or set it to an exclamation symbol (!), a temporary file will be created.

Version History

ENVI 5.5.3

Introduced

API Version

4.2