Skip to content

r.gradient

Create a gradient map

r.gradient output=name direction=string range=integer [,integer,...] [percentile=float] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.gradient output=name direction=N-S range=0

grass.script.run_command("r.gradient", output, direction, range, percentile=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.gradient", output="name", direction="N-S", range=0)

grass.tools.Tools.r_gradient(output, direction, range, percentile=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_gradient(output="name", direction="N-S", range=0)

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

output=name [required]
    Name for output raster map
direction=string [required]
    The direction of gradient
    Allowed values: N-S, S-N, W-E, E-W, NW-SE, NE-SW
range=integer [,integer,...] [required]
    Minimum and maximum values of gradient
percentile=float
    Percentile to calculate (only for oblique gradient)
    Allowed values: 0-100
--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

output : str, required
    Name for output raster map
    Used as: output, raster, name
direction : str, required
    The direction of gradient
    Allowed values: N-S, S-N, W-E, E-W, NW-SE, NE-SW
range : int | list[int] | str, required
    Minimum and maximum values of gradient
percentile : float, optional
    Percentile to calculate (only for oblique gradient)
    Allowed values: 0-100
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

output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output raster map
    Used as: output, raster, name
direction : str, required
    The direction of gradient
    Allowed values: N-S, S-N, W-E, E-W, NW-SE, NE-SW
range : int | list[int] | str, required
    Minimum and maximum values of gradient
percentile : float, optional
    Percentile to calculate (only for oblique gradient)
    Allowed values: 0-100
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

r.gradient create a gradient map. It is able to create horizontal, vertical and oblique gradient.

EXAMPLES

To calculate vertical gradient from North to South

  r.gradient output=gradient_ns range=0,50 direction=N-S

To calculate horizontal gradient from East to West

  r.gradient output=gradient_ea range=10,20 direction=E-W

To calculate oblique gradient from North-East to South-West you have to set also the percentile option to set the slope of the gradient.

  r.gradient output=gradient_oblique range=10,20 direction=NE-SW

AUTHORS

Luca Delucchi, Fondazione E. Mach (Italy)

Thanks to Johannes Radinger for the code of horizontal and vertical gradient

SOURCE CODE

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