com.esri.arcgis.datasourcesraster
Interface IConvolutionFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

ConvolutionFunctionArguments, IConvolutionFunctionArgumentsProxy

public interface IConvolutionFunctionArguments
extends Serializable

Provides access to members that control a kernel-based convolution function.

Product Availability

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

Method Summary

int	getColumns() The number of columns of the kernel filter.
IDoubleArray	getKernel() The convolution filter kernel values.
Object	getRaster() The source raster object.
int	getRows() The number of rows of the kernel filter.
int	getType() The type of the stock kernel filter.
void	setColumns(int pColumns) The number of columns of the kernel filter.
void	setKernel(IDoubleArray ppKernel) The convolution filter kernel values.
void	setRasterByRef(Object ppRaster) The source raster object.
void	setRows(int pRows) The number of rows of the kernel filter.
void	setType(int pType) The type of the stock kernel filter.

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException

The source raster object.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The source raster object.

Product Availability

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

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(int pType)
             throws IOException,
                    AutomationException

The type of the stock kernel filter.

Product Availability

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

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriRasterFilterTypeEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

The type of the stock kernel filter.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterFilterTypeEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumns

void setColumns(int pColumns)
                throws IOException,
                       AutomationException

The number of columns of the kernel filter.

Product Availability

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

Parameters:

pColumns - The pColumns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumns

int getColumns()
               throws IOException,
                      AutomationException

The number of columns of the kernel filter.

Product Availability

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

Returns:

The pColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRows

void setRows(int pRows)
             throws IOException,
                    AutomationException

The number of rows of the kernel filter.

Product Availability

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

Parameters:

pRows - The pRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRows

int getRows()
            throws IOException,
                   AutomationException

The number of rows of the kernel filter.

Product Availability

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

Returns:

The pRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKernel

IDoubleArray getKernel()
                       throws IOException,
                              AutomationException

The convolution filter kernel values.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKernel

void setKernel(IDoubleArray ppKernel)
               throws IOException,
                      AutomationException

The convolution filter kernel values.

Product Availability

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

Parameters:

ppKernel - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.