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

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

All Implemented Interfaces:

GPTool

public class FlowLength
extends AbstractGPTool

Calculates the upstream or downstream distance, or weighted distance, along the flow path for each cell. The Flow Length tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The value type for the Flow Length output raster is floating point.
• A primary use of the Flow Length tool is to calculate the length of the longest flow path within a given basin. This measure is often used to calculate the time of concentration of a basin. This would be done using the UPSTREAM option.The tool can also be used to create distance-area diagrams of hypothetical rainfall and runoff events using the weight raster as an impedance to movement downslope.

Field Summary

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

vals

Constructor Summary

FlowLength()
Creates the Flow Length tool with defaults.

FlowLength(Object inFlowDirectionRaster, Object outRaster)
Creates the Flow Length tool with the required parameters.

Method Summary

String	getDirectionMeasurement() Returns the Direction of measurement parameter of this tool .
Object	getInFlowDirectionRaster() Returns the Input flow direction raster parameter of this tool .
Object	getInWeightRaster() Returns the Input weight raster 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	setDirectionMeasurement(String directionMeasurement) Sets the Direction of measurement parameter of this tool .
void	setInFlowDirectionRaster(Object inFlowDirectionRaster) Sets the Input flow direction raster parameter of this tool .
void	setInWeightRaster(Object inWeightRaster) Sets the Input weight raster 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

FlowLength

public FlowLength()

Creates the Flow Length tool with defaults.

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

FlowLength

public FlowLength(Object inFlowDirectionRaster,
                  Object outRaster)

Creates the Flow Length 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:

inFlowDirectionRaster - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.

outRaster - the output raster that shows for each cell the upstream or downstream distance along a flow path.

Method Detail

getInFlowDirectionRaster

public Object getInFlowDirectionRaster()

Returns the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Returns:

the Input flow direction raster

setInFlowDirectionRaster

public void setInFlowDirectionRaster(Object inFlowDirectionRaster)

Sets the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Parameters:

inFlowDirectionRaster - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster that shows for each cell the upstream or downstream distance along a flow path. 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 that shows for each cell the upstream or downstream distance along a flow path. This is a required parameter.

Parameters:

outRaster - the output raster that shows for each cell the upstream or downstream distance along a flow path.

getDirectionMeasurement

public String getDirectionMeasurement()

Returns the Direction of measurement parameter of this tool . This parameter is the direction of measurement along the flow path. This is an optional parameter.

Returns:

the Direction of measurement

setDirectionMeasurement

public void setDirectionMeasurement(String directionMeasurement)

Sets the Direction of measurement parameter of this tool . This parameter is the direction of measurement along the flow path. This is an optional parameter.

Parameters:

directionMeasurement - the direction of measurement along the flow path.

getInWeightRaster

public Object getInWeightRaster()

Returns the Input weight raster parameter of this tool . This parameter is an optional input raster for applying a weight to each cell. if no weight raster is specified, a default weight of 1 will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it. This is an optional parameter.

Returns:

the Input weight raster

setInWeightRaster

public void setInWeightRaster(Object inWeightRaster)

Sets the Input weight raster parameter of this tool . This parameter is an optional input raster for applying a weight to each cell. if no weight raster is specified, a default weight of 1 will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it. This is an optional parameter.

Parameters:

inWeightRaster - an optional input raster for applying a weight to each cell. if no weight raster is specified, a default weight of 1 will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it.

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