GenerateMaskFromVector Task

This task generates a mask from a rasterized point, multi-point, polyline, or polygon vector layer. The mask is a binary image, where pixel values are either 1 or 0. Pixels with a value of 1 represent areas covered by the vector records, while pixels with a value of 0 represent areas not covered.

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

Output parameters (Get only): OUTPUT_RASTER

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_RASTER (required)

Specify the input raster, ensuring it overlaps with the input vector. The output raster will have the same number of columns and rows as the input raster, along with identical spatial information.

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_URI (optional)

Specify a string with the fully qualified filename and path of the associated OUTPUT_RASTER.

If you do not specify this parameter, or set it to an exclamation symbol (!), ENVI creates a temporary file.
If you set it to the hash symbol (#), ENVI creates a file in the temporary directory, but this file will not be deleted when ENVI closes.