com.esri.arcgis.datasourcesraster

Class PansharpeningFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.PansharpeningFunctionArguments

All Implemented Interfaces:

IPansharpeningFunctionArguments, IPansharpeningFunctionArguments2, IRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class PansharpeningFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IPansharpeningFunctionArguments, IPansharpeningFunctionArguments2, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'PansharpeningFunctionArguments'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for sharpening raster function arguments.' 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

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IID04aa081e_28b0_47e4_b375_f367046da924, xxDummy

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

IID, IIDcf0a1f4e_5a42_4dfb_a80f_92b6c3369e37, xxDummy

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

IID152f5add_6a59_4a06_b826_a949e2cef3df

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IStringArray	getFileList() The list of all files associated with the arguments.
java.lang.Object	getInfraredImage() The optional infrared image.
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	getMaximumPansharpeningCellsize() The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.Object	getMSImage() The multispectrum image.
IStringArray	getNames() The list of all argument names.
java.lang.Object	getPanImage() The panchromatic image.
int	getPansharpeningType() The current pansharpening type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
IDoubleArray	getWeights() The Red, Green, Blue, and Infrared weights contributing to panchromatic image.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isKeepStatsHistogram() Indicates if the input MS image's statistics and histogram should be kept.
void	load(IStream pstm) load
void	putValue(java.lang.String name, java.lang.Object value) Puts a named argument value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.String name) Removes a named argument value.
void	removeAll() Removes all argument values.
void	resolve(IRow pRow, IPropertySet pPropertySet) Resolves function variables using a row and set of properties.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setInfraredImageByRef(java.lang.Object ppInfraredImage) The optional infrared image.
void	setKeepStatsHistogram(boolean pKeep) Indicates if the input MS image's statistics and histogram should be kept.
void	setMaximumPansharpeningCellsize(double cellSize) The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.
void	setMSImageByRef(java.lang.Object ppMSImage) The multispectrum image.
void	setPanImageByRef(java.lang.Object ppPanImage) The panchromatic image.
void	setPansharpeningType(int pSharpeningType) The current pansharpening type.
void	setWeightsByRef(IDoubleArray ppWeights) The Red, Green, Blue, and Infrared weights contributing to panchromatic image.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PansharpeningFunctionArguments

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

Constructs a PansharpeningFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

PansharpeningFunctionArguments

public PansharpeningFunctionArguments(java.lang.Object obj)
                               throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PansharpeningFunctionArguments thePansharpeningFunctionArguments = (PansharpeningFunctionArguments) obj;

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

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

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Gets a named argument value.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Puts a named argument value.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Removes a named argument value.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException

Removes all argument values.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException

The list of all argument names.

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException

The list of all arguments.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IVariantArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException

The list of all files associated with the arguments.

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

Specified by:

resolve in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws java.io.IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Specified by:

update in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMSImage

public java.lang.Object getMSImage()
                            throws java.io.IOException,
                                   AutomationException

The multispectrum image.

Specified by:

getMSImage in interface IPansharpeningFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMSImageByRef

public void setMSImageByRef(java.lang.Object ppMSImage)
                     throws java.io.IOException,
                            AutomationException

The multispectrum image.

Specified by:

setMSImageByRef in interface IPansharpeningFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPanImage

public java.lang.Object getPanImage()
                             throws java.io.IOException,
                                    AutomationException

The panchromatic image.

Specified by:

getPanImage in interface IPansharpeningFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPanImageByRef

public void setPanImageByRef(java.lang.Object ppPanImage)
                      throws java.io.IOException,
                             AutomationException

The panchromatic image.

Specified by:

setPanImageByRef in interface IPansharpeningFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInfraredImage

public java.lang.Object getInfraredImage()
                                  throws java.io.IOException,
                                         AutomationException

The optional infrared image.

Specified by:

getInfraredImage in interface IPansharpeningFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInfraredImageByRef

public void setInfraredImageByRef(java.lang.Object ppInfraredImage)
                           throws java.io.IOException,
                                  AutomationException

The optional infrared image.

Specified by:

setInfraredImageByRef in interface IPansharpeningFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPansharpeningType

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

The current pansharpening type.

Specified by:

getPansharpeningType in interface IPansharpeningFunctionArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriPansharpeningType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPansharpeningType

public void setPansharpeningType(int pSharpeningType)
                          throws java.io.IOException,
                                 AutomationException

The current pansharpening type.

Specified by:

setPansharpeningType in interface IPansharpeningFunctionArguments

Parameters:

pSharpeningType - A com.esri.arcgis.datasourcesraster.esriPansharpeningType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeights

public IDoubleArray getWeights()
                        throws java.io.IOException,
                               AutomationException

The Red, Green, Blue, and Infrared weights contributing to panchromatic image.

Specified by:

getWeights in interface IPansharpeningFunctionArguments

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWeightsByRef

public void setWeightsByRef(IDoubleArray ppWeights)
                     throws java.io.IOException,
                            AutomationException

The Red, Green, Blue, and Infrared weights contributing to panchromatic image.

Specified by:

setWeightsByRef in interface IPansharpeningFunctionArguments

Parameters:

ppWeights - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isKeepStatsHistogram

public boolean isKeepStatsHistogram()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the input MS image's statistics and histogram should be kept.

Specified by:

isKeepStatsHistogram in interface IPansharpeningFunctionArguments2

Returns:

The pKeep

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeepStatsHistogram

public void setKeepStatsHistogram(boolean pKeep)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the input MS image's statistics and histogram should be kept.

Specified by:

setKeepStatsHistogram in interface IPansharpeningFunctionArguments2

Parameters:

pKeep - The pKeep (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumPansharpeningCellsize

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

The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.

Specified by:

getMaximumPansharpeningCellsize in interface IPansharpeningFunctionArguments2

Returns:

The cellSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumPansharpeningCellsize

public void setMaximumPansharpeningCellsize(double cellSize)
                                     throws java.io.IOException,
                                            AutomationException

The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.

Specified by:

setMaximumPansharpeningCellsize in interface IPansharpeningFunctionArguments2

Parameters:

cellSize - The cellSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException