This document is archived and information here might be outdated.  Recommended version.


IRasterProps Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > DataSourcesRaster > ESRI.ArcGIS.DataSourcesRaster > Interfaces > IR > IRasterProps Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (DataSourcesRaster)  

IRasterProps Interface

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

Product Availability

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

Members

Name Description
Read/write property Extent The extent of the Raster.
Read/write property Height Height in pixels.
Read-only property IsInteger Indicates if the data is integer.
Read/write property MapModel Map to raster transformation information.
Method MeanCellSize Returns the approximate cell size of the raster.
Read/write property NoDataValue Data value used to indicate invalid or excluded data.
Read/write property PixelType Data type of the pixels.
Read/write property SpatialReference SpatialReference of the Raster.
Read/write property Width Width in pixels.

CoClasses that implement IRasterProps

CoClasses and Classes Description
MosaicRaster A mosaic of rasters.
Raster An in-memory representation of a dynamic raster that can perform resampling and reprojection.
RasterBand A representation of a single band of a raster dataset on disk.
RenderedRaster (esriCarto) A raster that is rendered using a renderer.

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.

 

 

See Also

IRaster Interface

.NET Samples

Create a custom raster type (Code Files: ThumbnailBuilder) | Create a custom default raster renderer (Code Files: RasterRendererMaker_1bit_TIFF_VBNET) | Create a custom NoData pixel filter (Code Files: TestApp) | Create a custom raster function (Code Files: WatermarkFunction)

.NET Related Topics

DataSourcesRaster | Deferred evaluation | Geodatabase | How to create a raster dataset | How to create an image server layer | How to pan sharpen an image | How to perform a geodata transformation on a raster | How to project a raster with a datum transformation | How to set raster properties when saving as a raster | How to split a raster dataset into multiple tiles