Skip to content

r.richdem.terrainattribute

Calculates local terrain attributes.

r.richdem.terrainattribute input=name attribute=string [zscale=float] output=name [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.richdem.terrainattribute input=name attribute=slope_riserun output=name

grass.script.run_command("r.richdem.terrainattribute", input, attribute, zscale=1.0, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.richdem.terrainattribute", input="name", attribute="slope_riserun", output="name")

grass.tools.Tools.r_richdem_terrainattribute(input, attribute, zscale=1.0, output, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_richdem_terrainattribute(input="name", attribute="slope_riserun", 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
attribute=string [required]
    Terrain attribute to calculate.
    Allowed values: slope_riserun, slope_percentage, slope_degrees, slope_radians, aspect, curvature, planform_curvature, profile_curvature
zscale=float
    Scalar multiplier for elevation (vertical exaggeration)
    Default: 1.0
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
attribute : str, required
    Terrain attribute to calculate.
    Allowed values: slope_riserun, slope_percentage, slope_degrees, slope_radians, aspect, curvature, planform_curvature, profile_curvature
zscale : float, optional
    Scalar multiplier for elevation (vertical exaggeration)
    Default: 1.0
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
attribute : str, required
    Terrain attribute to calculate.
    Allowed values: slope_riserun, slope_percentage, slope_degrees, slope_radians, aspect, curvature, planform_curvature, profile_curvature
zscale : float, optional
    Scalar multiplier for elevation (vertical exaggeration)
    Default: 1.0
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

r.fill.dir

AUTHORS

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

SOURCE CODE

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