r.usler
Computes USLE R factor, Rainfall erosivity index.
r.usler input=name output=name method=string [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.usler input=name output=name method=morgan
grass.script.run_command("r.usler", input, output, method="morgan", overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.usler", input="name", output="name", method="morgan")
grass.tools.Tools.r_usler(input, output, method="morgan", overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_usler(input="name", output="name", method="morgan")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
input=name [required]
Name of annual precipitation raster map [mm/year]
output=name [required]
Name for output USLE R raster map [MJ.mm/ha.hr.year]
method=string [required]
Name of USLE R equation
Allowed values: roose, morgan, foster, elswaify
Default: morgan
roose: Roosle (1975)
morgan: Morgan (1974)
foster: Foster (1981)
elswaify: El-Swaify (1985)
--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
Name of annual precipitation raster map [mm/year]
Used as: input, raster, name
output : str, required
Name for output USLE R raster map [MJ.mm/ha.hr.year]
Used as: output, raster, name
method : str, required
Name of USLE R equation
Allowed values: roose, morgan, foster, elswaify
roose: Roosle (1975)
morgan: Morgan (1974)
foster: Foster (1981)
elswaify: El-Swaify (1985)
Default: morgan
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
Name of annual precipitation raster map [mm/year]
Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
Name for output USLE R raster map [MJ.mm/ha.hr.year]
Used as: output, raster, name
method : str, required
Name of USLE R equation
Allowed values: roose, morgan, foster, elswaify
roose: Roosle (1975)
morgan: Morgan (1974)
foster: Foster (1981)
elswaify: El-Swaify (1985)
Default: morgan
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
r.usler calculates USLE R factor for Rainfall erosivity. It enables several empirical equations: Roosle (1975), Morgan (1974), Foster(1981) and El-Swaify (1985).
NOTES
r.watershed provides for USLE L, S, LS factors.
EXAMPLE
TBD.
SEE ALSO
AUTHORS
Natialia Medvedeva, SIC-ISDC, Ashgabat, Turkmenistan
Yann Chemin, SIC-ISDC, Ashgabat, Turkmenistan
SOURCE CODE
Available at: r.usler source code
(history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f