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


  >  Docs Center  >  ENVI API  >  Processing  >  ENVIRasterConvolutionTask

ENVIRasterConvolutionTask

ENVIRasterConvolutionTask

This task performs convolution filtering on a raster. If the convolution operation requires points outside of the raster, then the nearest edge points of the raster will be used.

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)
 
; Process a spatial subset
Subset = ENVISubsetRaster(Raster, Sub_Rect=[600,200,799,399])
 
; Get the task from the catalog of ENVITasks
Task = ENVITask('RasterConvolution')
 
; Define input raster
Task.INPUT_RASTER = Subset
 
; Define a 3x3 high pass kernel
kernelSize = [3, 3]
kernel = REPLICATE(-1., kernelSize[0], kernelSize[1])
kernel[1, 1] = 8.
Task.KERNEL =  kernel
 
; Define outputs
Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()
 
; 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
View1 = e.GetView()
Layer1 = View1.CreateLayer(Task.Output_Raster)

Syntax


Result = ENVITask('RasterConvolution')

Input properties (Set, Get): ADD_BACK, INPUT_RASTER, KERNEL, 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:

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

KERNEL (required)

Specify a two-element, double-precision array as the kernel.

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

Introduced

API Version


3.2

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIDirectionalFilterTask, ENVIDirectionalKernelTask, ENVIGaussianHighPassFilterTask, ENVIGaussianHighPassKernelTask, ENVIGaussianLowPassKernelTask, ENVIGaussianLowPassFilterTask, ENVIHighPassFilterTask, ENVIHighPassKernelTask, ENVILaplacianFilterTask, ENVILaplacianKernelTask, ENVILowPassFilterTask, ENVILowPassKernelTask, ENVIMedianFilterTask, ENVISobelFilterTask, ENVIRobertsFilterTask



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