com.esri.arcgis.datasourcesraster
Interface IExtractBandFunctionArguments2

All Superinterfaces:

IExtractBandFunctionArguments, Serializable

All Known Implementing Classes:

ExtractBandFunctionArguments

public interface IExtractBandFunctionArguments2
extends IExtractBandFunctionArguments, Serializable

Provides access to members that control band extraction function argument(s).

Product Availability

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

Method Summary

IStringArray	getBandNames() The list of bands to be extracted by name.
IDoubleArray	getBandWavelengths() The list of bands to be extracted by mid wavelength values (in nanometers).
int	getMissingBandAction() Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.
double	getWavelengthMatchTolerance() The wavelength tolerance value in nanometers.
void	init(String sBandCombination) Initialize extract band arguments using the specified space- or semicolon-delimited band combination.
void	setBandNamesByRef(IStringArray ppBandNames) The list of bands to be extracted by name.
void	setBandWavelengthsByRef(IDoubleArray ppBandWavelengths) The list of bands to be extracted by mid wavelength values (in nanometers).
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.
void	setWavelengthMatchTolerance(double pWavelengthMatchTolerance) The wavelength tolerance value in nanometers.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IExtractBandFunctionArguments

getBandIDs, getRaster, setBandIDsByRef, setRasterByRef

Method Detail

init

void init(String sBandCombination)
          throws IOException,
                 AutomationException

Initialize extract band arguments using the specified space- or semicolon-delimited band combination.

Product Availability

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

Parameters:

sBandCombination - The sBandCombination (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMissingBandAction

int getMissingBandAction()
                         throws IOException,
                                AutomationException

Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMissingBandAction

void setMissingBandAction(int pMissingBandAction)
                          throws IOException,
                                 AutomationException

Indicates how the raster function behaves when a requested band (specified by index, name, or wavelength) is not found in the input raster.

Product Availability

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

Parameters:

pMissingBandAction - A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWavelengthMatchTolerance

double getWavelengthMatchTolerance()
                                   throws IOException,
                                          AutomationException

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Product Availability

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

Returns:

The pWavelengthMatchTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWavelengthMatchTolerance

void setWavelengthMatchTolerance(double pWavelengthMatchTolerance)
                                 throws IOException,
                                        AutomationException

The wavelength tolerance value in nanometers. For a raster band to be associated with a requested wavelength, the two wavelengths must lie within this tolerance.

Product Availability

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

Parameters:

pWavelengthMatchTolerance - The pWavelengthMatchTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandWavelengths

IDoubleArray getBandWavelengths()
                                throws IOException,
                                       AutomationException

The list of bands to be extracted by mid wavelength values (in nanometers). This property, when specified, overrides values in the 'BandIDs' property.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandWavelengthsByRef

void setBandWavelengthsByRef(IDoubleArray ppBandWavelengths)
                             throws IOException,
                                    AutomationException

The list of bands to be extracted by mid wavelength values (in nanometers). This property, when specified, overrides values in the 'BandIDs' property.

Product Availability

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

Parameters:

ppBandWavelengths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandNames

IStringArray getBandNames()
                          throws IOException,
                                 AutomationException

The list of bands to be extracted by name. This property, when specified, overrides values in the 'BandIDs' and the 'BandWavelengths' properties.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBandNamesByRef

void setBandNamesByRef(IStringArray ppBandNames)
                       throws IOException,
                              AutomationException

The list of bands to be extracted by name. This property, when specified, overrides values in the 'BandIDs' and the 'BandWavelengths' properties.

Product Availability

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

Parameters:

ppBandNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.