r.richdem.flowaccumulation
Calculates flow accumulation via one of a variety of methods.
r.richdem.flowaccumulation input=name [weights=name] method=string [exponent=float] output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.richdem.flowaccumulation input=name method=Dinf output=name
grass.script.run_command("r.richdem.flowaccumulation", input, weights=None, method, exponent=None, output, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.richdem.flowaccumulation", input="name", method="Dinf", output="name")
grass.tools.Tools.r_richdem_flowaccumulation(input, weights=None, method, exponent=None, output, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_richdem_flowaccumulation(input="name", method="Dinf", output="name")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
input=name [required]
Input DEM
Name of input raster map
weights=name
Raster defining the amount of runoff per cell
Name of input raster map
method=string [required]
Method to compute the flow routing.
Allowed values: Dinf, Quinn, Holmgren, Freeman, Rho8, Rho4, D8, D4
exponent=float
Exponent required for Holmgren and Freeman methods
output=name [required]
Output DEM with depressions filled
Name for output raster map
--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
input : str, required
Input DEM
Name of input raster map
Used as: input, raster, name
weights : str, optional
Raster defining the amount of runoff per cell
Name of input raster map
Used as: input, raster, name
method : str, required
Method to compute the flow routing.
Allowed values: Dinf, Quinn, Holmgren, Freeman, Rho8, Rho4, D8, D4
exponent : float, optional
Exponent required for Holmgren and Freeman methods
output : str, required
Output DEM with depressions filled
Name for output raster map
Used as: output, raster, name
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
input : str | np.ndarray, required
Input DEM
Name of input raster map
Used as: input, raster, name
weights : str | np.ndarray, optional
Raster defining the amount of runoff per cell
Name of input raster map
Used as: input, raster, name
method : str, required
Method to compute the flow routing.
Allowed values: Dinf, Quinn, Holmgren, Freeman, Rho8, Rho4, D8, D4
exponent : float, optional
Exponent required for Holmgren and Freeman methods
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
Output DEM with depressions filled
Name for output raster map
Used as: output, raster, name
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
Returns:
result : grass.tools.support.ToolResult | np.ndarray | tuple[np.ndarray] | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned. If an array type (e.g., np.ndarray) is used for one of the raster outputs, the result will be an array and will have the shape corresponding to the computational region. If an array type is used for more than one raster output, the result will be a tuple of arrays.
DESCRIPTION
PLACEHOLDER
REFERENCES
PLACEHOLDER
SEE ALSO
AUTHORS
Richard Barnes (algorithm and codebase), Andrew D. Wickert (GRASS frontend)
SOURCE CODE
Available at: r.richdem.flowaccumulation source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819