Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  ENVI API  >  Processing  >  ENVIVegetationSuppressionTask

ENVIVegetationSuppressionTask

ENVIVegetationSuppressionTask

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)
 
; Process a spatial subset
Subset = ENVISubsetRaster(Raster, Sub_Rect=[600,200,799,399])
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('VegetationSuppression')
 
; Define inputs
Task.INPUT_RASTER = Subset
 
; Define outputs
Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()
 
; 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
View1 = e.GetView()
Layer1 = View1.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:

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

This task also contains the following properties:

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 keyword, 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 keyword, you must also supply NIR_BAND.

Version History


ENVI 5.2

Introduced

API Version


3.2

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster



© 2018 Harris Geospatial Solutions, Inc. |  Privacy Policy
My Account    |    Store    |    Contact Us