com.esri.arcgis.datasourcesraster
Class RemapFilter

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RemapFilter
All Implemented Interfaces:
IPixelFilter, IRemapFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RemapFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IRemapFilter

A class for remap filter.

Remarks

RemapFilter object can be used to map the pixel values of a raster into your specified classes.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
RemapFilter()
          Constructs a RemapFilter using ArcGIS Engine.
RemapFilter(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RemapFilter theRemapFilter = (RemapFilter) obj;
 
Method Summary
 void addClass(double minvalue, double maxvalue, double newvalue)
          Adds a remap class that remaps values in [minvalue,maxvalue) to a give new value.
 void addNoDataClass(double minvalue, double maxvalue)
          Adds a remap class that remaps values in [minvalue,maxvalue) to NoData.
 void empty()
          Removes all classes.
 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 getClassCount()
          The number of remapped classes.
static String getClsid()
          getClsid.
 void getSize(int[] columns, int[] rows)
          Gets dimension of the filter.
 int hashCode()
          the hashcode for this object
 boolean isAllowUnmatched()
          Indicates if unmatched values should be passed through.
 void putClass(int index, double minvalue, double maxvalue, double newvalue)
          Puts a remap class at a given class index (starting from 0).
 void queryClass(int index, double[] minvalue, double[] maxvalue, double[] newvalue)
          Queries a remap class at a given class index (starting from 0).
 void setAllowUnmatched(boolean pAllowUnmatched)
          Indicates if unmatched values should be passed through.
 
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

RemapFilter

public RemapFilter()
            throws IOException,
                   UnknownHostException
Constructs a RemapFilter using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RemapFilter

public RemapFilter(Object obj)
            throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RemapFilter theRemapFilter = (RemapFilter) obj;

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

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.

getClassCount

public int getClassCount()
                  throws IOException,
                         AutomationException
The number of remapped classes.

Product Availability

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

Specified by:
getClassCount in interface IRemapFilter
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(double minvalue,
                     double maxvalue,
                     double newvalue)
              throws IOException,
                     AutomationException
Adds a remap class that remaps values in [minvalue,maxvalue) to a give new value.

Product Availability

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

Specified by:
addClass in interface IRemapFilter
Parameters:
minvalue - The minvalue (in)
maxvalue - The maxvalue (in)
newvalue - The newvalue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addNoDataClass

public void addNoDataClass(double minvalue,
                           double maxvalue)
                    throws IOException,
                           AutomationException
Adds a remap class that remaps values in [minvalue,maxvalue) to NoData.

Product Availability

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

Specified by:
addNoDataClass in interface IRemapFilter
Parameters:
minvalue - The minvalue (in)
maxvalue - The maxvalue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryClass

public void queryClass(int index,
                       double[] minvalue,
                       double[] maxvalue,
                       double[] newvalue)
                throws IOException,
                       AutomationException
Queries a remap class at a given class index (starting from 0).

Product Availability

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

Specified by:
queryClass in interface IRemapFilter
Parameters:
index - The index (in)
minvalue - The minvalue (out: use single element array)
maxvalue - The maxvalue (out: use single element array)
newvalue - The newvalue (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putClass

public void putClass(int index,
                     double minvalue,
                     double maxvalue,
                     double newvalue)
              throws IOException,
                     AutomationException
Puts a remap class at a given class index (starting from 0).

Product Availability

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

Specified by:
putClass in interface IRemapFilter
Parameters:
index - The index (in)
minvalue - The minvalue (in)
maxvalue - The maxvalue (in)
newvalue - The newvalue (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 classes.

Product Availability

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

Specified by:
empty in interface IRemapFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAllowUnmatched

public boolean isAllowUnmatched()
                         throws IOException,
                                AutomationException
Indicates if unmatched values should be passed through.

Product Availability

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

Specified by:
isAllowUnmatched in interface IRemapFilter
Returns:
The pAllowUnmatched
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowUnmatched

public void setAllowUnmatched(boolean pAllowUnmatched)
                       throws IOException,
                              AutomationException
Indicates if unmatched values should be passed through.

Product Availability

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

Specified by:
setAllowUnmatched in interface IRemapFilter
Parameters:
pAllowUnmatched - The pAllowUnmatched (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPixelFilter