>  Docs Center  >  ENVI API  >  ENVIBinaryMorphologicalFilterTask
ENVI

ENVIBinaryMorphologicalFilterTask

ENVIBinaryMorphologicalFilterTask

This task performs binary 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('BinaryMorphologicalFilter')
 
; Define inputs
Task.INPUT_RASTER = Raster
Task.METHOD = 'Erode'
 
; Run the task
Task.Execute
 
; Get the collection of objects currently
; in the Data Manager
DataColl = e.Data
 
; Add the result to the Data Manager
DataColl.Add, Task.OUTPUT_RASTER
 
; Display the result
View = e.GetView()
Layer = View.CreateLayer(Task.OUTPUT_RASTER, BANDS=0)
Layer.QUICK_STRETCH = 'equalization'

Syntax


Result = ENVITask('BinaryMorphologicalFilter')

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. The elements are interpreted as binary values, either 0 or 1. If no KERNEL is specified, a 3 x 3 array will be used with a value of 1 for all of the array elements, indicating that all pixels will be used.

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, ENVIGrayscaleMorphologicalFilterTask



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