com.esri.arcgis.datasourcesraster
Interface IRaster2

All Superinterfaces:

Serializable

All Known Implementing Classes:

Raster

public interface IRaster2
extends Serializable

Provides access to members that control a raster.

Remarks

IRaster2 interface, new at ArcGIS 9.2, provides many functions working with a Raster object.

• Set geodata transformation on Raster and perform pixel and map transformation.
• Set GeoTransformations (datum transformation) for raster projection.
• Get raster attribute table and raster colormap
• Create raster cursor with a specified pixel block.

Product Availability

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

Method Summary

IRasterCursor	createCursorEx(IPnt pBlockSize) Creates a cursor with a given pixel block size or native block size.
ITable	getAttributeTable() The raster value attribute table.
IRasterColormap	getColormap() The colormap.
IGeodataXform	getGeodataXform() The geodata transform.
IGeoTransformationOperationSet	getGeoTransformations() The set of geographic transformations to be applied.
Object	getPixelValue(int iBand, int iColumn, int iRow) Gets the pixel value for a given band at a given column and row.
IRasterDataset	getRasterDataset() The parent raster dataset.
IRasterXformer	getRasterXformer() The raster transformer.
void	mapToPixel(double x, double y, int[] pColumn, int[] pRow) Converts a location (x, y) in map space into pixel space.
void	pixelToMap(int iColumn, int iRow, double[] pX, double[] pY) Converts a location (column, row) in pixel space into map space.
void	setAttributeTableByRef(ITable ppVAT) The raster value attribute table.
void	setColormapByRef(IRasterColormap ppColormap) The colormap.
void	setGeodataXform(IGeodataXform ppXform) The geodata transform.
void	setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms) The set of geographic transformations to be applied.
double	toMapX(int iColumn) Maps a pixel column to the x coordinate in map space.
double	toMapY(int iRow) Maps a pixel row to the y coordinate in map space.
int	toPixelColumn(double x) Maps a x coordinate in map space to the pixel column.
int	toPixelRow(double y) Maps a y coordinate in map space to the pixel row.

Method Detail

getGeodataXform

IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException

The geodata transform.

Remarks

After you set a GeodataXform on a Raster and perform SaveAs, you must also set the extent, width and height of the raster in the space after the transformation.

Product Availability

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

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.

setGeodataXform

void setGeodataXform(IGeodataXform ppXform)
                     throws IOException,
                            AutomationException

The geodata transform.

Remarks

The put GeodataXform does not automatically update the extent and cell size, to save out a transformed raster, you need to transform the extent and cell size first, then put the transformed extent and cell size on the raster, the call SaveAs.

Product Availability

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

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.

setGeoTransformationsByRef

void setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms)
                                throws IOException,
                                       AutomationException

The set of geographic transformations to be applied.

Product Availability

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

Parameters:

ppGeoXforms - A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeoTransformations

IGeoTransformationOperationSet getGeoTransformations()
                                                     throws IOException,
                                                            AutomationException

The set of geographic transformations to be applied.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeTable

ITable getAttributeTable()
                         throws IOException,
                                AutomationException

The raster value attribute table.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributeTableByRef

void setAttributeTableByRef(ITable ppVAT)
                            throws IOException,
                                   AutomationException

The raster value attribute table.

Product Availability

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

Parameters:

ppVAT - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColormap

IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException

The colormap.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterColormap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColormapByRef

void setColormapByRef(IRasterColormap ppColormap)
                      throws IOException,
                             AutomationException

The colormap.

Product Availability

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

Parameters:

ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterDataset

IRasterDataset getRasterDataset()
                                throws IOException,
                                       AutomationException

The parent raster dataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createCursorEx

IRasterCursor createCursorEx(IPnt pBlockSize)
                             throws IOException,
                                    AutomationException

Creates a cursor with a given pixel block size or native block size.

Product Availability

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

Parameters:

pBlockSize - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterXformer

IRasterXformer getRasterXformer()
                                throws IOException,
                                       AutomationException

The raster transformer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterXformer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapToPixel

void mapToPixel(double x,
                double y,
                int[] pColumn,
                int[] pRow)
                throws IOException,
                       AutomationException

Converts a location (x, y) in map space into pixel space.

Product Availability

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

Parameters:

x - The x (in)

y - The y (in)

pColumn - The pColumn (out: use single element array)

pRow - The pRow (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pixelToMap

void pixelToMap(int iColumn,
                int iRow,
                double[] pX,
                double[] pY)
                throws IOException,
                       AutomationException

Converts a location (column, row) in pixel space into map space.

Product Availability

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

Parameters:

iColumn - The iColumn (in)

iRow - The iRow (in)

pX - The pX (out: use single element array)

pY - The pY (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toPixelColumn

int toPixelColumn(double x)
                  throws IOException,
                         AutomationException

Maps a x coordinate in map space to the pixel column.

Product Availability

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

Parameters:

x - The x (in)

Returns:

The pColumn

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toPixelRow

int toPixelRow(double y)
               throws IOException,
                      AutomationException

Maps a y coordinate in map space to the pixel row.

Product Availability

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

Parameters:

y - The y (in)

Returns:

The pRow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toMapX

double toMapX(int iColumn)
              throws IOException,
                     AutomationException

Maps a pixel column to the x coordinate in map space.

Product Availability

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

Parameters:

iColumn - The iColumn (in)

Returns:

The pX

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toMapY

double toMapY(int iRow)
              throws IOException,
                     AutomationException

Maps a pixel row to the y coordinate in map space.

Product Availability

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

Parameters:

iRow - The iRow (in)

Returns:

The pY

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelValue

Object getPixelValue(int iBand,
                     int iColumn,
                     int iRow)
                     throws IOException,
                            AutomationException

Gets the pixel value for a given band at a given column and row.

Product Availability

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

Parameters:

iBand - The iBand (in)

iColumn - The iColumn (in)

iRow - The iRow (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.