com.esri.arcgis.datasourcesraster
Interface IRasterInfo

All Superinterfaces:
Serializable
All Known Subinterfaces:
IRasterInfo2
All Known Implementing Classes:
RasterInfo

public interface IRasterInfo
extends Serializable

Provides access to members that control a raster info object.

Product Availability

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


Method Summary
 int getBandCount()
          The number of bands in the Raster.
 int getBlockHeight()
          The block height in pixels.
 int getBlockWidth()
          The block width in pixels.
 IPnt getCellSize()
          The raster cell size.
 IEnvelope getExtent()
          The raster extent.
 int getFirstPyramidLevel()
          The first pyramid level.
 String getFormat()
          The raster format, e.g.
 IGeodataXform getGeodataXform()
          The raster GeoData transform.
 int getHeight()
          The raster height in pixels.
 int getMaximumPyramidLevel()
          The maximum pyramid level.
 IEnvelope getNativeExtent()
          The native raster extent before GeoData transform.
 ISpatialReference getNativeSpatialReference()
          The native raster spatial reference before GeoData transform.
 Object getNoData()
          The NoData value used to indicate invalid or excluded data.
 IPoint getOrigin()
          The tiling origin.
 int getPixelType()
          The raster pixel type.
 ISpatialReference getSpatialReference()
          The raster spatial reference.
 int getWidth()
          The raster width in pixels.
 boolean isResampling()
          Indicates if this raster source wants to perform resampling.
 boolean isSupportBandSelection()
          Indicates if this function supports band selection.
 void setBandCount(int pCount)
          The number of bands in the Raster.
 void setBlockHeight(int pHeight)
          The block height in pixels.
 void setBlockWidth(int pWidth)
          The block width in pixels.
 void setCellSize(IPnt ppCellsize)
          The raster cell size.
 void setExtent(IEnvelope ppExtent)
          The raster extent.
 void setFirstPyramidLevel(int pLevel)
          The first pyramid level.
 void setFormat(String pFormat)
          The raster format, e.g.
 void setGeodataXformByRef(IGeodataXform ppXf)
          The raster GeoData transform.
 void setMaximumPyramidLevel(int pLevel)
          The maximum pyramid level.
 void setNativeExtent(IEnvelope ppExtent)
          The native raster extent before GeoData transform.
 void setNativeSpatialReferenceByRef(ISpatialReference ppSpatialReference)
          The native raster spatial reference before GeoData transform.
 void setNoData(Object pvNoData)
          The NoData value used to indicate invalid or excluded data.
 void setOriginByRef(IPoint ppOrigin)
          The tiling origin.
 void setPixelType(int pPixelType)
          The raster pixel type.
 void setResampling(boolean pResampling)
          Indicates if this raster source wants to perform resampling.
 void setSupportBandSelection(boolean pSupportBandSelection)
          Indicates if this function supports band selection.
 

Method Detail

getOrigin

IPoint getOrigin()
                 throws IOException,
                        AutomationException
The tiling origin.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginByRef

void setOriginByRef(IPoint ppOrigin)
                    throws IOException,
                           AutomationException
The tiling origin.

Product Availability

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

Parameters:
ppOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlockWidth

int getBlockWidth()
                  throws IOException,
                         AutomationException
The block width in pixels.

Product Availability

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

Returns:
The pWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlockWidth

void setBlockWidth(int pWidth)
                   throws IOException,
                          AutomationException
The block width in pixels.

Product Availability

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

Parameters:
pWidth - The pWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlockHeight

int getBlockHeight()
                   throws IOException,
                          AutomationException
The block height in pixels.

Product Availability

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

Returns:
The pHeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlockHeight

void setBlockHeight(int pHeight)
                    throws IOException,
                           AutomationException
The block height in pixels.

Product Availability

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

Parameters:
pHeight - The pHeight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstPyramidLevel

int getFirstPyramidLevel()
                         throws IOException,
                                AutomationException
The first pyramid level.

Product Availability

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

Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFirstPyramidLevel

void setFirstPyramidLevel(int pLevel)
                          throws IOException,
                                 AutomationException
The first pyramid level.

Product Availability

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

Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

int getMaximumPyramidLevel()
                           throws IOException,
                                  AutomationException
The maximum pyramid level.

Product Availability

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

Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumPyramidLevel

void setMaximumPyramidLevel(int pLevel)
                            throws IOException,
                                   AutomationException
The maximum pyramid level.

Product Availability

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

Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodataXform

IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException
The raster GeoData transform.

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.

setGeodataXformByRef

void setGeodataXformByRef(IGeodataXform ppXf)
                          throws IOException,
                                 AutomationException
The raster GeoData transform.

Product Availability

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

Parameters:
ppXf - 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.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The raster spatial reference.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The raster extent.

Product Availability

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

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

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

Product Availability

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

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.

getNativeSpatialReference

ISpatialReference getNativeSpatialReference()
                                            throws IOException,
                                                   AutomationException
The native raster spatial reference before GeoData transform.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNativeSpatialReferenceByRef

void setNativeSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                                    throws IOException,
                                           AutomationException
The native raster spatial reference before GeoData transform.

Product Availability

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

Parameters:
ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeExtent

IEnvelope getNativeExtent()
                          throws IOException,
                                 AutomationException
The native raster extent before GeoData transform.

Product Availability

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

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.

setNativeExtent

void setNativeExtent(IEnvelope ppExtent)
                     throws IOException,
                            AutomationException
The native raster extent before GeoData transform.

Product Availability

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

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.

getCellSize

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

Product Availability

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

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

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

Product Availability

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

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.

getWidth

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

Product Availability

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

Returns:
The pWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

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

Product Availability

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

Returns:
The pHeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException
The number of bands in the Raster.

Product Availability

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

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandCount

void setBandCount(int pCount)
                  throws IOException,
                         AutomationException
The number of bands in the Raster.

Product Availability

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

Parameters:
pCount - The pCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException
The raster pixel type.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException
The raster pixel type.

Product Availability

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

Parameters:
pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoData

Object getNoData()
                 throws IOException,
                        AutomationException
The NoData value used to indicate invalid or excluded data.

Product Availability

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoData

void setNoData(Object pvNoData)
               throws IOException,
                      AutomationException
The NoData value used to indicate invalid or excluded data.

Product Availability

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

Parameters:
pvNoData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isResampling

boolean isResampling()
                     throws IOException,
                            AutomationException
Indicates if this raster source wants to perform resampling.

Product Availability

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

Returns:
The pResampling
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResampling

void setResampling(boolean pResampling)
                   throws IOException,
                          AutomationException
Indicates if this raster source wants to perform resampling.

Product Availability

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

Parameters:
pResampling - The pResampling (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportBandSelection

boolean isSupportBandSelection()
                               throws IOException,
                                      AutomationException
Indicates if this function supports band selection.

Product Availability

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

Returns:
The pSupportBandSelection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportBandSelection

void setSupportBandSelection(boolean pSupportBandSelection)
                             throws IOException,
                                    AutomationException
Indicates if this function supports band selection.

Product Availability

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

Parameters:
pSupportBandSelection - The pSupportBandSelection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormat

String getFormat()
                 throws IOException,
                        AutomationException
The raster format, e.g. TIFF, NITF, and etc.

Product Availability

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

Returns:
The pFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(String pFormat)
               throws IOException,
                      AutomationException
The raster format, e.g. TIFF, NITF, and etc.

Product Availability

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

Parameters:
pFormat - The pFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.