VegetationSuppression Task

This task removes the vegetation spectral signature from multispectral and hyperspectral imagery, using information from red and near-infrared bands.

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)

; Get the task from the catalog of ENVITasks

Task = ENVITask('VegetationSuppression')

; Define inputs

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('VegetationSuppression')

Input properties (Set, Get): INPUT_RASTER, NIR_BAND, OUTPUT_RASTER_URI, RED_BAND

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 a raster on which to perform vegetation suppression.

NIR_BAND (optional)

Specify the band index to use for the NIR band when the image does not contain wavelength information. If the image contains wavelength information, ENVI returns the NIR band chosen for processing. If you supply this parameter, you must also supply RED_BAND.

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.

RED_BAND (optional)

Specify the band index to use for the red band when the image does not contain wavelength information. If the image contains wavelength information, ENVI returns the red band chosen for processing. If you supply this parameter, you must also supply NIR_BAND.

Version History

ENVI 5.2

Introduced

API Version

4.2