com.esri.arcgis.datasourcesraster

Interface ISpeckleFunctionArguments

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISpeckleFunctionArgumentsProxy, SpeckleFunctionArguments

public interface ISpeckleFunctionArguments
extends java.io.Serializable

COM Interface 'ISpeckleFunctionArguments'. Generated 5/5/2025 2:28:36 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control a speckle function for radar imagery.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDb8099ff7_e990_4418_ad03_efbd626875d7
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
double	getAdditiveNoiseMean() The mean additive noise.
double	getDampFactor() The extent of damping applied.
int	getFilterSize() The size of the speckle filter kernel.
int	getFilterType() The type of the speckle filter.
double	getMultiplicativeNoiseMean() The mean multiplicative noise.
int	getNLooks() The number of looks.
int	getNoiseModel() The speckle noise model.
double	getNoiseVariance() The noise variance.
java.lang.Object	getRaster() The source raster object.
void	setAdditiveNoiseMean(double addNoiseMean) The mean additive noise.
void	setDampFactor(double dampFactor) The extent of damping applied.
void	setFilterSize(int pSize) The size of the speckle filter kernel.
void	setFilterType(int pType) The type of the speckle filter.
void	setMultiplicativeNoiseMean(double mulNoiseMean) The mean multiplicative noise.
void	setNLooks(int nLooks) The number of looks.
void	setNoiseModel(int type) The speckle noise model.
void	setNoiseVariance(double noiseVar) The noise variance.
void	setRasterByRef(java.lang.Object ppRaster) The source raster object.

Field Detail

IIDb8099ff7_e990_4418_ad03_efbd626875d7

static final int IIDb8099ff7_e990_4418_ad03_efbd626875d7

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

getRaster

java.lang.Object getRaster()
                    throws java.io.IOException,
                           AutomationException

The source raster object.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(java.lang.Object ppRaster)
             throws java.io.IOException,
                    AutomationException

The source raster object.

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

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 type of the speckle filter.

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.

getFilterType

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

The type of the speckle filter.

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.

setFilterSize

void setFilterSize(int pSize)
            throws java.io.IOException,
                   AutomationException

The size of the speckle filter kernel.

Parameters:

pSize - A com.esri.arcgis.datasourcesraster.esriSpeckleFilterKernel constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilterSize

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

The size of the speckle filter kernel.

Returns:

A com.esri.arcgis.datasourcesraster.esriSpeckleFilterKernel constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoiseModel

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

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

Parameters:

type - 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.

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.

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.