com.esri.arcgis.datasourcesraster
Interface ISpeckleFilter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISpeckleFilterProxy, SpeckleFilter

public interface ISpeckleFilter
extends java.io.Serializable

COM Interface 'ISpeckleFilter'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control a speckle filter.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDce529581_0814_4970_8d0b_3f48f760ff24
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IIDce529581_0814_4970_8d0b_3f48f760ff24

static final int IIDce529581_0814_4970_8d0b_3f48f760ff24

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getFilterType

int getFilterType()
                  throws java.io.IOException,
                         AutomationException

The speckle filter type.

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterType

void setFilterType(int pType)
                   throws java.io.IOException,
                          AutomationException

The speckle filter type.

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriSpeckleFilterType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

void setSize(int nColumns,
             int nRows)
             throws java.io.IOException,
                    AutomationException

Sets the size of the speckle filter kernel.

Parameters:

nColumns - The nColumns (in)

nRows - The nRows (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

void getSize(int[] nColumns,
             int[] nRows)
             throws java.io.IOException,
                    AutomationException

Gets the size of the speckle filter kernel.

Parameters:

nColumns - The nColumns (in/out: use single element array)

nRows - The nRows (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

void getCenterPosition(int[] atColumn,
                       int[] atRow)
                       throws java.io.IOException,
                              AutomationException

Gets the center position of the speckle filter kernel.

Parameters:

atColumn - The atColumn (in/out: use single element array)

atRow - The atRow (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoiseModel

int getNoiseModel()
                  throws java.io.IOException,
                         AutomationException

The speckle noise model. This parameter is used only for the Lee filter type.

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoiseModel

void setNoiseModel(int pType)
                   throws java.io.IOException,
                          AutomationException

The speckle noise model. This parameter is used only for the Lee filter type.

Parameters:

pType - A com.esri.arcgis.datasourcesraster.esriSpeckleNoiseModel constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoiseVariance

void setNoiseVariance(double noiseVar)
                      throws java.io.IOException,
                             AutomationException

The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Parameters:

noiseVar - The noiseVar (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoiseVariance

double getNoiseVariance()
                        throws java.io.IOException,
                               AutomationException

The noise variance. This parameter is used only for Lee filter with Additive or Additive and Multiplicative(both) noise models.

Returns:

The noiseVar

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdditiveNoiseMean

void setAdditiveNoiseMean(double addNoiseMean)
                          throws java.io.IOException,
                                 AutomationException

The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Parameters:

addNoiseMean - The addNoiseMean (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdditiveNoiseMean

double getAdditiveNoiseMean()
                            throws java.io.IOException,
                                   AutomationException

The mean additive noise. This parameter is used only for Lee filter with Additive and Multiplicative(both) noise models.

Returns:

The addNoiseMean

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiplicativeNoiseMean

void setMultiplicativeNoiseMean(double mulNoiseMean)
                                throws java.io.IOException,
                                       AutomationException

The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Parameters:

mulNoiseMean - The mulNoiseMean (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMultiplicativeNoiseMean

double getMultiplicativeNoiseMean()
                                  throws java.io.IOException,
                                         AutomationException

The mean multiplicative noise. This parameter is used only for Lee filter with Multiplicative or Additive and Multiplicative(both) noise models.

Returns:

The mulNoiseMean

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNLooks

void setNLooks(int nLooks)
               throws java.io.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.

Parameters:

nLooks - The nLooks (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNLooks

int getNLooks()
              throws java.io.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.

Returns:

The nLooks

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDampFactor

void setDampFactor(double dampFactor)
                   throws java.io.IOException,
                          AutomationException

The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Parameters:

dampFactor - The dampFactor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDampFactor

double getDampFactor()
                     throws java.io.IOException,
                            AutomationException

The extent of damping applied. This parameter is used only for Enhanced Lee filter and Frost filter.

Returns:

The dampFactor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.