com.esri.arcgis.datasourcesraster

Class SpeckleFilter

java.lang.Object

com.esri.arcgis.datasourcesraster.SpeckleFilter

All Implemented Interfaces:

IPixelFilter, ISpeckleFilter, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'SpeckleFilter'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter

IID, IID90e3de9d_4fff_4575_b833_3ad29a57eeca, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISpeckleFilter

IID, IIDce529581_0814_4970_8d0b_3f48f760ff24, xxDummy

Constructor Summary

Constructors

Constructor and Description
SpeckleFilter() Constructs a SpeckleFilter using ArcGIS Engine.
SpeckleFilter(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SpeckleFilter theSpeckleFilter = (SpeckleFilter) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
double	getDampFactor() The extent of damping applied.
int	getFilterType() The speckle filter type.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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	release() Release this COM object reference
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

Constructor Detail

SpeckleFilter

public SpeckleFilter()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a SpeckleFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SpeckleFilter

public SpeckleFilter(java.lang.Object obj)
              throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSize

public void getSize(int[] columns,
                    int[] rows)
             throws java.io.IOException,
                    AutomationException

Gets dimension of the filter.

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:

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

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

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

Gets center position of the filter.

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:

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

AutomationException - If the ArcObject component throws an exception.

filter

public void filter(IPixelBlock pBlock)
            throws java.io.IOException,
                   AutomationException

Filters a pixel block.

Specified by:

filter in interface IPixelFilter

Parameters:

pBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilterType

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

The speckle filter type.

Specified by:

getFilterType in interface ISpeckleFilter

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

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

The speckle filter type.

Specified by:

setFilterType in interface ISpeckleFilter

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

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

Sets the size of the speckle filter kernel.

Specified by:

setSize in interface ISpeckleFilter

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.

getNoiseModel

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

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

Specified by:

getNoiseModel in interface ISpeckleFilter

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

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

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

Specified by:

setNoiseModel in interface ISpeckleFilter

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

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

Specified by:

setNoiseVariance in interface ISpeckleFilter

Parameters:

noiseVar - The noiseVar (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoiseVariance

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

Specified by:

getNoiseVariance in interface ISpeckleFilter

Returns:

The noiseVar

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAdditiveNoiseMean

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

Specified by:

setAdditiveNoiseMean in interface ISpeckleFilter

Parameters:

addNoiseMean - The addNoiseMean (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdditiveNoiseMean

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

Specified by:

getAdditiveNoiseMean in interface ISpeckleFilter

Returns:

The addNoiseMean

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMultiplicativeNoiseMean

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

Specified by:

setMultiplicativeNoiseMean in interface ISpeckleFilter

Parameters:

mulNoiseMean - The mulNoiseMean (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMultiplicativeNoiseMean

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

Specified by:

getMultiplicativeNoiseMean in interface ISpeckleFilter

Returns:

The mulNoiseMean

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNLooks

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

Specified by:

setNLooks in interface ISpeckleFilter

Parameters:

nLooks - The nLooks (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNLooks

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

Specified by:

getNLooks in interface ISpeckleFilter

Returns:

The nLooks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDampFactor

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

Specified by:

setDampFactor in interface ISpeckleFilter

Parameters:

dampFactor - The dampFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDampFactor

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

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

Specified by:

getDampFactor in interface ISpeckleFilter

Returns:

The dampFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.