com.esri.arcgis.datasourcesraster

Class RasterConvolutionFilter

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterConvolutionFilter

All Implemented Interfaces:

IPixelFilter, IRasterConvolutionFilter, IStockConvolutionFilter, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RasterConvolutionFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IRasterConvolutionFilter, IStockConvolutionFilter

COM Class 'RasterConvolutionFilter'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A raster kernel-based filter.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter

IID, IID90e3de9d_4fff_4575_b833_3ad29a57eeca, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterConvolutionFilter

IID, IID64db07df_fc21_4c9a_8441_7cb9791855ea, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IStockConvolutionFilter

IID, IID4b0cc599_d839_46fd_9865_33bdb167cdc6, xxDummy

Constructor Summary

Constructors

Constructor and Description
RasterConvolutionFilter() Constructs a RasterConvolutionFilter using ArcGIS Engine.
RasterConvolutionFilter(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterConvolutionFilter theRasterConvolutionFilter = (RasterConvolutionFilter) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
void	filter(IPixelBlock pBlock) Filters a pixel block.
void	getCenterPosition(int[] atColumn, int[] atRow) Gets center position of the filter.
static java.lang.String	getClsid() getClsid.
double	getGainFactor() The gain factor of the kernel filter.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
void	getSize(int[] columns, int[] rows) Gets dimension of the filter.
int	getType() The type of the stock kernel filter.
int	hashCode() the hashcode for this object
boolean	isNormalized() Indicates whether the filter is normalized.
boolean	isRecursive() Indicates whether the filter is recursive.
void	normalize() Normalizes the filter.
void	putCoefficients(double[][] coefList) Sets the element coefficients of the kernel filter.
void	queryCoefficients(double[][] coefList) Gets the element coefficients of the kernel filter.
void	release() Release this COM object reference
void	scaleBy(double scaleFactor) Scales the filter coefficients.
void	setCenterPosition(int atColumn, int atRow) Sets the center position of the kernel filter.
void	setGainFactor(double gainFactor) The gain factor of the kernel filter.
void	setRecursive(boolean recursive) Indicates whether the filter is recursive.
void	setSize(int nColumns, int nRows) Sets the size of the kernel filter.
void	setType(int filterType) The type of the stock kernel filter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RasterConvolutionFilter

public RasterConvolutionFilter()
                        throws java.io.IOException,
                               java.net.UnknownHostException

Constructs a RasterConvolutionFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterConvolutionFilter

public RasterConvolutionFilter(java.lang.Object obj)
                        throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterConvolutionFilter theRasterConvolutionFilter = (RasterConvolutionFilter) obj;

Construct a RasterConvolutionFilter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterConvolutionFilter.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSize

public void getSize(int[] columns,
                    int[] rows)
             throws java.io.IOException,
                    AutomationException

Gets dimension of the filter.

Specified by:

getSize in interface IPixelFilter

Specified by:

getSize in interface IRasterConvolutionFilter

Parameters:

columns - The columns (in/out: use single element array)

rows - The rows (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

public void getCenterPosition(int[] atColumn,
                              int[] atRow)
                       throws java.io.IOException,
                              AutomationException

Gets center position of the filter.

Specified by:

getCenterPosition in interface IPixelFilter

Specified by:

getCenterPosition in interface IRasterConvolutionFilter

Parameters:

atColumn - The atColumn (in/out: use single element array)

atRow - The atRow (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

filter

public void filter(IPixelBlock pBlock)
            throws java.io.IOException,
                   AutomationException

Filters a pixel block.

Specified by:

filter in interface IPixelFilter

Parameters:

pBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int nColumns,
                    int nRows)
             throws java.io.IOException,
                    AutomationException

Sets the size of the kernel filter.

Specified by:

setSize in interface IRasterConvolutionFilter

Parameters:

nColumns - The nColumns (in)

nRows - The nRows (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCenterPosition

public void setCenterPosition(int atColumn,
                              int atRow)
                       throws java.io.IOException,
                              AutomationException

Sets the center position of the kernel filter.

Specified by:

setCenterPosition in interface IRasterConvolutionFilter

Parameters:

atColumn - The atColumn (in)

atRow - The atRow (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoefficients

public void putCoefficients(double[][] coefList)
                     throws java.io.IOException,
                            AutomationException

Sets the element coefficients of the kernel filter.

Specified by:

putCoefficients in interface IRasterConvolutionFilter

Parameters:

coefList - The coefList (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCoefficients

public void queryCoefficients(double[][] coefList)
                       throws java.io.IOException,
                              AutomationException

Gets the element coefficients of the kernel filter.

Specified by:

queryCoefficients in interface IRasterConvolutionFilter

Parameters:

coefList - The coefList (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGainFactor

public void setGainFactor(double gainFactor)
                   throws java.io.IOException,
                          AutomationException

The gain factor of the kernel filter.

Specified by:

setGainFactor in interface IRasterConvolutionFilter

Parameters:

gainFactor - The gainFactor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGainFactor

public double getGainFactor()
                     throws java.io.IOException,
                            AutomationException

The gain factor of the kernel filter.

Specified by:

getGainFactor in interface IRasterConvolutionFilter

Returns:

The gainFactor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecursive

public void setRecursive(boolean recursive)
                  throws java.io.IOException,
                         AutomationException

Indicates whether the filter is recursive.

Specified by:

setRecursive in interface IRasterConvolutionFilter

Parameters:

recursive - The recursive (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRecursive

public boolean isRecursive()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the filter is recursive.

Specified by:

isRecursive in interface IRasterConvolutionFilter

Returns:

The recursive

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

normalize

public void normalize()
               throws java.io.IOException,
                      AutomationException

Normalizes the filter.

Specified by:

normalize in interface IRasterConvolutionFilter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNormalized

public boolean isNormalized()
                     throws java.io.IOException,
                            AutomationException

Indicates whether the filter is normalized.

Specified by:

isNormalized in interface IRasterConvolutionFilter

Returns:

The normalized

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scaleBy

public void scaleBy(double scaleFactor)
             throws java.io.IOException,
                    AutomationException

Scales the filter coefficients.

Specified by:

scaleBy in interface IRasterConvolutionFilter

Parameters:

scaleFactor - The scaleFactor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int filterType)
             throws java.io.IOException,
                    AutomationException

The type of the stock kernel filter.

Specified by:

setType in interface IStockConvolutionFilter

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of the stock kernel filter.

Specified by:

getType in interface IStockConvolutionFilter

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterFilterTypeEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.