Skip to content

r.richdem.resolveflats

Directs flow from flat areas on depression-filled DEMs

r.richdem.resolveflats input=name output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.richdem.resolveflats input=name output=name

grass.script.run_command("r.richdem.resolveflats", input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.richdem.resolveflats", input="name", output="name")

grass.tools.Tools.r_richdem_resolveflats(input, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_richdem_resolveflats(input="name", 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 (most commonly with depressions filled)
    Name of input raster map
output=name [required]
    Output DEM with flats resolved for continuous flow
    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 (most commonly with depressions filled)
    Name of input raster map
    Used as: input, raster, name
output : str, required
    Output DEM with flats resolved for continuous flow
    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 (most commonly with depressions filled)
    Name of input raster map
    Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Output DEM with flats resolved for continuous flow
    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.

Raises:

grass.tools.ToolError: When the tool ended with an error.

DESCRIPTION

PLACEHOLDER

REFERENCES

PLACEHOLDER

SEE ALSO

r.fill.dir

AUTHORS

Richard Barnes (algorithm and codebase), Andrew D. Wickert (GRASS frontend)

SOURCE CODE

Available at: r.richdem.resolveflats source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819