com.esri.arcgis.datasourcesraster
Interface ISpeckleFilter

All Superinterfaces:
Serializable
All Known Implementing Classes:
SpeckleFilter

public interface ISpeckleFilter
extends Serializable

Provides access to members that control a speckle filter.

Product Availability

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


Method Summary
 double getAdditiveNoiseMean()
          The mean additive noise.
 void getCenterPosition(int[] atColumn, int[] atRow)
          Gets the center position of the speckle filter kernel.
 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[] nColumns, int[] nRows)
          Gets the size of the speckle filter kernel.
 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.
 

Method Detail

getFilterType

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

Product Availability

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

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

setFilterType

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

Product Availability

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

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

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.

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

getSize

void getSize(int[] nColumns,
             int[] nRows)
             throws IOException,
                    AutomationException
Gets the size of the speckle filter kernel.

Product Availability

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

Parameters:
nColumns - The nColumns (in/out: use single element array)
nRows - The nRows (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterPosition

void getCenterPosition(int[] atColumn,
                       int[] atRow)
                       throws IOException,
                              AutomationException
Gets the center position of the speckle filter kernel.

Product Availability

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

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.

getNoiseModel

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.

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

setNoiseModel

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.

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

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.

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

getNoiseVariance

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.

Returns:
The noiseVar
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAdditiveNoiseMean

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.

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

getAdditiveNoiseMean

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.

Returns:
The addNoiseMean
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMultiplicativeNoiseMean

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.

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

getMultiplicativeNoiseMean

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.

Returns:
The mulNoiseMean
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNLooks

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.

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

getNLooks

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.

Returns:
The nLooks
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDampFactor

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.

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

getDampFactor

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.

Returns:
The dampFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.