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

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

All Implemented Interfaces:

GPTool

public class FlowAccumulation
extends AbstractGPTool

Creates a raster of accumulated flow to each cell. The Flow Accumulation tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Flow Accumulation works

Software restrictions: none

Illustration:

Usage tips:

• The result of Flow Accumulation is a raster of accumulated flow to each cell, as determined by accumulating the weight for all cells that flow into each downslope cell.
• Cells of undefined flow direction will only receive flow; they will not contribute to any downstream flow. A cell is considered to have an undefined flow direction if its value in the is anything other than 1, 2, 4, 8, 16, 32, 64, or 128.
• The accumulated flow is based on the number of cells flowing into each cell in the output raster. The current processing cell is not considered in this accumulation.
• Output cells with a high flow accumulation are areas of concentrated flow and can be used to identify stream channels.
• Output cells with a flow accumulation of zero are local topographic highs and can be used to identify ridges.
• If the is not created with the FlowDirection command, there is a chance that the defined flow could loop. If the flow direction does loop, Flow Accumulation will go into an infinite loop and never finish.

Field Summary

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

vals

Constructor Summary

FlowAccumulation()
Creates the Flow Accumulation tool with defaults.

FlowAccumulation(Object inFlowDirectionRaster, Object outAccumulationRaster)
Creates the Flow Accumulation tool with the required parameters.

Method Summary

String	getDataType() Returns the Output data type 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	getOutAccumulationRaster() Returns the Output accumulation 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	setDataType(String dataType) Sets the Output data type 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	setOutAccumulationRaster(Object outAccumulationRaster) Sets the Output accumulation 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

FlowAccumulation

public FlowAccumulation()

Creates the Flow Accumulation tool with defaults.

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

FlowAccumulation

public FlowAccumulation(Object inFlowDirectionRaster,
                        Object outAccumulationRaster)

Creates the Flow Accumulation 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 - Composite Geodataset, this can be created with the Flow Direction function.

outAccumulationRaster - Raster Dataset, the output raster that shows the accumulated flow to each cell.

Method Detail

getInFlowDirectionRaster

public Object getInFlowDirectionRaster()

Returns the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this can be created with the Flow Direction function. 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 Composite Geodataset, this can be created with the Flow Direction function. This is a required parameter.

Parameters:

inFlowDirectionRaster - Composite Geodataset, this can be created with the Flow Direction function.

getOutAccumulationRaster

public Object getOutAccumulationRaster()

Returns the Output accumulation raster parameter of this tool . This parameter is Raster Dataset, the output raster that shows the accumulated flow to each cell. This is a required parameter.

Returns:

the Output accumulation raster

setOutAccumulationRaster

public void setOutAccumulationRaster(Object outAccumulationRaster)

Sets the Output accumulation raster parameter of this tool . This parameter is Raster Dataset, the output raster that shows the accumulated flow to each cell. This is a required parameter.

Parameters:

outAccumulationRaster - Raster Dataset, the output raster that shows the accumulated flow to each cell.

getInWeightRaster

public Object getInWeightRaster()

Returns the Input weight raster parameter of this tool . This parameter is Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one 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 Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one 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 - Composite Geodataset, if no {in_weight_raster} is specified, a default weight of one 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.

getDataType

public String getDataType()

Returns the Output data type parameter of this tool . This parameter is String, the output accumulation raster can be integer or floating point type. This is an optional parameter.

Returns:

the Output data type

setDataType

public void setDataType(String dataType)

Sets the Output data type parameter of this tool . This parameter is String, the output accumulation raster can be integer or floating point type. This is an optional parameter.

Parameters:

dataType - String, the output accumulation raster can be integer or floating point type.

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