com.esri.arcgis.carto
Class RenderedRaster

java.lang.Object
  com.esri.arcgis.carto.RenderedRaster

All Implemented Interfaces:

IRenderedRaster, IRenderedRaster2, IRasterBandCollection, IRasterProps, IRasterResamplingControl, IGeoDataset, IRaster, ISaveAs, ISaveAs2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RenderedRaster
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRaster, IRenderedRaster, IRenderedRaster2, IRasterBandCollection, IRasterProps, IGeoDataset, ISaveAs, ISaveAs2, IRasterResamplingControl

A raster that is rendered using a renderer.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RenderedRaster()
Constructs a RenderedRaster using ArcGIS Engine.

RenderedRaster(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RenderedRaster theRenderedRaster = (RenderedRaster) obj;

Method Summary

void	add(IRasterBand element, int index) Adds a RasterBand to the band collection.
void	appendBand(IRasterBand element) Appends a RasterBand to the band collection.
void	appendBands(IRasterBandCollection bands) Appends a collection of RasterBands to the band collection.
boolean	canSaveAs(String format) Checks if it's can be saved as a new persistent Dataset of a given format.
void	clear() Removes all the elements in the collection.
IRasterCursor	createCursor() Allocates a Raster Cursor for fast raster scanning.
IPixelBlock	createPixelBlock(IPnt size) Allocates a PixelBlock of requested size.
boolean	equals(Object o) Compare this object with another
IRasterBand	getBandByName(String name) A RasterBand given its name.
int	getBandIndex(String name) The index of a RasterBand given its name.
IEnumRasterBand	getBands() All the bands in the collection as an interface to the RasterBands enumerator object.
static String	getClsid() getClsid.
int	getCount() The number of bands in the collection.
IEnvelope	getExtent() The extent of the Raster.
IName	getFullName() The full name.
int	getHeight() Height in pixels.
ILayer	getLayer() The source layer.
Object	getNoDataValue() Data value used to indicate invalid or excluded data.
int	getPixelType() Data type of the pixels.
IRaster	getRaster() The source raster.
IRasterRenderer	getRenderer() The raster renderer.
int	getResampleMethod() Interpolation method used when reading pixels.
int	getResamplingHint() The raster resampling hint.
ISpatialReference	getSpatialReference() SpatialReference of the Raster.
int	getWidth() Width in pixels.
int	hashCode() the hashcode for this object
void	init(String layerFile) Initializes using a layer file.
boolean	isForceRGB() Indicates if RGB output is required (forced).
boolean	isInteger() Indicates if the data is integer.
boolean	isRGB32() Indicates if alpha channel is to be added.
IRasterBand	item(int bandIndex) Returns a RasterBand given its index.
IPnt	meanCellSize() Returns the approximate cell size of the raster.
void	read(IPnt tlc, IPixelBlock block) Read a block of pixels starting from the top left corner.
void	remove(int index) Removes an element from the collection.
IDataset	saveAs(String new_name, IWorkspace worksp, String format) Creates a new persistent RasterDataset with the bands in the collection.
IRasterDataset	saveAsRasterDataset(String name, IWorkspace workspace, String format, IRasterStorageDef storageDef) Creates a new persistent Raster Dataset of a given format and specified storage definition.
void	setExtent(IEnvelope ppExtent) The extent of the Raster.
void	setForceRGB(boolean pForceRGB) Indicates if RGB output is required (forced).
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	setRaster(IRaster ppRaster) The source raster.
void	setRendererByRef(IRasterRenderer ppRenderer) The raster renderer.
void	setResampleMethod(int val) Interpolation method used when reading pixels.
void	setResamplingHint(int pHint) The raster resampling hint.
void	setRGB32(boolean pRGB32) Indicates if alpha channel is to be added.
void	setSpatialReference(ISpatialReference ppSpref) SpatialReference of the Raster.
void	setWidth(int pVal) Width in pixels.

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

RenderedRaster

public RenderedRaster()
               throws IOException,
                      UnknownHostException

Constructs a RenderedRaster using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RenderedRaster

public RenderedRaster(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RenderedRaster theRenderedRaster = (RenderedRaster) obj;

Construct a RenderedRaster using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RenderedRaster.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

read

public void read(IPnt tlc,
                 IPixelBlock block)
          throws IOException,
                 AutomationException

Read a block of pixels starting from the top left corner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

read in interface IRaster

Parameters:

tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

block - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createPixelBlock

public IPixelBlock createPixelBlock(IPnt size)
                             throws IOException,
                                    AutomationException

Allocates a PixelBlock of requested size.

Remarks

CreatePixelBlock method only initializes the properties of a pixel block, such as dimension, pixel type etc. Read method of this interface should be used to read pixels into the pixel block.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createPixelBlock in interface IRaster

Parameters:

size - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IPixelBlock

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createCursor

public IRasterCursor createCursor()
                           throws IOException,
                                  AutomationException

Allocates a Raster Cursor for fast raster scanning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createCursor in interface IRaster

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterCursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResampleMethod

public int getResampleMethod()
                      throws IOException,
                             AutomationException

Interpolation method used when reading pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResampleMethod in interface IRaster

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResampleMethod

public void setResampleMethod(int val)
                       throws IOException,
                              AutomationException

Interpolation method used when reading pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResampleMethod in interface IRaster

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(String layerFile)
          throws IOException,
                 AutomationException

Initializes using a layer file.

Product Availability

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

Specified by:

init in interface IRenderedRaster

Parameters:

layerFile - The layerFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The full name.

Product Availability

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

Specified by:

getFullName in interface IRenderedRaster

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isForceRGB

public boolean isForceRGB()
                   throws IOException,
                          AutomationException

Indicates if RGB output is required (forced).

Product Availability

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

Specified by:

isForceRGB in interface IRenderedRaster

Returns:

The pForceRGB

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForceRGB

public void setForceRGB(boolean pForceRGB)
                 throws IOException,
                        AutomationException

Indicates if RGB output is required (forced).

Product Availability

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

Specified by:

setForceRGB in interface IRenderedRaster

Parameters:

pForceRGB - The pForceRGB (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

The source layer.

Product Availability

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

Specified by:

getLayer in interface IRenderedRaster

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws IOException,
                         AutomationException

The source raster.

Product Availability

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

Specified by:

getRaster in interface IRenderedRaster2

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRaster

public void setRaster(IRaster ppRaster)
               throws IOException,
                      AutomationException

The source raster.

Product Availability

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

Specified by:

setRaster in interface IRenderedRaster2

Parameters:

ppRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public IRasterRenderer getRenderer()
                            throws IOException,
                                   AutomationException

The raster renderer.

Product Availability

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

Specified by:

getRenderer in interface IRenderedRaster2

Returns:

A reference to a com.esri.arcgis.carto.IRasterRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IRasterRenderer ppRenderer)
                      throws IOException,
                             AutomationException

The raster renderer.

Product Availability

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

Specified by:

setRendererByRef in interface IRenderedRaster2

Parameters:

ppRenderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRGB32

public boolean isRGB32()
                throws IOException,
                       AutomationException

Indicates if alpha channel is to be added.

Product Availability

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

Specified by:

isRGB32 in interface IRenderedRaster2

Returns:

The pRGB32

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRGB32

public void setRGB32(boolean pRGB32)
              throws IOException,
                     AutomationException

Indicates if alpha channel is to be added.

Product Availability

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

Specified by:

setRGB32 in interface IRenderedRaster2

Parameters:

pRGB32 - The pRGB32 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(IRasterBand element,
                int index)
         throws IOException,
                AutomationException

Adds a RasterBand to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IRasterBandCollection

Parameters:

element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of bands in the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IRasterBandCollection

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Removes all the elements in the collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IRasterBandCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Removes an element from the collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IRasterBandCollection

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandIndex

public int getBandIndex(String name)
                 throws IOException,
                        AutomationException

The index of a RasterBand given its name.

Product Availability

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

Specified by:

getBandIndex in interface IRasterBandCollection

Parameters:

name - The name (in)

Returns:

The bandIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandByName

public IRasterBand getBandByName(String name)
                          throws IOException,
                                 AutomationException

A RasterBand given its name.

Product Availability

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

Specified by:

getBandByName in interface IRasterBandCollection

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBands

public IEnumRasterBand getBands()
                         throws IOException,
                                AutomationException

All the bands in the collection as an interface to the RasterBands enumerator object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBands in interface IRasterBandCollection

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IEnumRasterBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

item

public IRasterBand item(int bandIndex)
                 throws IOException,
                        AutomationException

Returns a RasterBand given its index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

item in interface IRasterBandCollection

Parameters:

bandIndex - The bandIndex (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAs

public IDataset saveAs(String new_name,
                       IWorkspace worksp,
                       String format)
                throws IOException,
                       AutomationException

Creates a new persistent RasterDataset with the bands in the collection.

Remarks

The SaveAs method can create a raster dataset in Imagine, TIFF, GRID, JPEG2000, JPEG, BMP, GIF, PNG, PCI Raster, USGS ASCII DEM, X11 Pixmap, Memory Raster and geodatabase raster.

The format strings used for the supported formats are below, and they are case sensitive:

Format Name	String Used
Imagine	"IMAGINE Image"
TIFF	"TIFF"
GRID	"GRID"
JPEG	"JPG"
JP2000	"JP2"
BMP	"BMP"
PNG	"PNG"
GIF	"GIF"
PCI Raster	"PIX"
X11 Pixmap	"XPM"
PCRaster	"MAP"
Memory Raster	"MEM"
HDF4	"HDF4"
BIL	"BIL"
BIP	"BIP"
BSQ	"BSQ"
Idrisi Raster Format	"RST"
ENVI Raster Format	"ENVI"
Geodatabase Raster	"GDB"

The format string "TIFF" creates a TIFF file with ".tif" extension. ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension.

Note, SaveAs will return a RasterDataset, to prevent from SaveAs holding the output, .NET ReleaseCOMObject needs to be called to release the referene to the output raster dataset:

System.Runtime.InteropServices.Marshal.ReleaseComObject(outRasterDS);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

saveAs in interface IRasterBandCollection

Specified by:

saveAs in interface ISaveAs

Parameters:

new_name - The new_name (in)

worksp - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

format - The format (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

appendBand

public void appendBand(IRasterBand element)
                throws IOException,
                       AutomationException

Appends a RasterBand to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

appendBand in interface IRasterBandCollection

Parameters:

element - A reference to a com.esri.arcgis.datasourcesraster.IRasterBand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

appendBands

public void appendBands(IRasterBandCollection bands)
                 throws IOException,
                        AutomationException

Appends a collection of RasterBands to the band collection.

Remarks

This method is only applicable to work with a Raster, not with a RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

appendBands in interface IRasterBandCollection

Parameters:

bands - A reference to a com.esri.arcgis.datasourcesraster.IRasterBandCollection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException

Width in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IRasterProps

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public 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

Specified by:

setWidth in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

Height in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface IRasterProps

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

public 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

Specified by:

setHeight in interface IRasterProps

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

public 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

Specified by:

getPixelType in interface IRasterProps

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelType

public 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

Specified by:

setPixelType in interface IRasterProps

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

public 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

Specified by:

getNoDataValue in interface IRasterProps

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoDataValue

public 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

Specified by:

setNoDataValue in interface IRasterProps

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

meanCellSize

public 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

Specified by:

meanCellSize in interface IRasterProps

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

public 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

Specified by:

isInteger in interface IRasterProps

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public 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

Specified by:

getSpatialReference in interface IRasterProps

Specified by:

getSpatialReference in interface IGeoDataset

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

public 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

Specified by:

setSpatialReference in interface IRasterProps

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

public 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

Specified by:

getExtent in interface IRasterProps

Specified by:

getExtent in interface IGeoDataset

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

public 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

Specified by:

setExtent in interface IRasterProps

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.

canSaveAs

public boolean canSaveAs(String format)
                  throws IOException,
                         AutomationException

Checks if it's can be saved as a new persistent Dataset of a given format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canSaveAs in interface ISaveAs

Parameters:

format - The format (in)

Returns:

The canSaveAs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsRasterDataset

public IRasterDataset saveAsRasterDataset(String name,
                                          IWorkspace workspace,
                                          String format,
                                          IRasterStorageDef storageDef)
                                   throws IOException,
                                          AutomationException

Creates a new persistent Raster Dataset of a given format and specified storage definition.

Description

The pStorageDef argument specified the storage parameters, compression type, compression quality, tile size, ect. The parameters apply to certain output raster format, if the output raster format doesn't support the storage parameter specified, the settings are ignored.

The format strings used for the supported formats are below, and they are case sensitive:

Format Name	String Used
Imagine	"IMAGINE Image"
TIFF	"TIFF"
GRID	"GRID"
JPEG	"JPG"
JP2000	"JP2"
BMP	"BMP"
PNG	"PNG"
GIF	"GIF"
PCI Raster	"PIX"
X11 Pixmap	"XPM"
PCRaster	"MAP"
Memory Raster	"MEM"
HDF4	"HDF4"
BIL	"BIL"
BIP	"BIP"
BSQ	"BSQ"
Idrisi Raster Format	"RST"
ENVI Raster Format	"ENVI"
Geodatabase Raster	"GDB"

Product Availability

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

Specified by:

saveAsRasterDataset in interface ISaveAs2

Parameters:

name - The name (in)

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

format - The format (in)

storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRasterDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResamplingHint

public int getResamplingHint()
                      throws IOException,
                             AutomationException

The raster resampling hint.

Product Availability

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

Specified by:

getResamplingHint in interface IRasterResamplingControl

Returns:

A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResamplingHint

public void setResamplingHint(int pHint)
                       throws IOException,
                              AutomationException

The raster resampling hint.

Product Availability

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

Specified by:

setResamplingHint in interface IRasterResamplingControl

Parameters:

pHint - A com.esri.arcgis.geodatabase.esriRasterResamplingHint constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.