|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.GeoImageDescription
public class GeoImageDescription
A class that specifies an image to read from an ArcGIS server image service.
This object is new at ArcGIS 9.3.
GeoImageDescription specifies an image to fetch from an image service, including spatial reference, pixel size, extent, compression and quality, NoData (background) value, band selection, and etc.
New at 9.4, a mosaic rule can be used to specify how mosaic should be performed if more than one images involved within the requested area of interest.
New at 9.4, a rendering rule can be used to define how rendering should be done on the raw pixels. For example, a hillshade rendering rule can be used to generate a hillshaded image from float-point elevation data.
Constructor Summary | |
---|---|
GeoImageDescription()
Constructs a GeoImageDescription using ArcGIS Engine. |
|
GeoImageDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GeoImageDescription theGeoImageDescription = (GeoImageDescription) obj; |
Method Summary | |
---|---|
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(Object o)
Compare this object with another |
ILongArray |
getBandSelection()
The band selection. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
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 |
getMinNamespaceSupported()
The minimum namespace the class can serialize to (eg the 90 namespace). |
String |
getMosaicProperties()
The mosaic properties. |
IMosaicRule |
getMosaicRule()
The mosaic rule. |
Object |
getNoData()
The output NoData (background) value. |
int |
getPixelType()
The data type of the pixels. |
IRenderingRule |
getRenderingRule()
The rendering rule. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISpatialReference |
getSpatialReference()
The Spatial Reference. |
String |
getViewpointProperties()
The viewpoint properties. |
int |
getWidth()
The Width in pixels. |
int |
hashCode()
the hashcode for this object |
boolean |
isBSQ()
Indicates if output should be generated in BSQ pxiel interleave format. |
void |
isDirty()
isDirty |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setBandSelectionByRef(ILongArray ppBandIDs)
The band selection. |
void |
setBSQ(boolean pBSQ)
Indicates if output should be generated in BSQ pxiel interleave format. |
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 |
setMosaicRuleByRef(IMosaicRule ppMosaicRule)
The mosaic rule. |
void |
setNoData(Object pNoData)
The output NoData (background) value. |
void |
setPixelType(int pPixelType)
The data type of the pixels. |
void |
setRenderingRuleByRef(IRenderingRule ppRenderingRule)
The rendering rule. |
void |
setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
The Spatial Reference. |
void |
setViewpointProperties(String pViewpointProperties)
The viewpoint properties. |
void |
setWidth(int pNumCols)
The Width in pixels. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public GeoImageDescription() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GeoImageDescription(Object obj) throws IOException
GeoImageDescription theGeoImageDescription = (GeoImageDescription) obj;
obj
to GeoImageDescription
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public ISpatialReference getSpatialReference() throws IOException, AutomationException
getSpatialReference
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference) throws IOException, AutomationException
setSpatialReferenceByRef
in interface IGeoImageDescription
ppSpatialReference
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws IOException, AutomationException
getExtent
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExtentByRef(IEnvelope ppExtent) throws IOException, AutomationException
setExtentByRef
in interface IGeoImageDescription
ppExtent
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getWidth() throws IOException, AutomationException
getWidth
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setWidth(int pNumCols) throws IOException, AutomationException
setWidth
in interface IGeoImageDescription
pNumCols
- The pNumCols (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHeight() throws IOException, AutomationException
getHeight
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHeight(int pNumRows) throws IOException, AutomationException
setHeight
in interface IGeoImageDescription
pNumRows
- The pNumRows (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPixelType() throws IOException, AutomationException
getPixelType
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPixelType(int pPixelType) throws IOException, AutomationException
setPixelType
in interface IGeoImageDescription
pPixelType
- A com.esri.arcgis.geodatabase.rstPixelType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getNoData() throws IOException, AutomationException
getNoData
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNoData(Object pNoData) throws IOException, AutomationException
setNoData
in interface IGeoImageDescription
pNoData
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getInterpolation() throws IOException, AutomationException
getInterpolation
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setInterpolation(int pInterpolation) throws IOException, AutomationException
setInterpolation
in interface IGeoImageDescription
pInterpolation
- A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCompression() throws IOException, AutomationException
getCompression
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCompression(String pCompression) throws IOException, AutomationException
The compression type used in transmission. Supported compressions include None, LZ77, and JPEG.
setCompression
in interface IGeoImageDescription
pCompression
- The pCompression (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCompressionQuality() throws IOException, AutomationException
getCompressionQuality
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCompressionQuality(int pQuality) throws IOException, AutomationException
The JPEG compression quality in value range 1-100
setCompressionQuality
in interface IGeoImageDescription
pQuality
- The pQuality (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILongArray getBandSelection() throws IOException, AutomationException
getBandSelection
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBandSelectionByRef(ILongArray ppBandIDs) throws IOException, AutomationException
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.
setBandSelectionByRef
in interface IGeoImageDescription
ppBandIDs
- A reference to a com.esri.arcgis.system.ILongArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMosaicProperties(String pMosaicProperties) throws IOException, AutomationException
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
setMosaicProperties
in interface IGeoImageDescription
pMosaicProperties
- The pMosaicProperties (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMosaicProperties() throws IOException, AutomationException
getMosaicProperties
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setViewpointProperties(String pViewpointProperties) throws IOException, AutomationException
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.
setViewpointProperties
in interface IGeoImageDescription
pViewpointProperties
- The pViewpointProperties (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getViewpointProperties() throws IOException, AutomationException
getViewpointProperties
in interface IGeoImageDescription
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMosaicRule getMosaicRule() throws IOException, AutomationException
getMosaicRule
in interface IGeoImageDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMosaicRuleByRef(IMosaicRule ppMosaicRule) throws IOException, AutomationException
Specifies the mosaic rules when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, and etc.
setMosaicRuleByRef
in interface IGeoImageDescription2
ppMosaicRule
- A reference to a com.esri.arcgis.carto.IMosaicRule (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRenderingRule getRenderingRule() throws IOException, AutomationException
getRenderingRule
in interface IGeoImageDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRenderingRuleByRef(IRenderingRule ppRenderingRule) throws IOException, AutomationException
MosaicRule value object is used to define the mosaic rule for mosaicking requested images on the fly. A mosaic rule contains a mosaic method, its parameters, and a mosaic operation. In general, a mosaic rule is used to specify (1) the selection of rasters to participate in the mosaic; (2) how the selected rasters are ordered; (3) how overlapping pixels at the same location are resolved.
setRenderingRuleByRef
in interface IGeoImageDescription2
ppRenderingRule
- A reference to a com.esri.arcgis.carto.IRenderingRule (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isBSQ() throws IOException, AutomationException
isBSQ
in interface IGeoImageDescription2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBSQ(boolean pBSQ) throws IOException, AutomationException
setBSQ
in interface IGeoImageDescription2
pBSQ
- The pBSQ (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMinNamespaceSupported() throws IOException, AutomationException
getMinNamespaceSupported
in interface IXMLVersionSupport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |