com.esri.arcgis.datasourcesraster
Class PansharpeningFilter

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.PansharpeningFilter
All Implemented Interfaces:
IPansharpeningFilter, IPansharpeningFilter2, IPixelFilter, IPixelFilter2, IPixelFilter3, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class PansharpeningFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IPixelFilter2, IPixelFilter3, IPansharpeningFilter, IPansharpeningFilter2, IPersistStream, IDocumentVersionSupportGEN, IXMLVersionSupport, java.io.Externalizable

COM Class 'PansharpeningFilter'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'A class for pansharpening 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter
IID, IID90e3de9d_4fff_4575_b833_3ad29a57eeca, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter2
IID, IIDed30705b_437a_4ff4_93b3_f1947c70668b, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilter3
IID, IID0ed41a27_9699_4b09_b3af_7cffd9f57c28, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPansharpeningFilter2
IID, IID64fa96ad_e00f_4aa1_82f7_b7ea95648b18, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPansharpeningFilter
IIDa9d01e68_5e2e_4dbd_b878_4ec48f565120
 
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.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
PansharpeningFilter()
          Constructs a PansharpeningFilter using ArcGIS Engine.
PansharpeningFilter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PansharpeningFilter thePansharpeningFilter = (PansharpeningFilter) obj;
 
Method Summary
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void filter(IPixelBlock pBlock)
          Filters a pixel block.
 void getCenterPosition(int[] atColumn, int[] atRow)
          Gets center position of the filter.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IRaster getInfraredImage()
          The optional infrared image.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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).
 IRaster getPanImage()
          The panchromatic image.
 int getPansharpeningType()
          The current pansharpening type.
 void getSize(int[] columns, int[] rows)
          Gets dimension of the filter.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void init(int nCols, int nRows, IEnvelope pExtent)
          Initializes this filter for a given area of interest.
 void initBlock(IPnt pTopLeft, int nBlkCols, int nBlkRows)
          Initialize this filter for a given pixel block.
 void isDirty()
          isDirty
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          load
 void putWeights(double rW, double gW, double bW, double iW)
          Puts the Red, Green, Blue, and Infrared weights contributing to panchromatic image.
 void queryWeights(double[] pRW, double[] pGW, double[] pBW, double[] pIW)
          Gets the Red, Green, Blue, and Infrared weights contributing to panchromatic image.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a PansharpeningFilter.
 void save(IStream pstm, int fClearDirty)
          save
 void setInfraredImageByRef(IRaster ppInfraredImage)
          The optional infrared image.
 void setMaximumPansharpeningCellsize(double cellSize)
          The maximum cellsize, in Pan image's SR, below which pansharpening will be applied.
 void setPanImageByRef(IRaster ppPanImage)
          The panchromatic image.
 void setPansharpeningType(int pSharpeningType)
          The current pansharpening type.
 void sharpen(double p, double[] r, double[] g, double[] b, double[] i)
          Applies pansharpening to a pixel (R, G, B, I).
 void synchronize(IRaster pRaster)
          Synchronizes this filter when raster properties are changed.
 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

PansharpeningFilter

public PansharpeningFilter()
                    throws java.io.IOException,
                           java.net.UnknownHostException
Constructs a PansharpeningFilter using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

PansharpeningFilter

public PansharpeningFilter(java.lang.Object obj)
                    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PansharpeningFilter thePansharpeningFilter = (PansharpeningFilter) obj;

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

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()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a PansharpeningFilter.

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

init

public void init(int nCols,
                 int nRows,
                 IEnvelope pExtent)
          throws java.io.IOException,
                 AutomationException
Initializes this filter for a given area of interest.

Specified by:
init in interface IPixelFilter2
Parameters:
nCols - The nCols (in)
nRows - The nRows (in)
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initBlock

public void initBlock(IPnt pTopLeft,
                      int nBlkCols,
                      int nBlkRows)
               throws java.io.IOException,
                      AutomationException
Initialize this filter for a given pixel block.

Specified by:
initBlock in interface IPixelFilter2
Parameters:
pTopLeft - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
nBlkCols - The nBlkCols (in)
nBlkRows - The nBlkRows (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(IRaster pRaster)
                 throws java.io.IOException,
                        AutomationException
Synchronizes this filter when raster properties are changed.

Specified by:
synchronize in interface IPixelFilter3
Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPanImage

public IRaster getPanImage()
                    throws java.io.IOException,
                           AutomationException
The panchromatic image.

Specified by:
getPanImage in interface IPansharpeningFilter
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPanImageByRef

public void setPanImageByRef(IRaster ppPanImage)
                      throws java.io.IOException,
                             AutomationException
The panchromatic image.

Specified by:
setPanImageByRef in interface IPansharpeningFilter
Parameters:
ppPanImage - A reference to a com.esri.arcgis.geodatabase.IRaster (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 IPansharpeningFilter
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 IPansharpeningFilter
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.

queryWeights

public void queryWeights(double[] pRW,
                         double[] pGW,
                         double[] pBW,
                         double[] pIW)
                  throws java.io.IOException,
                         AutomationException
Gets the Red, Green, Blue, and Infrared weights contributing to panchromatic image.

Specified by:
queryWeights in interface IPansharpeningFilter
Parameters:
pRW - The pRW (out: use single element array)
pGW - The pGW (out: use single element array)
pBW - The pBW (out: use single element array)
pIW - The pIW (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putWeights

public void putWeights(double rW,
                       double gW,
                       double bW,
                       double iW)
                throws java.io.IOException,
                       AutomationException
Puts the Red, Green, Blue, and Infrared weights contributing to panchromatic image.

Specified by:
putWeights in interface IPansharpeningFilter
Parameters:
rW - The rW (in)
gW - The gW (in)
bW - The bW (in)
iW - The iW (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInfraredImage

public IRaster getInfraredImage()
                         throws java.io.IOException,
                                AutomationException
The optional infrared image.

Specified by:
getInfraredImage in interface IPansharpeningFilter
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInfraredImageByRef

public void setInfraredImageByRef(IRaster ppInfraredImage)
                           throws java.io.IOException,
                                  AutomationException
The optional infrared image.

Specified by:
setInfraredImageByRef in interface IPansharpeningFilter
Parameters:
ppInfraredImage - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sharpen

public void sharpen(double p,
                    double[] r,
                    double[] g,
                    double[] b,
                    double[] i)
             throws java.io.IOException,
                    AutomationException
Applies pansharpening to a pixel (R, G, B, I).

Specified by:
sharpen in interface IPansharpeningFilter2
Parameters:
p - The p (in)
r - The r (in/out: use single element array)
g - The g (in/out: use single element array)
b - The b (in/out: use single element array)
i - The i (in/out: use single element array)
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 IPansharpeningFilter2
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 IPansharpeningFilter2
Parameters:
cellSize - The cellSize (in)
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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
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