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=string range=integer

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

Example:

gs.run_command("r.gradient", output="name", direction="string", range=integer)

Parameters

Command linePython (grass.script)

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: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

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