com.esri.arcgis.datasourcesraster
Class SpeckleFilter

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

public class SpeckleFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, ISpeckleFilter

A class for speckle filter.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SpeckleFilter()
          Constructs a SpeckleFilter using ArcGIS Engine.
SpeckleFilter(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SpeckleFilter theSpeckleFilter = (SpeckleFilter) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void filter(IPixelBlock pBlock)
          Filters a pixel block.
 double getAdditiveNoiseMean()
          The mean additive noise.
 void getCenterPosition(int[] atColumn, int[] atRow)
          Gets center position of the filter.
static String getClsid()
          getClsid.
 double getDampFactor()
          The extent of damping applied.
 int getFilterType()
          The speckle filter type.
 double getMultiplicativeNoiseMean()
          The mean multiplicative noise.
 int getNLooks()
          The number of looks.
 int getNoiseModel()
          The speckle noise model.
 double getNoiseVariance()
          The noise variance.
 void getSize(int[] columns, int[] rows)
          Gets dimension of the filter.
 int hashCode()
          the hashcode for this object
 void setAdditiveNoiseMean(double addNoiseMean)
          The mean additive noise.
 void setDampFactor(double dampFactor)
          The extent of damping applied.
 void setFilterType(int pType)
          The speckle filter type.
 void setMultiplicativeNoiseMean(double mulNoiseMean)
          The mean multiplicative noise.
 void setNLooks(int nLooks)
          The number of looks.
 void setNoiseModel(int pType)
          The speckle noise model.
 void setNoiseVariance(double noiseVar)
          The noise variance.
 void setSize(int nColumns, int nRows)
          Sets the size of the speckle filter kernel.
 
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

SpeckleFilter

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

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

SpeckleFilter

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

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

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
Specified by:
getSize in interface ISpeckleFilter
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
Specified by:
getCenterPosition in interface ISpeckleFilter
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.

getFilterType

public int getFilterType()
                  throws IOException,
                         AutomationException
The speckle filter type.

Product Availability

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

Specified by:
getFilterType in interface ISpeckleFilter
Returns:
A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterType

public void setFilterType(int pType)
                   throws IOException,
                          AutomationException
The speckle filter type.

Product Availability

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

Specified by:
setFilterType in interface ISpeckleFilter
Parameters:
pType - A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int nColumns,
                    int nRows)
             throws IOException,
                    AutomationException
Sets the size of the speckle filter kernel.

Product Availability

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

Specified by:
setSize in interface ISpeckleFilter
Parameters:
nColumns - The nColumns (in)
nRows - The nRows (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoiseModel

public int getNoiseModel()
                  throws IOException,
                         AutomationException
The speckle noise model. This parameter is used only for the Lee filter type.

Product Availability

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

Specified by:
getNoiseModel in interface ISpeckleFilter
Returns:
A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoiseModel

public void setNoiseModel(int pType)
                   throws IOException,
                          AutomationException
The speckle noise model. This parameter is used only for the Lee filter type.

Product Availability

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

Specified by:
setNoiseModel in interface ISpeckleFilter
Parameters:
pType - A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoiseVariance

public void setNoiseVariance(double noiseVar)
                      throws IOException,
                             AutomationException
The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
setNoiseVariance in interface ISpeckleFilter
Parameters:
noiseVar - The noiseVar (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoiseVariance

public double getNoiseVariance()
                        throws IOException,
                               AutomationException
The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
getNoiseVariance in interface ISpeckleFilter
Returns:
The noiseVar
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAdditiveNoiseMean

public void setAdditiveNoiseMean(double addNoiseMean)
                          throws IOException,
                                 AutomationException
The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
setAdditiveNoiseMean in interface ISpeckleFilter
Parameters:
addNoiseMean - The addNoiseMean (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAdditiveNoiseMean

public double getAdditiveNoiseMean()
                            throws IOException,
                                   AutomationException
The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
getAdditiveNoiseMean in interface ISpeckleFilter
Returns:
The addNoiseMean
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMultiplicativeNoiseMean

public void setMultiplicativeNoiseMean(double mulNoiseMean)
                                throws IOException,
                                       AutomationException
The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
setMultiplicativeNoiseMean in interface ISpeckleFilter
Parameters:
mulNoiseMean - The mulNoiseMean (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMultiplicativeNoiseMean

public double getMultiplicativeNoiseMean()
                                  throws IOException,
                                         AutomationException
The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Product Availability

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

Specified by:
getMultiplicativeNoiseMean in interface ISpeckleFilter
Returns:
The mulNoiseMean
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNLooks

public void setNLooks(int nLooks)
               throws IOException,
                      AutomationException
The number of looks. This parameter is used only for Lee filter with Multiplicative noise model as well as the Enhanced Lee filter.

Product Availability

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

Specified by:
setNLooks in interface ISpeckleFilter
Parameters:
nLooks - The nLooks (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNLooks

public int getNLooks()
              throws IOException,
                     AutomationException
The number of looks. This parameter is used only for Lee filter with Multiplicative noise model as well as the Enhanced Lee filter.

Product Availability

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

Specified by:
getNLooks in interface ISpeckleFilter
Returns:
The nLooks
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDampFactor

public void setDampFactor(double dampFactor)
                   throws IOException,
                          AutomationException
The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Product Availability

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

Specified by:
setDampFactor in interface ISpeckleFilter
Parameters:
dampFactor - The dampFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDampFactor

public double getDampFactor()
                     throws IOException,
                            AutomationException
The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Product Availability

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

Specified by:
getDampFactor in interface ISpeckleFilter
Returns:
The dampFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.