This task performs median convolution filtering.

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('MedianFilter')
 
; Define inputs
Task.INPUT_RASTER = Raster
 
; Set a square window size for median filtering
Task.WINDOW_SIZE = 5
 
; 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('MedianFilter')

Input parameters (Set, Get): ADD_BACK, INPUT_RASTER, OUTPUT_RASTER_URI, WINDOW_SIZE

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


ADD_BACK (optional)

Specify a filter add-back percentage value between 0.0 and 1.0. A value of 1.0 is equal to 100%.

INPUT_RASTER (required)

Specify a raster on which to perform median convolution filtering.

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.

WINDOW_SIZE (optional)

Specify the square window column/row size for median filtering. The default value is 3.

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

Introduced

See Also


ENVITask, DirectionalFilter Task, DirectionalKernel Task, GaussianHighPassFilter Task, GaussianHighPassKernel Task, GaussianLowPassKernel Task, GaussianLowPassFilter Task,HighPassFilter Task, HighPassKernel Task, LaplacianFilter Task, LaplacianKernel Task, LowPassFilter Task, LowPassKernel Task, RobertsFilter Task, SobelFilter Task, RasterConvolution Task, Masking Support in ENVITasks