|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.ClipFilter
public class ClipFilter
A class for clipping filter.
This object is new at ArcGIS 9.3.
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.
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 |
---|
public ClipFilter() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic ClipFilter(Object obj) throws IOException
ClipFilter theClipFilter = (ClipFilter) obj;
obj
to ClipFilter
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void getSize(int[] columns, int[] rows) throws IOException, AutomationException
getSize
in interface IPixelFilter
columns
- The columns (in/out: use single element array)rows
- The rows (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getCenterPosition(int[] atColumn, int[] atRow) throws IOException, AutomationException
getCenterPosition
in interface IPixelFilter
atColumn
- The atColumn (in/out: use single element array)atRow
- The atRow (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void filter(IPixelBlock pBlock) throws IOException, AutomationException
filter
in interface IPixelFilter
pBlock
- A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init(int nCols, int nRows, IEnvelope pExtent) throws IOException, AutomationException
init
in interface IPixelFilter2
nCols
- The nCols (in)nRows
- The nRows (in)pExtent
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void initBlock(IPnt pTopLeft, int nBlkCols, int nBlkRows) throws IOException, AutomationException
initBlock
in interface IPixelFilter2
pTopLeft
- A reference to a com.esri.arcgis.geodatabase.IPnt (in)nBlkCols
- The nBlkCols (in)nBlkRows
- The nBlkRows (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void add(IGeometry pClippingGeometry) throws IOException, AutomationException
Use Add method to create a ClipFilter from multiple geometries, the ClipFilter will take the union of all the gemetries.
add
in interface IClipFilter
pClippingGeometry
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void empty() throws IOException, AutomationException
empty
in interface IClipFilter
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getClippingType() throws IOException, AutomationException
getClippingType
in interface IClipFilter2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setClippingType(int pClippingType) throws IOException, AutomationException
setClippingType
in interface IClipFilter2
pClippingType
- A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |