com.esri.arcgis.datasourcesraster
Class Raster

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.Raster
All Implemented Interfaces:
IPixelOperation, IRaster2, IRasterAnalysisProps, IRasterBandCollection, IRasterDefaultProps, IRasterEdit, IRasterProps, IGeoDataset, IRaster, ISaveAs, ISaveAs2, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, Serializable

public class Raster
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRaster, IRaster2, IRasterEdit, IRasterProps, IGeoDataset, IRasterBandCollection, IRasterDefaultProps, IRasterAnalysisProps, ISupportErrorInfo, ISaveAs, ISaveAs2, IClone, IPixelOperation

An in-memory representation of a dynamic raster that can perform resampling and reprojection.

Description

The Raster object is a transient representation of raster data that performs resampling and reprojection. It can be modified without affecting the source data. This allows the raster to represent what you want, as you may set a transformation, a pixel filter on a raster or specify a projection, extent, and cell size into which the input data will be transformed. This makes the raster quite useful for performing display or analysis in a coordinate system different from that which is stored in the raster dataset.

Because of the transient nature of the raster, any modifications that are made to this object will be lost when the object is released. The modified Raster can be persisted to another raster dataset on disk or in a geodatabase using ISaveAs or IRasterBandCollection interface.

Although the Raster object is always transient in nature, it must be associated with one or more raster bands, which provide a source for data to be read through the raster. As such, the Raster is most easily understood as a vehicle to provide resampling, projection, and data type conversion from one or more raster bands to a desired output coordinate system.

A Raster can be created in three ways:

1. Get from a RasterLayer using IRasterLayer::Raster

2. Create from a raster dataset using either :IRasterDataset::CreateDefaultRaster or IRasterDataset2::CreateFullRaster

3. Cocreate a Raster and append raster bands using IRasterBandCollection interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
Raster()
          Constructs a Raster using ArcGIS Engine.
Raster(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Raster theRaster = (Raster) 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.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean canEdit()
          Checks if this Raster can be edited.
 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.
 IRasterCursor createCursorEx(IPnt pBlockSize)
          Creates a cursor with a given pixel block size or native block size.
 IPixelBlock createPixelBlock(IPnt size)
          Allocates a PixelBlock of requested size.
 boolean equals(Object o)
          Compare this object with another
 void erase(IPnt pTlc, IPixelBlock pPixelBlock)
          Erases a PixelBlock starting at a given Top-Left corner.
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IEnvelope getAnalysisExtent()
          The analysis extent of the raster.
 ITable getAttributeTable()
          The raster value attribute table.
 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.
 IRasterColormap getColormap()
          The colormap.
 int getCount()
          The number of bands in the collection.
 IEnvelope getDefaultIntersectExtent()
          The default intersect extent.
 double getDefaultPixelHeight()
          The default pixel size in Y.
 double getDefaultPixelWidth()
          The default pixel size in X.
 ISpatialReference getDefaultSpatialReference()
          The default spatial reference.
 IEnvelope getDefaultUnionExtent()
          The default union extent.
 IEnvelope getExtent()
          The extent of the Raster.
 IGeodataXform getGeodataXform()
          The geodata transform.
 IGeoTransformationOperationSet getGeoTransformations()
          The set of geographic transformations to be applied.
 int getHeight()
          Height in pixels.
 Object getNoDataValue()
          Data value used to indicate invalid or excluded data.
 IPixelFilter getPixelFilter()
          The pixel filter for filtering pixel values.
 double getPixelHeight()
          The pixel height in ground resolution.
 int getPixelType()
          Data type of the pixels.
 Object getPixelValue(int iBand, int iColumn, int iRow)
          Gets the pixel value for a given band at a given column and row.
 double getPixelWidth()
          The pixel width in ground resolution.
 IRasterDataset getRasterDataset()
          The parent raster dataset.
 IRasterXformer getRasterXformer()
          The raster transformer.
 int getResampleMethod()
          Interpolation method used when reading pixels.
 ISpatialReference getSpatialReference()
          SpatialReference of the Raster.
 int getWidth()
          Width in pixels.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isInteger()
          Indicates if the data is integer.
 IRasterBand item(int bandIndex)
          Returns a RasterBand given its index.
 void makePermanent()
          Makes a temporary raster a permanent raster dataset.
 void mapToPixel(double x, double y, int[] pColumn, int[] pRow)
          Converts a location (x, y) in map space into pixel space.
 IPnt meanCellSize()
          Returns the approximate cell size of the raster.
 void pixelToMap(int iColumn, int iRow, double[] pX, double[] pY)
          Converts a location (column, row) in pixel space into map space.
 void read(IPnt tlc, IPixelBlock block)
          Read a block of pixels starting from the top left corner.
 void refresh()
          Refreshes the associated RasterDataset.
 void remove(int index)
          Removes an element from the collection.
 void resetToDefault()
          Resets the raster to default state
 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 setAnalysisExtentByRef(IEnvelope ppExtent)
          The analysis extent of the raster.
 void setAttributeTableByRef(ITable ppVAT)
          The raster value attribute table.
 void setColormapByRef(IRasterColormap ppColormap)
          The colormap.
 void setExtent(IEnvelope ppExtent)
          The extent of the Raster.
 void setGeodataXform(IGeodataXform ppXform)
          The geodata transform.
 void setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms)
          The set of geographic transformations to be applied.
 void setHeight(int pVal)
          Height in pixels.
 void setNoDataValue(Object pVal)
          Data value used to indicate invalid or excluded data.
 void setPixelFilterByRef(IPixelFilter ppFilter)
          The pixel filter for filtering pixel values.
 void setPixelHeight(double height)
          The pixel height in ground resolution.
 void setPixelType(int pVal)
          Data type of the pixels.
 void setPixelWidth(double width)
          The pixel width in ground resolution.
 void setResampleMethod(int val)
          Interpolation method used when reading pixels.
 void setSpatialReference(ISpatialReference ppSpref)
          SpatialReference of the Raster.
 void setWidth(int pVal)
          Width in pixels.
 double toMapX(int iColumn)
          Maps a pixel column to the x coordinate in map space.
 double toMapY(int iRow)
          Maps a pixel row to the y coordinate in map space.
 int toPixelColumn(double x)
          Maps a x coordinate in map space to the pixel column.
 int toPixelRow(double y)
          Maps a y coordinate in map space to the pixel row.
 void write(IPnt pTlc, IPixelBlock pPixelBlock)
          Writes a PixelBlock starting at a given Top-Left corner.
 
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

Raster

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

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

Raster

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

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

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.

getGeodataXform

public IGeodataXform getGeodataXform()
                              throws IOException,
                                     AutomationException
The geodata transform.

Remarks

After you set a GeodataXform on a Raster and perform SaveAs, you must also set the extent, width and height of the raster in the space after the transformation.

Product Availability

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

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

setGeodataXform

public void setGeodataXform(IGeodataXform ppXform)
                     throws IOException,
                            AutomationException
The geodata transform.

Remarks

The put GeodataXform does not automatically update the extent and cell size, to save out a transformed raster, you need to transform the extent and cell size first, then put the transformed extent and cell size on the raster, the call SaveAs.

Product Availability

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

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

setGeoTransformationsByRef

public void setGeoTransformationsByRef(IGeoTransformationOperationSet ppGeoXforms)
                                throws IOException,
                                       AutomationException
The set of geographic transformations to be applied.

Product Availability

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

Specified by:
setGeoTransformationsByRef in interface IRaster2
Parameters:
ppGeoXforms - A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeoTransformations

public IGeoTransformationOperationSet getGeoTransformations()
                                                     throws IOException,
                                                            AutomationException
The set of geographic transformations to be applied.

Product Availability

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

Specified by:
getGeoTransformations in interface IRaster2
Returns:
A reference to a com.esri.arcgis.geometry.IGeoTransformationOperationSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws IOException,
                                AutomationException
The raster value attribute table.

Product Availability

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

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

setAttributeTableByRef

public void setAttributeTableByRef(ITable ppVAT)
                            throws IOException,
                                   AutomationException
The raster value attribute table.

Product Availability

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

Specified by:
setAttributeTableByRef in interface IRaster2
Parameters:
ppVAT - A reference to a com.esri.arcgis.geodatabase.ITable (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.

Product Availability

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

Specified by:
getColormap in interface IRaster2
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.

setColormapByRef

public void setColormapByRef(IRasterColormap ppColormap)
                      throws IOException,
                             AutomationException
The colormap.

Product Availability

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

Specified by:
setColormapByRef in interface IRaster2
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.

getRasterDataset

public IRasterDataset getRasterDataset()
                                throws IOException,
                                       AutomationException
The parent raster dataset.

Product Availability

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

Specified by:
getRasterDataset in interface IRaster2
Specified by:
getRasterDataset in interface IRasterAnalysisProps
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.

createCursorEx

public IRasterCursor createCursorEx(IPnt pBlockSize)
                             throws IOException,
                                    AutomationException
Creates a cursor with a given pixel block size or native block size.

Product Availability

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

Specified by:
createCursorEx in interface IRaster2
Parameters:
pBlockSize - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
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.

getRasterXformer

public IRasterXformer getRasterXformer()
                                throws IOException,
                                       AutomationException
The raster transformer.

Product Availability

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

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

mapToPixel

public void mapToPixel(double x,
                       double y,
                       int[] pColumn,
                       int[] pRow)
                throws IOException,
                       AutomationException
Converts a location (x, y) in map space into pixel space.

Product Availability

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

Specified by:
mapToPixel in interface IRaster2
Parameters:
x - The x (in)
y - The y (in)
pColumn - The pColumn (out: use single element array)
pRow - The pRow (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pixelToMap

public void pixelToMap(int iColumn,
                       int iRow,
                       double[] pX,
                       double[] pY)
                throws IOException,
                       AutomationException
Converts a location (column, row) in pixel space into map space.

Product Availability

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

Specified by:
pixelToMap in interface IRaster2
Parameters:
iColumn - The iColumn (in)
iRow - The iRow (in)
pX - The pX (out: use single element array)
pY - The pY (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toPixelColumn

public int toPixelColumn(double x)
                  throws IOException,
                         AutomationException
Maps a x coordinate in map space to the pixel column.

Product Availability

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

Specified by:
toPixelColumn in interface IRaster2
Parameters:
x - The x (in)
Returns:
The pColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toPixelRow

public int toPixelRow(double y)
               throws IOException,
                      AutomationException
Maps a y coordinate in map space to the pixel row.

Product Availability

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

Specified by:
toPixelRow in interface IRaster2
Parameters:
y - The y (in)
Returns:
The pRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapX

public double toMapX(int iColumn)
              throws IOException,
                     AutomationException
Maps a pixel column to the x coordinate in map space.

Product Availability

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

Specified by:
toMapX in interface IRaster2
Parameters:
iColumn - The iColumn (in)
Returns:
The pX
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapY

public double toMapY(int iRow)
              throws IOException,
                     AutomationException
Maps a pixel row to the y coordinate in map space.

Product Availability

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

Specified by:
toMapY in interface IRaster2
Parameters:
iRow - The iRow (in)
Returns:
The pY
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelValue

public Object getPixelValue(int iBand,
                            int iColumn,
                            int iRow)
                     throws IOException,
                            AutomationException
Gets the pixel value for a given band at a given column and row.

Product Availability

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

Specified by:
getPixelValue in interface IRaster2
Parameters:
iBand - The iBand (in)
iColumn - The iColumn (in)
iRow - The iRow (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canEdit

public boolean canEdit()
                throws IOException,
                       AutomationException
Checks if this Raster can be edited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

write

public void write(IPnt pTlc,
                  IPixelBlock pPixelBlock)
           throws IOException,
                  AutomationException
Writes a PixelBlock starting at a given Top-Left corner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
write in interface IRasterEdit
Parameters:
pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
pPixelBlock - 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.

erase

public void erase(IPnt pTlc,
                  IPixelBlock pPixelBlock)
           throws IOException,
                  AutomationException
Erases a PixelBlock starting at a given Top-Left corner.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
erase in interface IRasterEdit
Parameters:
pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
pPixelBlock - 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.

refresh

public void refresh()
             throws IOException,
                    AutomationException
Refreshes the associated RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
refresh in interface IRasterEdit
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.

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.

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.

getDefaultPixelWidth

public double getDefaultPixelWidth()
                            throws IOException,
                                   AutomationException
The default pixel size in X.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultPixelWidth in interface IRasterDefaultProps
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultPixelHeight

public double getDefaultPixelHeight()
                             throws IOException,
                                    AutomationException
The default pixel size in Y.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultPixelHeight in interface IRasterDefaultProps
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultUnionExtent

public IEnvelope getDefaultUnionExtent()
                                throws IOException,
                                       AutomationException
The default union extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultUnionExtent in interface IRasterDefaultProps
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.

getDefaultIntersectExtent

public IEnvelope getDefaultIntersectExtent()
                                    throws IOException,
                                           AutomationException
The default intersect extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultIntersectExtent in interface IRasterDefaultProps
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.

getDefaultSpatialReference

public ISpatialReference getDefaultSpatialReference()
                                             throws IOException,
                                                    AutomationException
The default spatial reference.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultSpatialReference in interface IRasterDefaultProps
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.

resetToDefault

public void resetToDefault()
                    throws IOException,
                           AutomationException
Resets the raster to default state

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setPixelWidth

public void setPixelWidth(double width)
                   throws IOException,
                          AutomationException
The pixel width in ground resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPixelWidth

public double getPixelWidth()
                     throws IOException,
                            AutomationException
The pixel width in ground resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPixelWidth in interface IRasterAnalysisProps
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelHeight

public void setPixelHeight(double height)
                    throws IOException,
                           AutomationException
The pixel height in ground resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPixelHeight

public double getPixelHeight()
                      throws IOException,
                             AutomationException
The pixel height in ground resolution.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPixelHeight in interface IRasterAnalysisProps
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnalysisExtent

public IEnvelope getAnalysisExtent()
                            throws IOException,
                                   AutomationException
The analysis extent of the raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnalysisExtent in interface IRasterAnalysisProps
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.

setAnalysisExtentByRef

public void setAnalysisExtentByRef(IEnvelope ppExtent)
                            throws IOException,
                                   AutomationException
The analysis extent of the raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnalysisExtentByRef in interface IRasterAnalysisProps
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.

makePermanent

public void makePermanent()
                   throws IOException,
                          AutomationException
Makes a temporary raster a permanent raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
makePermanent in interface IRasterAnalysisProps
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.

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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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.