SAGA-GIS Tool Library Documentation (v6.2.0)

Tool Flow Accumulation (Top-Down)

Top-down processing of cells for calculation of flow accumulation and related parameters. This set of algorithms processes a DEM downwards from the highest to the lowest cell.

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--
Linear Flow Threshold Grid (*)Grid (optional input)LINEAR_VALoptional grid providing values to be compared with linear flow threshold instead of flow accumulation-
Channel Direction (*)Grid (optional input)LINEAR_DIRuse this for (linear) flow routing, if the value is a valid direction (0-7 = N, NE, E, SE, S, SW, W, NW)-
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--
StepIntegerSTEPFor testing purposes. Only generate flow at cells with step distance (each step row/column).Minimum: 1
Default: 1
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] Braunschweiger Reliefmodell
[3] Deterministic Infinity
[4] Multiple Flow Direction
[5] Multiple Triangular Flow Directon
[6] Multiple Maximum Downslope Gradient Based Flow Directon
Default: 4
Thresholded Linear FlowBooleanLINEAR_DOapply linear flow routing (D8) to all cells, having a flow accumulation greater than the specified thresholdDefault: 1
Linear Flow ThresholdIntegerLINEAR_MINflow accumulation threshold (cells) for linear flow routingMinimum: 0
Default: 500
ConvergenceFloating pointCONVERGENCEConvergence factor for Multiple Flow Direction Algorithm (Freeman 1991). Applies also to the Multiple Triangular Flow Directon Algorithm.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 0 [-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>] [-STEP <num>] [-FLOW_UNIT <str>] [-FLOW_LENGTH <str>] [-LINEAR_VAL <str>] [-LINEAR_DIR <str>] [-WEIGHT_LOSS <str>] [-METHOD <str>] [-LINEAR_DO <str>] [-LINEAR_MIN <num>] [-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)
  -STEP:<num>          	Step
	Integer
	Minimum: 1
	Default: 1
  -FLOW_UNIT:<str>     	Flow Accumulation Unit
	Choice
	Available Choices:
	[0] number of cells
	[1] cell area
	Default: 1
  -FLOW_LENGTH:<str>   	Flow Path Length
	Grid (optional output)
  -LINEAR_VAL:<str>    	Linear Flow Threshold Grid
	Grid (optional input)
  -LINEAR_DIR:<str>    	Channel Direction
	Grid (optional input)
  -WEIGHT_LOSS:<str>   	Loss through Negative Weights
	Grid (optional output)
  -METHOD:<str>        	Method
	Choice
	Available Choices:
	[0] Deterministic 8
	[1] Rho 8
	[2] Braunschweiger Reliefmodell
	[3] Deterministic Infinity
	[4] Multiple Flow Direction
	[5] Multiple Triangular Flow Directon
	[6] Multiple Maximum Downslope Gradient Based Flow Directon
	Default: 4
  -LINEAR_DO:<str>     	Thresholded Linear Flow
	Boolean
	Default: 1
  -LINEAR_MIN:<num>    	Linear Flow Threshold
	Integer
	Minimum: 0
	Default: 500
  -CONVERGENCE:<double>	Convergence
	Floating point
	Minimum: 0.000000
	Default: 1.100000
  -NO_NEGATIVES:<str>  	Prevent Negative Flow Accumulation
	Boolean
	Default: 1