com.esri.arcgis.carto
Interface IGeoImageDescription

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGeoImageDescription2, IGeoImageDescription3

All Known Implementing Classes:

GeoImageDescription

public interface IGeoImageDescription
extends Serializable

Provides access to members that control an image description.

Description

This interface is new at ArcGIS 9.3.

Remarks

IGeoImageDescription provides the access to define the properties of an image you would like to retrieve from an image server. The pixel data will be processed on-the-fly to fit your description and returned. The properties you can specify include extent, spatial reference, compression, interpolation, band selection, etc.

Product Availability

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

Method Summary

ILongArray	getBandSelection() The band selection.
String	getCompression() The compression.
int	getCompressionQuality() The compression quality.
IEnvelope	getExtent() The extent.
int	getHeight() The Height in pixels.
int	getInterpolation() The interpolation method.
String	getMosaicProperties() The mosaic properties.
Object	getNoData() The output NoData (background) value.
int	getPixelType() The data type of the pixels.
ISpatialReference	getSpatialReference() The Spatial Reference.
String	getViewpointProperties() The viewpoint properties.
int	getWidth() The Width in pixels.
void	setBandSelectionByRef(ILongArray ppBandIDs) The band selection.
void	setCompression(String pCompression) The compression.
void	setCompressionQuality(int pQuality) The compression quality.
void	setExtentByRef(IEnvelope ppExtent) The extent.
void	setHeight(int pNumRows) The Height in pixels.
void	setInterpolation(int pInterpolation) The interpolation method.
void	setMosaicProperties(String pMosaicProperties) The mosaic properties.
void	setNoData(Object pNoData) The output NoData (background) value.
void	setPixelType(int pPixelType) The data type of the pixels.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The Spatial Reference.
void	setViewpointProperties(String pViewpointProperties) The viewpoint properties.
void	setWidth(int pNumCols) The Width in pixels.

Method Detail

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

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

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException

The Spatial Reference.

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.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

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

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException

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

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The Width in pixels.

Product Availability

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

Returns:

The pNumCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int pNumCols)
              throws IOException,
                     AutomationException

The Width in pixels.

Product Availability

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

Parameters:

pNumCols - The pNumCols (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException

The Height in pixels.

Product Availability

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

Returns:

The pNumRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(int pNumRows)
               throws IOException,
                      AutomationException

The Height in pixels.

Product Availability

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

Parameters:

pNumRows - The pNumRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException

The data type of the pixels.

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 data type of the pixels.

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 output NoData (background) value.

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

The output NoData (background) value.

Product Availability

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

Parameters:

pNoData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInterpolation

int getInterpolation()
                     throws IOException,
                            AutomationException

The interpolation method.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInterpolation

void setInterpolation(int pInterpolation)
                      throws IOException,
                             AutomationException

The interpolation method.

Product Availability

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

Parameters:

pInterpolation - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompression

String getCompression()
                      throws IOException,
                             AutomationException

The compression.

Product Availability

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

Returns:

The pCompression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompression

void setCompression(String pCompression)
                    throws IOException,
                           AutomationException

The compression.

Remarks

The compression type used in transmission. Supported compressions include None, LZ77, and JPEG. A new compression "LERC" is added in 10.1.

Product Availability

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

Parameters:

pCompression - The pCompression (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.

Product Availability

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

Returns:

The pQuality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionQuality

void setCompressionQuality(int pQuality)
                           throws IOException,
                                  AutomationException

The compression quality.

Remarks

The JPEG compression quality in value range 1-100

Product Availability

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

Parameters:

pQuality - The pQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandSelection

ILongArray getBandSelection()
                            throws IOException,
                                   AutomationException

The band selection.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandSelectionByRef

void setBandSelectionByRef(ILongArray ppBandIDs)
                           throws IOException,
                                  AutomationException

The band selection.

Remarks

The band selection containing a list of band numbers. The band number starts from 0. For example, if the image service has 3 band. The band selection should be 0,1,2. Requesting band 3 will return an error.

Product Availability

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

Parameters:

ppBandIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicProperties

void setMosaicProperties(String pMosaicProperties)
                         throws IOException,
                                AutomationException

The mosaic properties.

Remarks

The mosaic properties containing information controlling how mosaic should be performed, such as mosaic method, and etc. The mosaic properties is a XML formatted string. The following are sample mosaic properties:

<MosaicMethod>Center</MosaicMethod>
<MosaicMethod>ByAttribute</MosaicMethod><TileOrderField>Month</TileOrderField><TileOrderBase>6</TileOrderBase>

Refer to the ArcGIS Image Server document for details on all supported mosaic properties.

The MosaicProperties is replaced at 9.4 by MosaicRule

Product Availability

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

Parameters:

pMosaicProperties - The pMosaicProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicProperties

String getMosaicProperties()
                           throws IOException,
                                  AutomationException

The mosaic properties.

Product Availability

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

Returns:

The pMosaicProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewpointProperties

void setViewpointProperties(String pViewpointProperties)
                            throws IOException,
                                   AutomationException

The viewpoint properties.

Remarks

The view point properties. The view point properties is a XML formatted string. The following are sample view point properties:

<ViewPointX>4489898.428</ViewPointX><ViewPointY>5478905.02941413</ViewPointY>

Refer to ArcGIS Image Server document for details on all supported view point properties.

The ViewpointProperties is replaced at 9.4 by MosaicRule.

Product Availability

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

Parameters:

pViewpointProperties - The pViewpointProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewpointProperties

String getViewpointProperties()
                              throws IOException,
                                     AutomationException

The viewpoint properties.

Product Availability

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

Returns:

The pViewpointProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.