com.esri.arcgis.datasourcesraster
Interface IRasterXformer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRasterXformer2

All Known Implementing Classes:

RasterXformer

public interface IRasterXformer
extends Serializable

Provides access to members that control raster transformer.

Superseded By

IRasterXformer2

Remarks

The IRasterXformer interface is used to create a RasterXformer object from a Raster.

Creating a RasterXformer object, a GeodataXform, a PixelResampler and a PixelReader must be set.

To create a RasterXformer from a Raster, use IRasterXformer::Raster method which contains a GeodataXform, a default PixelResampler and a PixelReader

To create a RasterXformer without using Raster, IRasterXformer2 interface should be used.

Product Availability

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

Method Summary

double	getApproximationTolerance() The current approximation error tolerance in number (fraction) of pixels.
IPixelResampler	getPixelResampler() The current raster resampler.
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	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.

Method Detail

getApproximationTolerance

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.

Returns:

The pNumPixels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApproximationTolerance

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.

Parameters:

pNumPixels - The pNumPixels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelResampler

IPixelResampler getPixelResampler()
                                  throws IOException,
                                         AutomationException

The current raster resampler.

Product Availability

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

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

void setPixelResamplerByRef(IPixelResampler ppResampler)
                            throws IOException,
                                   AutomationException

The current raster resampler.

Product Availability

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

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

void setRaster(IRaster rhs1)
               throws IOException,
                      AutomationException

The raster to be transformed.

Product Availability

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

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

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.

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

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.

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.