com.esri.arcgis.datasourcesraster
Class RasterXformer

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.RasterXformer
All Implemented Interfaces:
IRasterXformer, IRasterXformer2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterXformer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterXformer, IRasterXformer2, ISupportErrorInfo

A raster transformer class.

Description

A RasterXformer is a driver for performing raster transformation. It contains a GeodataXfrom, a PixelReampler, a RasterReader, as well as the logic to drive these three components to perform raster transformation.

When a Raster is created, the associated RasterXformer is initialized with a SimperPixelResamper. By default, the RasterXformer manages and performs raster transformation automatically, you donít have to modify it unless you want to set the PixelResampler.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
RasterXformer()
          Constructs a RasterXformer using ArcGIS Engine.
RasterXformer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterXformer theRasterXformer = (RasterXformer) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 double getApproximationTolerance()
          The current approximation error tolerance in number (fraction) of pixels.
 IPnt getCellSize()
          The output cell size.
static String getClsid()
          getClsid.
 IEnvelope getExtent()
          The output extent.
 IGeodataXform getGeodataXform()
          The current geodata transform to be applied.
 int getHeight()
          The output height in pixels.
 IPixelReader getPixelReader()
          The current pixel reader for reading source pixels.
 IPixelResampler getPixelResampler()
          The current raster resampler.
 int getWidth()
          The output width in pixels.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void read(IPnt tlc, IPixelBlock pPixelBlock)
          Reads a pixel block.
 void setApproximationTolerance(double pNumPixels)
          The current approximation error tolerance in number (fraction) of pixels.
 void setCellSize(IPnt ppCellsize)
          The output cell size.
 void setExtent(IEnvelope ppExtent)
          The output extent.
 void setGeodataXformByRef(IGeodataXform ppXform)
          The current geodata transform to be applied.
 void setPixelReaderByRef(IPixelReader ppReader)
          The current pixel reader for reading source pixels.
 void setPixelResamplerByRef(IPixelResampler ppResampler)
          The current raster resampler.
 void setRaster(IRaster rhs1)
          The raster to be transformed.
 void update(IRaster pRaster)
          Updates the raster transformer with the changed raster.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterXformer

public RasterXformer()
              throws IOException,
                     UnknownHostException
Constructs a RasterXformer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterXformer

public RasterXformer(Object obj)
              throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterXformer theRasterXformer = (RasterXformer) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getApproximationTolerance

public double getApproximationTolerance()
                                 throws IOException,
                                        AutomationException
The current approximation error tolerance in number (fraction) of pixels.

Product Availability

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

Specified by:
getApproximationTolerance in interface IRasterXformer
Returns:
The pNumPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setApproximationTolerance

public void setApproximationTolerance(double pNumPixels)
                               throws IOException,
                                      AutomationException
The current approximation error tolerance in number (fraction) of pixels.

Remarks

The tolerance, used in geodata xform approximation. The unit is in output space.

Product Availability

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

Specified by:
setApproximationTolerance in interface IRasterXformer
Parameters:
pNumPixels - The pNumPixels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelResampler

public IPixelResampler getPixelResampler()
                                  throws IOException,
                                         AutomationException
The current raster resampler.

Product Availability

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

Specified by:
getPixelResampler in interface IRasterXformer
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IPixelResampler
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelResamplerByRef

public void setPixelResamplerByRef(IPixelResampler ppResampler)
                            throws IOException,
                                   AutomationException
The current raster resampler.

Product Availability

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

Specified by:
setPixelResamplerByRef in interface IRasterXformer
Parameters:
ppResampler - A reference to a com.esri.arcgis.datasourcesraster.IPixelResampler (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRaster

public void setRaster(IRaster rhs1)
               throws IOException,
                      AutomationException
The raster to be transformed.

Product Availability

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

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

update

public void update(IRaster pRaster)
            throws IOException,
                   AutomationException
Updates the raster transformer with the changed raster.

Product Availability

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

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

read

public void read(IPnt tlc,
                 IPixelBlock pPixelBlock)
          throws IOException,
                 AutomationException
Reads a pixel block.

Remarks

Read the pixel block after applying the geodata transformation.

Product Availability

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

Specified by:
read in interface IRasterXformer
Parameters:
tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The output extent.

Product Availability

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

Specified by:
getExtent in interface IRasterXformer2
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(IEnvelope ppExtent)
               throws IOException,
                      AutomationException
The output extent.

Product Availability

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

Specified by:
setExtent in interface IRasterXformer2
Parameters:
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
The output width in pixels.

Product Availability

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

Specified by:
getWidth in interface IRasterXformer2
Returns:
The pWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
The output height in pixels.

Product Availability

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

Specified by:
getHeight in interface IRasterXformer2
Returns:
The pHeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public IPnt getCellSize()
                 throws IOException,
                        AutomationException
The output cell size.

Product Availability

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

Specified by:
getCellSize in interface IRasterXformer2
Returns:
A reference to a com.esri.arcgis.geodatabase.IPnt
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellSize

public void setCellSize(IPnt ppCellsize)
                 throws IOException,
                        AutomationException
The output cell size.

Product Availability

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

Specified by:
setCellSize in interface IRasterXformer2
Parameters:
ppCellsize - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException
The current geodata transform to be applied.

Product Availability

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

Specified by:
getGeodataXform in interface IRasterXformer2
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeodataXform
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodataXformByRef

public void setGeodataXformByRef(IGeodataXform ppXform)
                          throws IOException,
                                 AutomationException
The current geodata transform to be applied.

Product Availability

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

Specified by:
setGeodataXformByRef in interface IRasterXformer2
Parameters:
ppXform - A reference to a com.esri.arcgis.geodatabase.IGeodataXform (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelReader

public IPixelReader getPixelReader()
                            throws IOException,
                                   AutomationException
The current pixel reader for reading source pixels.

Product Availability

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

Specified by:
getPixelReader in interface IRasterXformer2
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IPixelReader
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelReaderByRef

public void setPixelReaderByRef(IPixelReader ppReader)
                         throws IOException,
                                AutomationException
The current pixel reader for reading source pixels.

Product Availability

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

Specified by:
setPixelReaderByRef in interface IRasterXformer2
Parameters:
ppReader - A reference to a com.esri.arcgis.datasourcesraster.IPixelReader (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.