com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CompositeBands

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.CompositeBands
All Implemented Interfaces:
GPTool

public class CompositeBands
extends AbstractGPTool

Creates a single raster dataset from multiple bands and can also create a subset of the bands. The Composite Bands tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CompositeBands()
          Creates the Composite Bands tool with defaults.
CompositeBands(Object inRasters, Object outRaster)
          Creates the Composite Bands tool with the required parameters.
 
Method Summary
 Object getInRasters()
          Returns the Input Rasters parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 void setInRasters(Object inRasters)
          Sets the Input Rasters parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output Raster parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompositeBands

public CompositeBands()
Creates the Composite Bands tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


CompositeBands

public CompositeBands(Object inRasters,
                      Object outRaster)
Creates the Composite Bands tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inRasters - Composite geodataset, the input raster datasets.
outRaster - Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality.
Method Detail

getInRasters

public Object getInRasters()
Returns the Input Rasters parameter of this tool . This parameter is Composite geodataset, the input raster datasets. This is a required parameter.

Returns:
the Input Rasters

setInRasters

public void setInRasters(Object inRasters)
Sets the Input Rasters parameter of this tool . This parameter is Composite geodataset, the input raster datasets. This is a required parameter.

Parameters:
inRasters - Composite geodataset, the input raster datasets.

getOutRaster

public Object getOutRaster()
Returns the Output Raster parameter of this tool . This parameter is Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality. This is a required parameter.

Returns:
the Output Raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output Raster parameter of this tool . This parameter is Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality. This is a required parameter.

Parameters:
outRaster - Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality.

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias