com.esri.arcgis.datasourcesraster
Class FocalStatisticsFilter

java.lang.Object
  com.esri.arcgis.datasourcesraster.FocalStatisticsFilter

All Implemented Interfaces:

IFocalStatisticsFilter, IFocalStatisticsFilter2, IPixelFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FocalStatisticsFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IFocalStatisticsFilter, IFocalStatisticsFilter2

A class for focal statistics filter.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

FocalStatisticsFilter()
Constructs a FocalStatisticsFilter using ArcGIS Engine.

FocalStatisticsFilter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FocalStatisticsFilter theFocalStatisticsFilter = (FocalStatisticsFilter) obj;

Method Summary

boolean	equals(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 String	getClsid() getClsid.
void	getSize(int[] columns, int[] rows) Gets dimension of the filter.
int	getType() The focal statistic type.
int	hashCode() the hashcode for this object
boolean	isFillNoDataOnly() Option to fill only no data with pixel value.
void	setFillNoDataOnly(boolean pFillNoData) Option to fill only no data with pixel value.
void	setSize(int nColumns, int nRows) Sets the size of the focal filter.
void	setType(int pType) The focal statistic type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

FocalStatisticsFilter

public FocalStatisticsFilter()
                      throws IOException,
                             UnknownHostException

Constructs a FocalStatisticsFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FocalStatisticsFilter

public FocalStatisticsFilter(Object obj)
                      throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getSize

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

Gets dimension of the filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSize in interface IPixelFilter

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

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

Gets center position of the filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCenterPosition in interface IPixelFilter

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

filter

public void filter(IPixelBlock pBlock)
            throws IOException,
                   AutomationException

Filters a pixel block.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

filter in interface IPixelFilter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The focal statistic type.

Product Availability

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

Specified by:

getType in interface IFocalStatisticsFilter

Returns:

A com.esri.arcgis.datasourcesraster.esriFocalStatisticType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int pType)
             throws IOException,
                    AutomationException

The focal statistic type.

Product Availability

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

Specified by:

setType in interface IFocalStatisticsFilter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

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

Sets the size of the focal filter.

Product Availability

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

Specified by:

setSize in interface IFocalStatisticsFilter

Parameters:

nColumns - The nColumns (in)

nRows - The nRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFillNoDataOnly

public boolean isFillNoDataOnly()
                         throws IOException,
                                AutomationException

Option to fill only no data with pixel value.

Product Availability

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

Specified by:

isFillNoDataOnly in interface IFocalStatisticsFilter2

Returns:

The pFillNoData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFillNoDataOnly

public void setFillNoDataOnly(boolean pFillNoData)
                       throws IOException,
                              AutomationException

Option to fill only no data with pixel value.

Product Availability

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

Specified by:

setFillNoDataOnly in interface IFocalStatisticsFilter2

Parameters:

pFillNoData - The pFillNoData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.