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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.Corridor

All Implemented Interfaces:

GPTool

public class Corridor
extends AbstractGPTool

Calculates the sum of accumulative costs for two input accumulative cost rasters. The Corridor tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Corridor works

Software restrictions: none

Usage tips:

• Any two floating-point rasters can be used for the input (for example, an accumulative cost raster), but both inputs should be the result of a global cost function.
• If the two input rasters were created from a global cost function and left unaltered, the output will always contain floating-point values.
• The order of input is irrelevant.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Corridor()
Creates the Corridor tool with defaults.

Corridor(Object inDistanceRaster1, Object inDistanceRaster2, Object outRaster)
Creates the Corridor tool with the required parameters.

Method Summary

Object	getInDistanceRaster1() Returns the Input cost distance raster 1 parameter of this tool .
Object	getInDistanceRaster2() Returns the Input cost distance raster 2 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	setInDistanceRaster1(Object inDistanceRaster1) Sets the Input cost distance raster 1 parameter of this tool .
void	setInDistanceRaster2(Object inDistanceRaster2) Sets the Input cost distance raster 2 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

Corridor

public Corridor()

Creates the Corridor tool with defaults.

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

Corridor

public Corridor(Object inDistanceRaster1,
                Object inDistanceRaster2,
                Object outRaster)

Creates the Corridor 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:

inDistanceRaster1 - Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function.

inDistanceRaster2 - Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInDistanceRaster1

public Object getInDistanceRaster1()

Returns the Input cost distance raster 1 parameter of this tool . This parameter is Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function. This is a required parameter.

Returns:

the Input cost distance raster 1

setInDistanceRaster1

public void setInDistanceRaster1(Object inDistanceRaster1)

Sets the Input cost distance raster 1 parameter of this tool . This parameter is Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function. This is a required parameter.

Parameters:

inDistanceRaster1 - Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function.

getInDistanceRaster2

public Object getInDistanceRaster2()

Returns the Input cost distance raster 2 parameter of this tool . This parameter is Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function. This is a required parameter.

Returns:

the Input cost distance raster 2

setInDistanceRaster2

public void setInDistanceRaster2(Object inDistanceRaster2)

Sets the Input cost distance raster 2 parameter of this tool . This parameter is Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function. This is a required parameter.

Parameters:

inDistanceRaster2 - Composite Geodataset, an input raster that was the output accumulated cost raster from a global cost function.

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