>  Docs Center  >  ENVI API  >  Processing  >  ENVIKuanAdaptiveFilterTask

ENVIKuanAdaptiveFilterTask

ENVIKuanAdaptiveFilterTask

This task applies a Kuan filter to a raster, to reduce speckle while preserving edges in radar images. It transforms the multiplicative noise model into an additive noise model. This filter is similar to the Lee filter but uses a different weighting function. The pixel being filtered is replaced with a value calculated based on the local statistics.

Reference: Zhenghao Shi and Ko B. Fung, “A Comparison of Digital Speckle Filters,” Proceedings of IGARSS 94, August 8-12, 1994, pp. 2129-2133.

Example


; Start the application
e = ENVI()
 
; Open an input file
File = Filepath('elev_t.jpg', Subdir=['examples','data'])
Raster = e.OpenRaster(File)
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('KuanAdaptiveFilter')
 
; Define an input raster
Task.INPUT_RASTER = Raster
 
; Define a window size
Task.WINDOW_SIZE = 5
 
; Define the number of looks
Task.LOOKS = 2
 
; 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('KuanAdaptiveFilter')

Input properties (Set, Get): INPUT_RASTER, LOOKS, OUTPUT_RASTER_URI, WINDOW_SIZE

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 Kuan adaptive filtering.

LOOKS (optional)

Specify the effective number of looks. The default value is 1. This property is used to calculate the noise variance by 1/(number of looks).

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.

WINDOW_SIZE (optional)

Specify a square filtering window size, in pixels. The default value is 3.

Version History


ENVI 5.3

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIAdditiveLeeAdaptiveFilterTask, ENVIAdditiveMultiplicativeLeeAdaptiveFilterTask, ENVIBitErrorAdaptiveFilterTask, ENVIEnhancedFrostAdaptiveFilterTask, ENVIEnhancedLeeAdaptiveFilterTask, ENVIFrostAdaptiveFilterTask, ENVIGammaAdaptiveFilterTask, ENVILocalSigmaAdaptiveFilterTask, ENVIMultiplicativeLeeAdaptiveFilterTask



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