com.esri.arcgis.datasourcesraster
Class ClipFilter

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

All Implemented Interfaces:

IClipFilter, IClipFilter2, IPixelFilter, IPixelFilter2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ClipFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IPixelFilter2, IClipFilter, IClipFilter2

A class for clipping filter.

Description

This object is new at ArcGIS 9.3.

Remarks

ClipFilter is a type of PixelFilter that clips a portion of raster from given geometries, a typical application of this class is polygon clipping on a raster. ClipFilter can be contructed from geomtries such as a polygon or a set of polygons. In the case of more than one geometry, ClipFilter takes the union of geometries.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ClipFilter()
Constructs a ClipFilter using ArcGIS Engine.

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

Method Summary

void	add(IGeometry pClippingGeometry) Adds a clipping geometry.
void	empty() Removes all clipping geometries.
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.
int	getClippingType() The raster clipping type.
static String	getClsid() getClsid.
void	getSize(int[] columns, int[] rows) Gets dimension of the filter.
int	hashCode() the hashcode for this object
void	init(int nCols, int nRows, IEnvelope pExtent) Initializes this filter for a given area of interest.
void	initBlock(IPnt pTopLeft, int nBlkCols, int nBlkRows) Initialize this filter for a given pixel block.
void	setClippingType(int pClippingType) The raster clipping 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

ClipFilter

public ClipFilter()
           throws IOException,
                  UnknownHostException

Constructs a ClipFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ClipFilter

public ClipFilter(Object obj)
           throws IOException

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

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

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.

init

public void init(int nCols,
                 int nRows,
                 IEnvelope pExtent)
          throws IOException,
                 AutomationException

Initializes this filter for a given area of interest.

Product Availability

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

Specified by:

init in interface IPixelFilter2

Parameters:

nCols - The nCols (in)

nRows - The nRows (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initBlock

public void initBlock(IPnt pTopLeft,
                      int nBlkCols,
                      int nBlkRows)
               throws IOException,
                      AutomationException

Initialize this filter for a given pixel block.

Product Availability

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

Specified by:

initBlock in interface IPixelFilter2

Parameters:

pTopLeft - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

nBlkCols - The nBlkCols (in)

nBlkRows - The nBlkRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometry pClippingGeometry)
         throws IOException,
                AutomationException

Adds a clipping geometry.

Remarks

Use Add method to create a ClipFilter from multiple geometries, the ClipFilter will take the union of all the gemetries.

Product Availability

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

Specified by:

add in interface IClipFilter

Parameters:

pClippingGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Removes all clipping geometries.

Product Availability

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

Specified by:

empty in interface IClipFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClippingType

public int getClippingType()
                    throws IOException,
                           AutomationException

The raster clipping type.

Product Availability

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

Specified by:

getClippingType in interface IClipFilter2

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClippingType

public void setClippingType(int pClippingType)
                     throws IOException,
                            AutomationException

The raster clipping type.

Product Availability

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

Specified by:

setClippingType in interface IClipFilter2

Parameters:

pClippingType - A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.