com.esri.arcgis.datasourcesraster
Class BackgroundFilter

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

All Implemented Interfaces:

IBackgroundFilter, IPixelFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BackgroundFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IBackgroundFilter

A raster background filter.

Description

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.

Remarks

The BackgroundFilter sets boundary pixels to NoData.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

IPixelFilter, Serialized Form

Constructor 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

BackgroundFilter

public BackgroundFilter()
                 throws IOException,
                        UnknownHostException

Constructs a BackgroundFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BackgroundFilter

public BackgroundFilter(Object obj)
                 throws IOException

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

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

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.

getBackground

public Object getBackground()
                     throws IOException,
                            AutomationException

The background value to be filtered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackground in interface IBackgroundFilter

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(Object value)
                   throws IOException,
                          AutomationException

The background value to be filtered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackground in interface IBackgroundFilter

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.