Skip to content

r.soillossbare

Calculates annual soil loss [t/(ha*a)] for bare soil. Use r.soillosscropland.py afterwards for grown soil.

r.soillossbare [-r] soillossbare=name flowaccmethod=name elevation=name resolution=float kfactor=name rfactor=name [fieldblock=name] [map=name] [flowacc=name] [constant_m=float] [constant_n=float] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.soillossbare soillossbare=name flowaccmethod=r.terraflow elevation=name resolution=2 kfactor=name rfactor=name

grass.script.run_command("r.soillossbare", soillossbare, flowaccmethod="r.terraflow", elevation, resolution="2", kfactor, rfactor, fieldblock=None, map=None, flowacc=None, constant_m="0.4", constant_n="1.3", flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.soillossbare", soillossbare="name", flowaccmethod="r.terraflow", elevation="name", resolution="2", kfactor="name", rfactor="name")

grass.tools.Tools.r_soillossbare(soillossbare, flowaccmethod="r.terraflow", elevation, resolution="2", kfactor, rfactor, fieldblock=None, map=None, flowacc=None, constant_m="0.4", constant_n="1.3", flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_soillossbare(soillossbare="name", flowaccmethod="r.terraflow", elevation="name", resolution="2", kfactor="name", rfactor="name")

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

Parameters

soillossbare=name [required]
    Output map (soilloss for ungrown soil)
flowaccmethod=name [required]
    Module for flowaccumulation calculation
    Allowed values: r.terraflow, r.flow, r.watershed
    Default: r.terraflow
elevation=name [required]
    Digital Elevation Model
resolution=float [required]
    Resolution of Digital Elevation Model (x y)
    Default: 2
kfactor=name [required]
    K-Factor (soil erodibility factor)
rfactor=name [required]
    R-Factor (rain erosivity factor)
fieldblock=name
    Fieldblock raster map with NULL/0-values as barrier
map=name
    Fieldblock vector map
flowacc=name
    Flowaccumulation raster map (instead of calculation)
constant_m=float
    RUSLE3D exponential m (0.2..0.6)
    Default: 0.4
constant_n=float
    RUSLE3D exponential n (1.2..1.6)
    Default: 1.3
-r
    Remove intermediate results
--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

soillossbare : str, required
    Output map (soilloss for ungrown soil)
    Used as: output, raster, name
flowaccmethod : str, required
    Module for flowaccumulation calculation
    Used as: name
    Allowed values: r.terraflow, r.flow, r.watershed
    Default: r.terraflow
elevation : str, required
    Digital Elevation Model
    Used as: input, raster, name
resolution : str, required
    Resolution of Digital Elevation Model (x y)
    Used as: float
    Default: 2
kfactor : str, required
    K-Factor (soil erodibility factor)
    Used as: input, raster, name
rfactor : str, required
    R-Factor (rain erosivity factor)
    Used as: input, raster, name
fieldblock : str, optional
    Fieldblock raster map with NULL/0-values as barrier
    Used as: input, raster, name
map : str, optional
    Fieldblock vector map
    Used as: input, vector, name
flowacc : str, optional
    Flowaccumulation raster map (instead of calculation)
    Used as: input, raster, name
constant_m : str, optional
    RUSLE3D exponential m (0.2..0.6)
    Used as: float
    Default: 0.4
constant_n : str, optional
    RUSLE3D exponential n (1.2..1.6)
    Used as: float
    Default: 1.3
flags : str, optional
    Allowed values: r
    r
        Remove intermediate results
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

soillossbare : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Output map (soilloss for ungrown soil)
    Used as: output, raster, name
flowaccmethod : str, required
    Module for flowaccumulation calculation
    Used as: name
    Allowed values: r.terraflow, r.flow, r.watershed
    Default: r.terraflow
elevation : str | np.ndarray, required
    Digital Elevation Model
    Used as: input, raster, name
resolution : str, required
    Resolution of Digital Elevation Model (x y)
    Used as: float
    Default: 2
kfactor : str | np.ndarray, required
    K-Factor (soil erodibility factor)
    Used as: input, raster, name
rfactor : str | np.ndarray, required
    R-Factor (rain erosivity factor)
    Used as: input, raster, name
fieldblock : str | np.ndarray, optional
    Fieldblock raster map with NULL/0-values as barrier
    Used as: input, raster, name
map : str, optional
    Fieldblock vector map
    Used as: input, vector, name
flowacc : str | np.ndarray, optional
    Flowaccumulation raster map (instead of calculation)
    Used as: input, raster, name
constant_m : str, optional
    RUSLE3D exponential m (0.2..0.6)
    Used as: float
    Default: 0.4
constant_n : str, optional
    RUSLE3D exponential n (1.2..1.6)
    Used as: float
    Default: 1.3
flags : str, optional
    Allowed values: r
    r
        Remove intermediate results
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.soillossbare calculates the annual soil loss [t/(ha*a)] for bare soil. Generates a "out_soillossbare" raster map and intermediate results.

Also use r.soillosscropland afterwards for grown soil.

REFERENCES

Mitasova H, Mitas L, 1999. Modeling soil detachment with RUSLE 3d using GIS. http://fatra.cnr.ncsu.edu/~hmitaso/gmslab/erosion/usle.html

SEE ALSO

r.soillosscropland

AUTHOR

Martin Zbinden

SOURCE CODE

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