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


  >  Docs Center  >  ENVI API  >  Processing  >  ENVIDarkSubtractionCorrectionTask

ENVIDarkSubtractionCorrectionTask

ENVIDarkSubtractionCorrectionTask

This task performs a simple atmospheric correction by subtracting a user-specified digital number (DN) from each band to account for atmospheric scattering (haze).

Example


This example uses the minimum DN value of each band as input to dark subtraction.

  ; 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)
   
  ; Calculate basic statistics
  Stats = ENVIRasterStatistics(Raster)
   
  ; Get the task from the catalog of ENVITasks
  Task = ENVITask('DarkSubtractionCorrection')
   
  ; Define inputs
  Task.INPUT_RASTER = Raster
  Task.VALUES = Stats.Min
   
  ; 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('DarkSubtractionCorrection')

Input properties (Set, Get): INPUT_RASTER, OUTPUT_RASTER_URI, VALUES

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

TAGS

This task also contains the following properties:

INPUT_RASTER (required)

Specify a raster on which to perform dark subtraction correction.

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.

VALUES (required)

Specify a digital number (DN) value or array of DN values to subtract from each band. The number of elements in the array must match the number of bands.

Version History


ENVI 5.2

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIFlatFieldCorrectionTask, ENVIIARReflectanceCorrectionTask, ENVIQUACTask



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us