|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.BackgroundFilter
public class BackgroundFilter
A raster background filter.
The BackgroundFilter is a pixel filter that trims left and right pixels with a given background value (by setting them to NoData), until the first non background pixel is encountered. This pixel filter works the best when the pixel block spans the entire scan line. It can be used to implement the background functionality in ArcSDE command line command SDERASTER.
To filter multiple background values, multiple filters can be stacked into a PixelFilterCollection.
The BackgroundFilter sets boundary pixels to NoData.
IPixelFilter
,
Serialized FormConstructor Summary | |
---|---|
BackgroundFilter()
Constructs a BackgroundFilter using ArcGIS Engine. |
|
BackgroundFilter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. BackgroundFilter theBackgroundFilter = (BackgroundFilter) obj; |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
void |
filter(IPixelBlock pBlock)
Filters a pixel block. |
Object |
getBackground()
The background value to be filtered. |
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 |
hashCode()
the hashcode for this object |
void |
setBackground(Object value)
The background value to be filtered. |
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 BackgroundFilter() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic BackgroundFilter(Object obj) throws IOException
BackgroundFilter theBackgroundFilter = (BackgroundFilter) obj;
obj
to BackgroundFilter
.
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 Object getBackground() throws IOException, AutomationException
getBackground
in interface IBackgroundFilter
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackground(Object value) throws IOException, AutomationException
setBackground
in interface IBackgroundFilter
value
- A Variant (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 |