com.esri.arcgis.datasourcesraster
Interface IRasterProps

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterPropsProxy, MosaicRaster, Raster, RasterBand, RenderedRaster

public interface IRasterProps
extends Serializable

Provides access to members that control the most common raster properties.

Remarks

IRasterProps interface accesses the properties of the RasterBand, Raster and MosaicRaster such as width, height, pixel depth spatial reference, etc.

For Raster and MosaicRaster, IRasterProps can also modify the properties of the objects, such as reprojecting a raster from one spatial reference to another, change the width, height, extent, pixel type of the raster. These modifications only affect the in-memory raster representation and in no way change any of the raster dataset. You can persist the modifications to a new raster datast using ISaveAs::SaveAs or IRasterBandCollection::SaveAs.

The Height and Width properties return the number of rows and columns in the Raster. This height and width determine the number of rows and columns into which to divide the input extent.

The Extent property controls the extent for which data in the Raster will be read. If you set a smaller extent to the Raster without specifying the width and height, you will have a Raster with the extent you set, original width and height, and reduced cell size.

The PixelType property controls the bit depth and data type of the values in the raster. If the PixelType specified is not the same as a band of the raster, the pixel values will automatically be converted to the correct data type.

The NoDataValue controls an array of values used to represent NoData. This variant array of values has the pixel type of the raster and contains one NoData value for each band. This allows the different bands in the raster to contain a different NoData value. If there is no NoDataValue in the band, the value in the corresponding member of the array is set outside the pixel depth range.

Product Availability

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

Method Summary

IEnvelope	getExtent() The extent of the Raster.
int	getHeight() Height in pixels.
Object	getNoDataValue() Data value used to indicate invalid or excluded data.
int	getPixelType() Data type of the pixels.
ISpatialReference	getSpatialReference() SpatialReference of the Raster.
int	getWidth() Width in pixels.
boolean	isInteger() Indicates if the data is integer.
IPnt	meanCellSize() Returns the approximate cell size of the raster.
void	setExtent(IEnvelope ppExtent) The extent of the Raster.
void	setHeight(int pVal) Height in pixels.
void	setNoDataValue(Object pVal) Data value used to indicate invalid or excluded data.
void	setPixelType(int pVal) Data type of the pixels.
void	setSpatialReference(ISpatialReference ppSpref) SpatialReference of the Raster.
void	setWidth(int pVal) Width in pixels.

Method Detail

getWidth

int getWidth()
             throws IOException,
                    AutomationException

Width in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pVal)
              throws IOException,
                     AutomationException

Width in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException

Height in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(int pVal)
               throws IOException,
                      AutomationException

Height in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException

Data type of the pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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 pVal)
                  throws IOException,
                         AutomationException

Data type of the pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataValue

Object getNoDataValue()
                      throws IOException,
                             AutomationException

Data value used to indicate invalid or excluded data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoDataValue

void setNoDataValue(Object pVal)
                    throws IOException,
                           AutomationException

Data value used to indicate invalid or excluded data.

Remarks

Specifying a single NoData value for a multiband raster, the NoData value will apply to each raster band in the raster. To set different NoData value for each band, pass an array, each element in the array sets the NoData value for the corresponding band, to this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

meanCellSize

IPnt meanCellSize()
                  throws IOException,
                         AutomationException

Returns the approximate cell size of the raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

isInteger

boolean isInteger()
                  throws IOException,
                         AutomationException

Indicates if the data is integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

SpatialReference of the Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setSpatialReference

void setSpatialReference(ISpatialReference ppSpref)
                         throws IOException,
                                AutomationException

SpatialReference of the Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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 extent of the Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.