com.esri.arcgis.datasourcesraster
Interface IRasterBand

All Superinterfaces:
Serializable
All Known Implementing Classes:
IRasterBandProxy, RasterBand

public interface IRasterBand
extends Serializable

Provides access to members that control a raster band object.

Remarks

IRasterBand interface provides access to statistics, histogram, raster attribute table, and colormap of the raster band.

The RasterDataset method returns a reference to the RasterDataset that contains this band.

The AttributeTable method returns a table if the raster band contains, or calculates a virtual table if the number of unique values of the raster band is less than 2048. The raster table can not be modified using ITable interface.

The ComputeStatsAndHist method calculates statistics and a histogram for the band.

The HasStatistics, HasHistogram, and HasColormap methods set the output parameter to True if the band contains a histogram, colormap, or statistics and False if the band does not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean canCopy()
          Returns true if this dataset can be copied.
 void computeStatsAndHist()
          Calculates statistics and histogram if not previously stored.
 IDataset copy(String copyName, IWorkspace copyWorkspace)
          Copies this raster band to a new dataset with the specified name.
 ITable getAttributeTable()
          The attribute table of this raster band.
 String getBandname()
          The name of this raster band.
 IRasterColormap getColormap()
          The colormap of this raster band.
 IContrastTable getContrastTable()
          The contrast look-up table of this band.
 IRasterHistogram getHistogram()
          The histogram of this raster band.
 IRasterDataset getRasterDataset()
          The RasterDataset associated with this raster band.
 IRasterStatistics getStatistics()
          The statistics of this raster band.
 void hasColormap(boolean[] b)
          Indicates if this band has a colormap.
 void hasStatistics(boolean[] b)
          Indicates if this band has statistics.
 void hasTable(boolean[] b)
          Indicates if this band has an attribute table.
 boolean isDirectlyOpened()
          Indicates if the band was opened directly.
 void setContrastTable(IContrastTable cont)
          The contrast look-up table of this band.
 

Method Detail

hasTable

void hasTable(boolean[] b)
              throws IOException,
                     AutomationException
Indicates if this band has an attribute table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
b - The b (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasStatistics

void hasStatistics(boolean[] b)
                   throws IOException,
                          AutomationException
Indicates if this band has statistics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
b - The b (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasColormap

void hasColormap(boolean[] b)
                 throws IOException,
                        AutomationException
Indicates if this band has a colormap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
b - The b (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatistics

IRasterStatistics getStatistics()
                                throws IOException,
                                       AutomationException
The statistics of this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterStatistics
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

computeStatsAndHist

void computeStatsAndHist()
                         throws IOException,
                                AutomationException
Calculates statistics and histogram if not previously stored.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHistogram

IRasterHistogram getHistogram()
                              throws IOException,
                                     AutomationException
The histogram of this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterHistogram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormap

IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException
The colormap of this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getAttributeTable

ITable getAttributeTable()
                         throws IOException,
                                AutomationException
The attribute table of this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getRasterDataset

IRasterDataset getRasterDataset()
                                throws IOException,
                                       AutomationException
The RasterDataset associated with this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getContrastTable

IContrastTable getContrastTable()
                                throws IOException,
                                       AutomationException
The contrast look-up table of this band.

Remarks

This method should not be used by application developers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IContrastTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContrastTable

void setContrastTable(IContrastTable cont)
                      throws IOException,
                             AutomationException
The contrast look-up table of this band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cont - A reference to a com.esri.arcgis.datasourcesraster.IContrastTable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

boolean canCopy()
                throws IOException,
                       AutomationException
Returns true if this dataset can be copied.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

IDataset copy(String copyName,
              IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException
Copies this raster band to a new dataset with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (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.

getBandname

String getBandname()
                   throws IOException,
                          AutomationException
The name of this raster band.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bandname
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirectlyOpened

boolean isDirectlyOpened()
                         throws IOException,
                                AutomationException
Indicates if the band was opened directly.

Remarks

This method should not be used by application developers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bDirectlyOpened
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.