com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class Combine

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

public class Combine
extends AbstractGPTool

Combines multiple rasters so a unique output value is assigned to each unique combination of input values. The Combine tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Combine works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Combine()
          Creates the Combine tool with defaults.
Combine(Object inRasters, Object outRaster)
          Creates the Combine 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

Combine

public Combine()
Creates the Combine tool with defaults.

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


Combine

public Combine(Object inRasters,
               Object outRaster)
Creates the Combine 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 list of input rasters to be combined.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInRasters

public Object getInRasters()
Returns the Input rasters parameter of this tool . This parameter is Composite Geodataset, the list of input rasters to be combined. 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 list of input rasters to be combined. This is a required parameter.

Parameters:
inRasters - Composite Geodataset, the list of input rasters to be combined.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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, the raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

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