SAGA-GIS Tool Library Documentation (v7.2.0)

Tool Flow Accumulation (Recursive)

Recursive upward processing of cells for calculation of flow accumulation and related parameters. This set of algorithms processes recursively all upwards connected cells until each cell of the DEM has been processed.

Flow routing methods provided by this tool:


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputElevationGrid (input)ELEVATION--
Sink Routes (*)Grid (optional input)SINKROUTE--
Weights (*)Grid (optional input)WEIGHTS--
Input for Mean over Catchment (*)Grid (optional input)VAL_INPUT--
Material for Accumulation (*)Grid (optional input)ACCU_MATERIAL--
Accumulation TargetGrid (input)ACCU_TARGET--
Target Areas (*)Grid (optional input)TARGETS--
OutputFlow AccumulationGrid (output)FLOW--
Mean over CatchmentGrid (output)VAL_MEAN--
Accumulated Material (*)Grid (optional output)ACCU_TOTAL--
Accumulated Material (Left Side) (*)Grid (optional output)ACCU_LEFT--
Accumulated Material (Right Side) (*)Grid (optional output)ACCU_RIGHT--
Flow Path Length (*)Grid (optional output)FLOW_LENGTHaverage distance that a cell's accumulated flow travelled-
Loss through Negative Weights (*)Grid (optional output)WEIGHT_LOSSwhen using weights without support for negative flow: output of the absolute amount of negative flow that occurred-
OptionsGrid systemGrid systemPARAMETERS_GRID_SYSTEM--
Flow Accumulation UnitChoiceFLOW_UNIT-Available Choices:
[0] number of cells
[1] cell area
Default: 1
MethodChoiceMETHOD-Available Choices:
[0] Deterministic 8
[1] Rho 8
[2] Deterministic Infinity
[3] Multiple Flow Direction
Default: 3
ConvergenceFloating pointCONVERGENCEConvergence factor for Multiple Flow Direction Algorithm (Freeman 1991)Minimum: 0.000000
Default: 1.100000
Prevent Negative Flow AccumulationBooleanNO_NEGATIVESwhen using weights: do not transport negative flow, set it to zero instead; useful e.g. when accumulating measures of water balance.Default: 1
(*) optional

Command-line

Usage: saga_cmd ta_hydrology 1 [-ELEVATION <str>] [-SINKROUTE <str>] [-WEIGHTS <str>] [-FLOW <str>] [-VAL_INPUT <str>] [-VAL_MEAN <str>] [-ACCU_MATERIAL <str>] [-ACCU_TARGET <str>] [-ACCU_TOTAL <str>] [-ACCU_LEFT <str>] [-ACCU_RIGHT <str>] [-FLOW_UNIT <str>] [-TARGETS <str>] [-FLOW_LENGTH <str>] [-WEIGHT_LOSS <str>] [-METHOD <str>] [-CONVERGENCE <double>] [-NO_NEGATIVES <str>]
  -ELEVATION:<str>     	Elevation
	Grid (input)
  -SINKROUTE:<str>     	Sink Routes
	Grid (optional input)
  -WEIGHTS:<str>       	Weights
	Grid (optional input)
  -FLOW:<str>          	Flow Accumulation
	Grid (output)
  -VAL_INPUT:<str>     	Input for Mean over Catchment
	Grid (optional input)
  -VAL_MEAN:<str>      	Mean over Catchment
	Grid (output)
  -ACCU_MATERIAL:<str> 	Material for Accumulation
	Grid (optional input)
  -ACCU_TARGET:<str>   	Accumulation Target
	Grid (input)
  -ACCU_TOTAL:<str>    	Accumulated Material
	Grid (optional output)
  -ACCU_LEFT:<str>     	Accumulated Material (Left Side)
	Grid (optional output)
  -ACCU_RIGHT:<str>    	Accumulated Material (Right Side)
	Grid (optional output)
  -FLOW_UNIT:<str>     	Flow Accumulation Unit
	Choice
	Available Choices:
	[0] number of cells
	[1] cell area
	Default: 1
  -TARGETS:<str>       	Target Areas
	Grid (optional input)
  -FLOW_LENGTH:<str>   	Flow Path Length
	Grid (optional output)
  -WEIGHT_LOSS:<str>   	Loss through Negative Weights
	Grid (optional output)
  -METHOD:<str>        	Method
	Choice
	Available Choices:
	[0] Deterministic 8
	[1] Rho 8
	[2] Deterministic Infinity
	[3] Multiple Flow Direction
	Default: 3
  -CONVERGENCE:<double>	Convergence
	Floating point
	Minimum: 0.000000
	Default: 1.100000
  -NO_NEGATIVES:<str>  	Prevent Negative Flow Accumulation
	Boolean
	Default: 1