com.esri.arcgis.geodatabase
Interface IRasterStorageDef

All Superinterfaces:
Serializable
All Known Subinterfaces:
IRasterStorageDef2
All Known Implementing Classes:
IRasterStorageDef2Proxy, IRasterStorageDefProxy, RasterStorageDef

public interface IRasterStorageDef
extends Serializable

Provides access to members that control raster storage properties.

Superseded By

IRasterStorageDef2

Remarks

The IRasterStorageDef interface provides access to the storage parameters of a RasterValue or a RasterDataset , it allows you to set parameters used to store raster data.

The CompressionQuality property specifies the compression quality if the compression type is JPEG or JPEG 2000, the valid range is 5 to 95 where 95 is the best quality. By default, the compression quality is 75.

The CompressionType is an enumeration type of property. It specifies the compression method to be used to compress the raster data, LZ77 (lossless) and JPEG (lossy), and JPEG 2000 compression types are supported. By default, the data is compressed with LZ77.

The PyramidLevel property specifies the number of pyramid layers to be built for the raster dataset. If you want the geodatabase to build full pyramids with appropriate levels, use a value of 1. If you do not want the pyramid to be built, use 0, or you can specify the level you see fit your dataset. By default, the geodatabase builds full pyramid.

The PyramidResampleType determines which resampling method will be used to compute the pyramid layers. For categorical data, nearest neighbor resampling is best, while for continuous data, bilinear interpolation or cubic convolution are appropriate. By default, nearest neighbor resampling method is used.

The TileHeight and TileWidth properties determine the size of the storage block unit. The size must be multiple of 16, such as 128 or 256. The default tile size is 128 x 128 and it is good for most cases. For saving out a tiled TIFF, IRaterStorageDef2:Tiled needs to set to be True.

The Origin property only applies for enterprise geodatabase raster data. The origin is for pyramid storage reference, so if mosaicking raster data to the lower-right of the origin, the pyramids of the mosaic dataset will be built partially instead of fully. This is not the origin of the raster dataset extent.

The CellSize property applies to Personal, File and ArcSDE geodatabases. Once it is set, any new data that are mosaicked to it will be resampled to the specified cellsize. If not set, the cellsize of the first raster dataset mosaicked to it will be the cellsize of the mosaicked raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IRasterCatalogItem, RasterValue, RasterCatalog, RasterCatalogItem

Method Summary
 IPnt getCellSize()
          The cell size of the raster to be stored.
 int getCompressionQuality()
          The compression quality (in case of JPEG compression) to be applied to the raster being stored.
 int getCompressionType()
          The compression type to be applied on the raster being stored.
 IPoint getOrigin()
          The origin of the raster to be stored.
 int getPyramidLevel()
          The number of pyramid levels.
 int getPyramidResampleType()
          The method used for pyramid resampling.
 int getTileHeight()
          The raster storage tile height.
 int getTileWidth()
          The raster storage tile width.
 void setCellSizeByRef(IPnt cellSize)
          The cell size of the raster to be stored.
 void setCompressionQuality(int value)
          The compression quality (in case of JPEG compression) to be applied to the raster being stored.
 void setCompressionType(int type)
          The compression type to be applied on the raster being stored.
 void setOriginByRef(IPoint origin)
          The origin of the raster to be stored.
 void setPyramidLevel(int level)
          The number of pyramid levels.
 void setPyramidResampleType(int method)
          The method used for pyramid resampling.
 void setTileHeight(int height)
          The raster storage tile height.
 void setTileWidth(int width)
          The raster storage tile width.
 

Method Detail

setTileWidth

void setTileWidth(int width)
                  throws IOException,
                         AutomationException
The raster storage tile width.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTileWidth

int getTileWidth()
                 throws IOException,
                        AutomationException
The raster storage tile width.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setTileHeight

void setTileHeight(int height)
                   throws IOException,
                          AutomationException
The raster storage tile height.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTileHeight

int getTileHeight()
                  throws IOException,
                         AutomationException
The raster storage tile height.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPyramidResampleType

void setPyramidResampleType(int method)
                            throws IOException,
                                   AutomationException
The method used for pyramid resampling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPyramidResampleType

int getPyramidResampleType()
                           throws IOException,
                                  AutomationException
The method used for pyramid resampling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPyramidLevel

void setPyramidLevel(int level)
                     throws IOException,
                            AutomationException
The number of pyramid levels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPyramidLevel

int getPyramidLevel()
                    throws IOException,
                           AutomationException
The number of pyramid levels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCompressionType

void setCompressionType(int type)
                        throws IOException,
                               AutomationException
The compression type to be applied on the raster being stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCompressionType

int getCompressionType()
                       throws IOException,
                              AutomationException
The compression type to be applied on the raster being stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCompressionQuality

void setCompressionQuality(int value)
                           throws IOException,
                                  AutomationException
The compression quality (in case of JPEG compression) to be applied to the raster being stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCompressionQuality

int getCompressionQuality()
                          throws IOException,
                                 AutomationException
The compression quality (in case of JPEG compression) to be applied to the raster being stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOriginByRef

void setOriginByRef(IPoint origin)
                    throws IOException,
                           AutomationException
The origin of the raster to be stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOrigin

IPoint getOrigin()
                 throws IOException,
                        AutomationException
The origin of the raster to be stored.

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.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellSizeByRef

void setCellSizeByRef(IPnt cellSize)
                      throws IOException,
                             AutomationException
The cell size of the raster to be stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCellSize

IPnt getCellSize()
                 throws IOException,
                        AutomationException
The cell size of the raster to be stored.

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.