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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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 raster dataset using only a subset of bands. The Composite Bands tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool can also create a raster dataset containing subset of the original raster dataset bands. This is useful if you need to create a new raster dataset with a specific band combination and order.
• The order that the bands are listed in the Multi-value Input control box will determine the order of the bands in the output raster dataset.
• This tool can only output a square cell size.
• You can save your output to BIL, BIP, BMP, BSQ, DAT, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• The output raster dataset takes the cell size from the first raster band in the list.
• By default, the output raster dataset takes the extent and the spatial reference of the first raster band with a spatial reference in the list. You can change this by setting the output extent and output coordinate system in the Environment Settings.
• The following are some examples of why you would want to combine single raster datasets into multiband raster datasets:

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 - the input raster datasets.

outRaster - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, 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 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 the input raster datasets. This is a required parameter.

Parameters:

inRasters - the input raster datasets.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool . This parameter is the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, 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 the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Parameters:

outRaster - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, 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