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

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 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_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.

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.

Output Parameters


OUTPUT_RASTER

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

Methods


Execute

Parameter

ParameterNames

Properties


DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

Version History


ENVI 5.2

Introduced

See Also


ENVITask, VegetationDelineation Task