Interface IRasterConvolutionFilter

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll

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

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("64DB07DF-FC21-4C9A-8441-7CB9791855EA")]
public interface IRasterConvolutionFilter

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.

 

Properties

GainFactor

The gain factor of the kernel filter.

double GainFactor { get; set; }

Property Value

double

IsNormalized

Indicates whether the filter is normalized.

bool IsNormalized { get; }

Property Value

bool

Recursive

Indicates whether the filter is recursive.

bool Recursive { get; set; }

Property Value

bool

Methods

GetCenterPosition(ref int, ref int)

Gets the center position of the kernel filter.

void GetCenterPosition(ref int atColumn, ref int atRow)

Parameters

atColumn int
atRow int

GetSize(ref int, ref int)

Gets the size of the kernel filter.

void GetSize(ref int nColumns, ref int nRows)

Parameters

nColumns int
nRows int

Normalize()

Normalizes the filter.

void Normalize()

PutCoefficients(ref double[])

Sets the element coefficients of the kernel filter.

void PutCoefficients(ref double[] coefList)

Parameters

coefList double[]

Remarks

PutCoefficents takes a dimentional (1D) array (row * column of the kernel), then transforms automatically to a 2D array. The side of 2D array is defined by SetSize method.

        size of 1D array = row * column of the kernel

 

QueryCoefficients(ref double[])

Gets the element coefficients of the kernel filter.

void QueryCoefficients(ref double[] coefList)

Parameters

coefList double[]

ScaleBy(double)

Scales the filter coefficients.

void ScaleBy(double ScaleFactor)

Parameters

ScaleFactor double

SetCenterPosition(int, int)

Sets the center position of the kernel filter.

void SetCenterPosition(int atColumn, int atRow)

Parameters

atColumn int
atRow int

SetSize(int, int)

Sets the size of the kernel filter.

void SetSize(int nColumns, int nRows)

Parameters

nColumns int
nRows int