Interface IRasterBandCollection
- Namespace
- ESRI.ArcGIS.DatasourcesRaster
- Assembly
- ESRI.Server.DatasourcesRaster.dll
Provides access to members that control a collection of RasterBands.
[Guid("7ACA3D10-0629-11D2-8D24-0000F8780535")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IRasterBandCollection
Remarks
IRasterBandCollection interface is used to manage and access a collection of raster bands of a RasterDataset or a Raster
The Add, Remove, Clear, AppendBand and AppenBands methods only applicable to IRasterBandCollection on a Raster, not on a RasterDataset.
When a band is added to or removed from a Raster object, the Raster recomputes a default cell size, extent, and spatial reference based on the bands in the Raster. If the user has not explicitly set these properties, the default settings will be applied to the raster object.
The spatial reference is determined first. If the user has not specified a spatial reference system to be applied to the raster, it is calculated from the first band in the raster that has a spatial reference other than unknown. If all bands have an unknown spatial reference, the spatial reference system of the raster will be unknown.
Next the cell size is calculated, if the cell size and number of rows and columns have not been specified by the user. The cell size is the maximum cell size of any input bands projected into the current spatial reference system. If no spatial reference system is known, the largest cell size of any band in the Raster is selected.
Finally, if the extent has not been specified by the user, it is calculated. The extent is the smallest bounding box with an integer number of rows and columns that can be placed around all bands of the input raster while aligning with the bottom-left corner of the Raster.
Properties
BandByName[string]
A RasterBand given its name.
IRasterBand BandByName[string Name] { get; }
Parameters
Namestring
Property Value
BandIndex[string]
The index of a RasterBand given its name.
int BandIndex[string Name] { get; }
Parameters
Namestring
Property Value
Bands
All the bands in the collection as an interface to the RasterBands enumerator object.
IEnumRasterBand Bands { get; }
Property Value
Count
The number of bands in the collection.
int Count { get; }
Property Value
Methods
Add(IRasterBand, int)
Adds a RasterBand to the band collection.
void Add(IRasterBand Element, int Index)
Parameters
ElementIRasterBandIndexint
Remarks
This method is only applicable to work with a Raster, not with a RasterDataset.
AppendBand(IRasterBand)
Appends a RasterBand to the band collection.
void AppendBand(IRasterBand Element)
Parameters
ElementIRasterBand
Remarks
This method is only applicable to work with a Raster, not with a RasterDataset.
AppendBands(IRasterBandCollection)
Appends a collection of RasterBands to the band collection.
void AppendBands(IRasterBandCollection Bands)
Parameters
BandsIRasterBandCollection
Remarks
This method is only applicable to work with a Raster, not with a RasterDataset.
Clear()
Removes all the elements in the collection.
void Clear()
Remarks
This method is only applicable to work with a Raster, not with a RasterDataset.
Item(int)
Returns a RasterBand given its index.
IRasterBand Item(int BandIndex)
Parameters
BandIndexint
Returns
Remove(int)
Removes an element from the collection.
void Remove(int Index)
Parameters
Indexint
Remarks
This method is only applicable to work with a Raster, not with a RasterDataset.
SaveAs(string, IWorkspace, string)
Creates a new persistent RasterDataset with the bands in the collection.
IDataset SaveAs(string new_name, IWorkspace worksp, string Format)
Parameters
new_namestringworkspIWorkspaceFormatstring
Returns
Remarks
The SaveAs method can create a raster dataset in Imagine, TIFF, GRID, JPEG2000, JPEG, BMP, GIF, PNG, PCI Raster, USGS ASCII DEM, X11 Pixmap, Memory Raster and geodatabase raster.
The format strings used for the supported formats are below, and they are case sensitive:
| Format Name | String Used |
|---|---|
| Imagine | "IMAGINE Image" |
| TIFF | "TIFF" |
| GRID | "GRID" |
| JPEG | "JPG" |
| JP2000 | "JP2" |
| BMP | "BMP" |
| PNG | "PNG" |
| GIF | "GIF" |
| PCI Raster | "PIX" |
| X11 Pixmap | "XPM" |
| PCRaster | "MAP" |
| Memory Raster | "MEM" |
| HDF4 | "HDF4" |
| BIL | "BIL" |
| BIP | "BIP" |
| BSQ | "BSQ" |
| Idrisi Raster Format | "RST" |
| ENVI Raster Format | "ENVI" |
| Geodatabase Raster | "GDB" |
The format string "TIFF" creates a TIFF file with ".tif" extension. ArcGIS also supports TIFF format with ".tiff" and ".tff" extensions. A format string "TIF" creates a TIFF file with ".tiff" extention and a format string "TFF" creates a TIFF file with ".tff" extension.
Note, SaveAs will return a RasterDataset, to prevent from SaveAs holding the output, .NET ReleaseCOMObject needs to be called to release the referene to the output raster dataset:
System.Runtime.InteropServices.Marshal.ReleaseComObject(outRasterDS);