com.esri.arcgis.datasourcesraster
Interface INDVIFunctionArguments2

All Superinterfaces:

INDVIFunctionArguments, Serializable

All Known Implementing Classes:

NDVIFunctionArguments

public interface INDVIFunctionArguments2
extends INDVIFunctionArguments, Serializable

Provides access to members that control NDVI function arguments.

Product Availability

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

Method Summary

String	getInfraredBandName() Infrared band name.
double	getInfraredBandWavelength() Infrared band wavelength.
int	getMissingBandAction() Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.
String	getVisibleBandName() Visible band name.
double	getVisibleBandWavelength() Visible band wavelength.
double	getWavelengthMatchTolerance() The wavelength tolerance value in nanometers.
void	setInfraredBandName(String pInfraredBandName) Infrared band name.
void	setInfraredBandWavelength(double pInfraredBandWavelength) Infrared band wavelength.
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster function behaves when a request band (specified by index, name, or wavelength) is not found in the input raster.
void	setVisibleBandName(String pVisibleBandName) Visible band name.
void	setVisibleBandWavelength(double pVisibleBandWavelength) Visible band wavelength.
void	setWavelengthMatchTolerance(double pWavelengthMatchTolerance) The wavelength tolerance value in nanometers.

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

getInfraredBandID, getRaster, getVisibleBandID, setInfraredBandID, setRasterByRef, setVisibleBandID

Method Detail

getMissingBandAction

int getMissingBandAction()
                         throws IOException,
                                AutomationException

Indicates how the raster function behaves when a request 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 request 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.

getVisibleBandName

String getVisibleBandName()
                          throws IOException,
                                 AutomationException

Visible band name.

Product Availability

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

Returns:

The pVisibleBandName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleBandName

void setVisibleBandName(String pVisibleBandName)
                        throws IOException,
                               AutomationException

Visible band name.

Product Availability

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

Parameters:

pVisibleBandName - The pVisibleBandName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInfraredBandName

String getInfraredBandName()
                           throws IOException,
                                  AutomationException

Infrared band name.

Product Availability

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

Returns:

The pInfraredBandName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInfraredBandName

void setInfraredBandName(String pInfraredBandName)
                         throws IOException,
                                AutomationException

Infrared band name.

Product Availability

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

Parameters:

pInfraredBandName - The pInfraredBandName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibleBandWavelength

double getVisibleBandWavelength()
                                throws IOException,
                                       AutomationException

Visible band wavelength.

Product Availability

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

Returns:

The pVisibleBandWavelength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleBandWavelength

void setVisibleBandWavelength(double pVisibleBandWavelength)
                              throws IOException,
                                     AutomationException

Visible band wavelength.

Product Availability

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

Parameters:

pVisibleBandWavelength - The pVisibleBandWavelength (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInfraredBandWavelength

double getInfraredBandWavelength()
                                 throws IOException,
                                        AutomationException

Infrared band wavelength.

Product Availability

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

Returns:

The pInfraredBandWavelength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInfraredBandWavelength

void setInfraredBandWavelength(double pInfraredBandWavelength)
                               throws IOException,
                                      AutomationException

Infrared band wavelength.

Product Availability

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

Parameters:

pInfraredBandWavelength - The pInfraredBandWavelength (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.