This document is archived and information here might be outdated.  Recommended version.


IRasterConvolutionFilter Interface (ArcObjects .NET 10.7 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > DataSourcesRaster > ESRI.ArcGIS.DataSourcesRaster > Interfaces > IR > IRasterConvolutionFilter Interface
ArcGIS Developer Help

IRasterConvolutionFilter Interface

Provides access to members that control a raster kernel-based filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

IRasterConvolutionFilter provides access to members that allow setting up a convolution filter. PutCoefficients() and QueryCoefficients() sets and gets kernel coefficients, which are represented as a double array.
QueryCoefficients() expects the array to be allocated by caller, and it fills in the values.


 

Members

Name Description
Read/write property GainFactor The gain factor of the kernel filter.
Method GetCenterPosition Gets the center position of the kernel filter.
Method GetSize Gets the size of the kernel filter.
Read-only property IsNormalized Indicates whether the filter is normalized.
Method Normalize Normalizes the filter.
Method PutCoefficients Sets the element coefficients of the kernel filter.
Method QueryCoefficients Gets the element coefficients of the kernel filter.
Read/write property Recursive Indicates whether the filter is recursive.
Method ScaleBy Scales the filter coefficients.
Method SetCenterPosition Sets the center position of the kernel filter.
Method SetSize Sets the size of the kernel filter.

Classes that implement IRasterConvolutionFilter

Classes Description
RasterConvolutionFilter A raster kernel-based filter.

Remarks

The IRasterConvlutionFilter interface is used to create a convolution filter, which can be used to apply on a raster to perform image filtering. To create a convolution filter, the size, values and the center of the kernel must be set.

 

Here is an example of low pass filter kernel

A 3x3 low pass filter kernel

 

Use SetSize, SetCenterPosition, and PutCoefficents to define a kernel.

 

See Also

IPixelFilter Interface | IPixelOperation Interface | IPixelFilterCollection Interface