com.esri.arcgis.datasourcesraster
Class MosaicRaster

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.MosaicRaster
All Implemented Interfaces:
IMosaicRaster, IMosaicRaster2, IPixelOperation, IRasterCollection, IRasterProps, IGeoDataset, IRaster, ISaveAs, ISaveAs2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class MosaicRaster
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicRaster, IMosaicRaster2, IRasterCollection, IRaster, IRasterProps, IGeoDataset, ISaveAs, ISaveAs2, IPixelOperation, ISupportErrorInfo

A mosaic of rasters.

Description

The MosaicRaster coclass represents a special type of Raster that takes a collection of rasters and mosaics them into one seamless raster. The set of rasters can be from any raster formats or geodatabase rasters, it can also be all or a set of rasters in a raster catalog.

The overlapping areas can be resolved by a predefined or custom MosaicOperator.

The mosaic result can be saved to a file raster format or a geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IMosaicRaster, Serialized Form

Constructor Summary
MosaicRaster()
          Constructs a MosaicRaster using ArcGIS Engine.
MosaicRaster(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicRaster theMosaicRaster = (MosaicRaster) obj;
 
Method Summary
 void append(IRaster pRaster)
          Appends a raster to the end.
 boolean canSaveAs(String format)
          Checks if it's can be saved as a new persistent Dataset of a given format.
 IRasterCursor createCursor()
          Allocates a Raster Cursor for fast raster scanning.
 IPixelBlock createPixelBlock(IPnt size)
          Allocates a PixelBlock of requested size.
 void empty()
          Empties this raster collection.
 boolean equals(Object o)
          Compare this object with another
 int find(IRaster pRaster)
          Finds a given raster and returns its index position.
 IRaster get(int index)
          Gets the raster at a given index position.
static String getClsid()
          getClsid.
 IRasterColormap getColormap()
          The colormap to be used.
 IEnvelope getExtent()
          The extent of the Raster.
 int getHeight()
          Height in pixels.
 int getMosaicColormapMode()
          The current mode for mosaicking pseucolor rasters.
 IMosaicOperator getMosaicOperator()
          The current mosaic operator.
 int getMosaicOperatorType()
          The current mosaic operator type.
 Object getNoDataValue()
          Data value used to indicate invalid or excluded data.
 String getOrderByField()
          The Order By fields on the base RasterCatalog.
 IPixelFilter getPixelFilter()
          The pixel filter for filtering pixel values.
 int getPixelType()
          Data type of the pixels.
 IRasterCatalog getRasterCatalog()
          The base RasterCatalog.
 IRasterCatalogTable getRasterCatalogTable()
          The source raster catalog table.
 int getRasterCount()
          The number of rasters in this raster collection.
 int getResampleMethod()
          Interpolation method used when reading pixels.
 ISpatialReference getSpatialReference()
          SpatialReference of the Raster.
 String getWhereClause()
          The Where Clause on the base RasterCatalog.
 int getWidth()
          Width in pixels.
 int hashCode()
          the hashcode for this object
 void insert(int index, IRaster pRaster)
          Inserts a raster at a given index.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAscending()
          Indicates whether the ascending flag of OrderBy.
 boolean isInteger()
          Indicates if the data is integer.
 IPnt meanCellSize()
          Returns the approximate cell size of the raster.
 void populate(IEnvelope pExtent)
          Populates this raster collection from associated RasterCatalog.
 void read(IPnt tlc, IPixelBlock block)
          Read a block of pixels starting from the top left corner.
 void recalculateCellsize(int type)
          Recalculates the cellsize as (min, max, or mean) of all cellsizes.
 void remove(int index)
          Removes a raster at a given index.
 IDataset saveAs(String name, IWorkspace workspace, String format)
          Creates a new persistent Dataset of a given format.
 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 set(int index, IRaster pRaster)
          Sets the raster at a given index position.
 void setAscending(boolean ascending)
          Indicates whether the ascending flag of OrderBy.
 void setColormap(IRasterColormap ppColormap)
          The colormap to be used.
 void setExtent(IEnvelope ppExtent)
          The extent of the Raster.
 void setHeight(int pVal)
          Height in pixels.
 void setMosaicColormapMode(int mode)
          The current mode for mosaicking pseucolor rasters.
 void setMosaicOperatorByRef(IMosaicOperator op)
          The current mosaic operator.
 void setMosaicOperatorType(int type)
          The current mosaic operator type.
 void setNoDataValue(Object pVal)
          Data value used to indicate invalid or excluded data.
 void setOrderByField(String orderByField)
          The Order By fields on the base RasterCatalog.
 void setPixelFilterByRef(IPixelFilter ppFilter)
          The pixel filter for filtering pixel values.
 void setPixelType(int pVal)
          Data type of the pixels.
 void setRasterCatalogByRef(IRasterCatalog ppCatalog)
          The base RasterCatalog.
 void setRasterCatalogTableByRef(IRasterCatalogTable ppCatalogTable)
          The source raster catalog table.
 void setResampleMethod(int val)
          Interpolation method used when reading pixels.
 void setSpatialReference(ISpatialReference ppSpref)
          SpatialReference of the Raster.
 void setWhereClause(String whereClause)
          The Where Clause on the base RasterCatalog.
 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

MosaicRaster

public MosaicRaster()
             throws IOException,
                    UnknownHostException
Constructs a MosaicRaster using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MosaicRaster

public MosaicRaster(Object obj)
             throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MosaicRaster theMosaicRaster = (MosaicRaster) obj;

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

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

getRasterCatalog

public IRasterCatalog getRasterCatalog()
                                throws IOException,
                                       AutomationException
The base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRasterCatalog in interface IMosaicRaster
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterCatalog
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterCatalogByRef

public void setRasterCatalogByRef(IRasterCatalog ppCatalog)
                           throws IOException,
                                  AutomationException
The base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRasterCatalogByRef in interface IMosaicRaster
Parameters:
ppCatalog - A reference to a com.esri.arcgis.geodatabase.IRasterCatalog (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException
The Where Clause on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWhereClause in interface IMosaicRaster
Returns:
The whereClause
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException
The Where Clause on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWhereClause in interface IMosaicRaster
Parameters:
whereClause - The whereClause (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrderByField

public String getOrderByField()
                       throws IOException,
                              AutomationException
The Order By fields on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOrderByField in interface IMosaicRaster
Returns:
The orderByField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrderByField

public void setOrderByField(String orderByField)
                     throws IOException,
                            AutomationException
The Order By fields on the base RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOrderByField in interface IMosaicRaster
Parameters:
orderByField - The orderByField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAscending

public boolean isAscending()
                    throws IOException,
                           AutomationException
Indicates whether the ascending flag of OrderBy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAscending in interface IMosaicRaster
Returns:
The ascending
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAscending

public void setAscending(boolean ascending)
                  throws IOException,
                         AutomationException
Indicates whether the ascending flag of OrderBy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAscending in interface IMosaicRaster
Parameters:
ascending - The ascending (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicOperatorType

public int getMosaicOperatorType()
                          throws IOException,
                                 AutomationException
The current mosaic operator type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMosaicOperatorType in interface IMosaicRaster
Returns:
A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorType

public void setMosaicOperatorType(int type)
                           throws IOException,
                                  AutomationException
The current mosaic operator type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMosaicOperatorType in interface IMosaicRaster
Parameters:
type - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicOperator

public IMosaicOperator getMosaicOperator()
                                  throws IOException,
                                         AutomationException
The current mosaic operator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMosaicOperator in interface IMosaicRaster
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IMosaicOperator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicOperatorByRef

public void setMosaicOperatorByRef(IMosaicOperator op)
                            throws IOException,
                                   AutomationException
The current mosaic operator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMosaicOperatorByRef in interface IMosaicRaster
Parameters:
op - A reference to a com.esri.arcgis.datasourcesraster.IMosaicOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMosaicColormapMode

public int getMosaicColormapMode()
                          throws IOException,
                                 AutomationException
The current mode for mosaicking pseucolor rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMosaicColormapMode in interface IMosaicRaster
Returns:
A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMosaicColormapMode

public void setMosaicColormapMode(int mode)
                           throws IOException,
                                  AutomationException
The current mode for mosaicking pseucolor rasters.

Remarks

It is only applicable to ArcSDE rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMosaicColormapMode in interface IMosaicRaster
Parameters:
mode - A com.esri.arcgis.datasourcesraster.rstMosaicColormapMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormap

public IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException
The colormap to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColormap in interface IMosaicRaster
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterColormap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColormap

public void setColormap(IRasterColormap ppColormap)
                 throws IOException,
                        AutomationException
The colormap to be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColormap in interface IMosaicRaster
Parameters:
ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterCatalogTable

public IRasterCatalogTable getRasterCatalogTable()
                                          throws IOException,
                                                 AutomationException
The source raster catalog table.

Product Availability

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

Specified by:
getRasterCatalogTable in interface IMosaicRaster2
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterCatalogTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterCatalogTableByRef

public void setRasterCatalogTableByRef(IRasterCatalogTable ppCatalogTable)
                                throws IOException,
                                       AutomationException
The source raster catalog table.

Product Availability

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

Specified by:
setRasterCatalogTableByRef in interface IMosaicRaster2
Parameters:
ppCatalogTable - A reference to a com.esri.arcgis.datasourcesraster.IRasterCatalogTable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

recalculateCellsize

public void recalculateCellsize(int type)
                         throws IOException,
                                AutomationException
Recalculates the cellsize as (min, max, or mean) of all cellsizes.

Product Availability

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

Specified by:
recalculateCellsize in interface IMosaicRaster2
Parameters:
type - A com.esri.arcgis.datasourcesraster.esriCellsizeType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterCount

public int getRasterCount()
                   throws IOException,
                          AutomationException
The number of rasters in this raster collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRasterCount in interface IRasterCollection
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IRaster pRaster)
            throws IOException,
                   AutomationException
Inserts a raster at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
insert in interface IRasterCollection
Parameters:
index - The index (in)
pRaster - 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.

append

public void append(IRaster pRaster)
            throws IOException,
                   AutomationException
Appends a raster to the end.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
append in interface IRasterCollection
Parameters:
pRaster - 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.

remove

public void remove(int index)
            throws IOException,
                   AutomationException
Removes a raster at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
remove in interface IRasterCollection
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public int find(IRaster pRaster)
         throws IOException,
                AutomationException
Finds a given raster and returns its index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
find in interface IRasterCollection
Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

get

public IRaster get(int index)
            throws IOException,
                   AutomationException
Gets the raster at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
get in interface IRasterCollection
Parameters:
index - The index (in)
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.

set

public void set(int index,
                IRaster pRaster)
         throws IOException,
                AutomationException
Sets the raster at a given index position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
set in interface IRasterCollection
Parameters:
index - The index (in)
pRaster - 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.

empty

public void empty()
           throws IOException,
                  AutomationException
Empties this raster collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
empty in interface IRasterCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populate

public void populate(IEnvelope pExtent)
              throws IOException,
                     AutomationException
Populates this raster collection from associated RasterCatalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
populate in interface IRasterCollection
Parameters:
pExtent - 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.

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.

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.

saveAs

public IDataset saveAs(String name,
                       IWorkspace workspace,
                       String format)
                throws IOException,
                       AutomationException
Creates a new persistent Dataset of a given format.

Remarks

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.

Supported Platforms

Windows, Solaris, Linux

Specified by:
saveAs in interface ISaveAs
Parameters:
name - The name (in)
workspace - 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.

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.

getPixelFilter

public IPixelFilter getPixelFilter()
                            throws IOException,
                                   AutomationException
The pixel filter for filtering pixel values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPixelFilter in interface IPixelOperation
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelFilterByRef

public void setPixelFilterByRef(IPixelFilter ppFilter)
                         throws IOException,
                                AutomationException
The pixel filter for filtering pixel values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPixelFilterByRef in interface IPixelOperation
Parameters:
ppFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.