>  Docs Center  >  ENVI API  >  ENVIGrayscaleMorphologicalFilterTask
ENVI

ENVIGrayscaleMorphologicalFilterTask

ENVIGrayscaleMorphologicalFilterTask

This task performs grayscale morphological filtering on an ENVIRaster.

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('GrayscaleMorphologicalFilter')
 
; Define inputs
Task.INPUT_RASTER = Raster
Task.METHOD = 'Erode'
 
; Run the task
Task.Execute
 
; Get the data collection
DataColl = e.Data
 
; Add the output to the data collection
DataColl.Add, Task.OUTPUT_RASTER
 
; Display the result
View = e.GetView()
Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax


Result = ENVITask('GrayscaleMorphologicalFilter')

Input properties (Set, Get): INPUT_RASTER, ITERATIONS, KERNEL, METHOD, OUTPUT_RASTER_URI

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 morphological filtering.

ITERATIONS (optional)

Specify the number of iterations used to perform the morphological operation. The default value is 1.

KERNEL (required)

Specify a structuring element for the morphological process. Each finite element in the array is either subtracted from (in erosion) or added to (in dilation) the associated pixels. NaN or Infinite values imply pixels that are not included in the computation. If no KERNEL is specified, a 3 x 3 array will be used with a value of 0 for all of the array elements, indicating that all pixels will be used without addition or subtraction.

METHOD (required)

Specify a string indicating the filter method. The choices are:

  • Erode
  • Dilate
  • Open
  • Close

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.

Version History


ENVI 5.4, Service Pack 1

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIBinaryMorphologicalFilterTask



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