com.esri.arcgis.datasourcesraster
Class PixelFilterCollection

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

All Implemented Interfaces:

IMultibandFilter, IPixelFilter, IPixelFilter2, IPixelFilter3, IPixelFilterCollection, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class PixelFilterCollection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IPixelFilter2, IPixelFilter3, IPixelFilterCollection, IMultibandFilter

A raster filter collection.

Remarks

The PixelFilterCollection coclass manages a collection of pixel filters through IPixelFilterColletion interface and can be used to set more than one filter to a Raster object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

IPixelFilterCollection, Serialized Form

Constructor Summary

PixelFilterCollection()
Constructs a PixelFilterCollection using ArcGIS Engine.

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

Method Summary

void	append(IPixelFilter pFilter) Appends a raster filter to the end.
void	empty() Empties this raster filter collection.
boolean	equals(Object o) Compare this object with another
void	filter(IPixelBlock pBlock) Filters a pixel block.
int	find(IPixelFilter pFilter) Finds a given raster filter and returns its index position.
IPixelFilter	get(int index) Gets the raster filter at a given index position.
void	getCenterPosition(int[] atColumn, int[] atRow) Gets center position of the filter.
static String	getClsid() getClsid.
IPixelFilter	getFilter(int iBand) Gets a given pixel filter.
int	getFilterCount() The number of filters in this collection.
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	insert(int index, IPixelFilter pFilter) Inserts a raster filter at a given index.
void	remove(int index) Removes a raster filter at a given index.
void	set(int index, IPixelFilter pFilter) Sets the raster filter at a given index position.
void	synchronize(IRaster pRaster) Synchronizes this filter when raster properties are changed.

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

PixelFilterCollection

public PixelFilterCollection()
                      throws IOException,
                             UnknownHostException

Constructs a PixelFilterCollection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PixelFilterCollection

public PixelFilterCollection(Object obj)
                      throws IOException

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

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

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.

synchronize

public void synchronize(IRaster pRaster)
                 throws IOException,
                        AutomationException

Synchronizes this filter when raster properties are changed.

Product Availability

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

Specified by:

synchronize in interface IPixelFilter3

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilterCount

public int getFilterCount()
                   throws IOException,
                          AutomationException

The number of filters in this collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilterCount in interface IPixelFilterCollection

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IPixelFilter pFilter)
            throws IOException,
                   AutomationException

Inserts a raster filter at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

insert in interface IPixelFilterCollection

Parameters:

index - The index (in)

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

append

public void append(IPixelFilter pFilter)
            throws IOException,
                   AutomationException

Appends a raster filter to the end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

append in interface IPixelFilterCollection

Parameters:

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Removes a raster filter at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IPixelFilterCollection

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

public int find(IPixelFilter pFilter)
         throws IOException,
                AutomationException

Finds a given raster filter and returns its index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

find in interface IPixelFilterCollection

Parameters:

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

get

public IPixelFilter get(int index)
                 throws IOException,
                        AutomationException

Gets the raster filter at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

get in interface IPixelFilterCollection

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

set

public void set(int index,
                IPixelFilter pFilter)
         throws IOException,
                AutomationException

Sets the raster filter at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

set in interface IPixelFilterCollection

Parameters:

index - The index (in)

pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Empties this raster filter collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

empty in interface IPixelFilterCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public IPixelFilter getFilter(int iBand)
                       throws IOException,
                              AutomationException

Gets a given pixel filter.

Description

Get the pixelfilter of a given band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFilter in interface IMultibandFilter

Parameters:

iBand - The iBand (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.