r.slopeunits.metrics
Create metrics for slope units
r.slopeunits.metrics basin=name demmap=name slumapclean=name cleansize=float areamin=float cvmin=float resolution=float [outfile=name] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.slopeunits.metrics basin=name demmap=name slumapclean=name cleansize=25000 areamin=0.0 cvmin=0.0 resolution=0.0
grass.script.run_command("r.slopeunits.metrics", basin, demmap, slumapclean, cleansize=25000, areamin, cvmin, resolution, outfile=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.slopeunits.metrics", basin="name", demmap="name", slumapclean="name", cleansize=25000, areamin=0.0, cvmin=0.0, resolution=0.0)
grass.tools.Tools.r_slopeunits_metrics(basin, demmap, slumapclean, cleansize=25000, areamin, cvmin, resolution, outfile=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_slopeunits_metrics(basin="name", demmap="name", slumapclean="name", cleansize=25000, areamin=0.0, cvmin=0.0, resolution=0.0)
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
basin=name [required]
Name of input vector map
Input basin
demmap=name [required]
Input digital elevation model
slumapclean=name [required]
Output Slope Units layer, cleaned (the main output)
cleansize=float [required]
Slope Units size to be removed
Default: 25000
areamin=float [required]
Minimum area (m^2) below which the slope unit is not further segmented
cvmin=float [required]
Minimum value of the circular variance (0.0-1.0) below which the slope unit is not further segmented
resolution=float [required]
Resolution
outfile=name
Output file with metrics
--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
basin : str, required
Name of input vector map
Input basin
Used as: input, vector, name
demmap : str, required
Input digital elevation model
Used as: input, raster, name
slumapclean : str, required
Output Slope Units layer, cleaned (the main output)
Used as: output, raster, name
cleansize : float, required
Slope Units size to be removed
Default: 25000
areamin : float, required
Minimum area (m^2) below which the slope unit is not further segmented
cvmin : float, required
Minimum value of the circular variance (0.0-1.0) below which the slope unit is not further segmented
resolution : float, required
Resolution
outfile : str, optional
Output file with metrics
Used as: output, file, 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
basin : str, required
Name of input vector map
Input basin
Used as: input, vector, name
demmap : str | np.ndarray, required
Input digital elevation model
Used as: input, raster, name
slumapclean : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
Output Slope Units layer, cleaned (the main output)
Used as: output, raster, name
cleansize : float, required
Slope Units size to be removed
Default: 25000
areamin : float, required
Minimum area (m^2) below which the slope unit is not further segmented
cvmin : float, required
Minimum value of the circular variance (0.0-1.0) below which the slope unit is not further segmented
resolution : float, required
Resolution
outfile : str, optional
Output file with metrics
Used as: output, file, 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
r.slopeunits.metrics creates metrics for slope units. Returns output "areamin, cvmin, v_fin and i_fin" to stdout, optionally writes to a file.
EXAMPLE
r.slopeunits.metrics \
basin=basin_chk \
demmap=dem_italia_isolegrandi@su_test \
slumapclean=su_tmp_cl \
cleansize=25000 \
areamin=50000.0 \
cvmin=0.05 \
resolution=625 \
outfile=objf_1.dat
REFERENCES
- Alvioli, M., Marchesini, I., Reichenbach, P., Rossi, M., Ardizzone, F., Fiorucci, F., and Guzzetti, F. (2016): Automatic delineation of geomorphological slope units with r.slopeunits v1.0 and their optimization for landslide susceptibility modeling, Geosci. Model Dev., 9, 3975-3991. DOI:10.5194/gmd-9-3975-2016
- Alvioli, M., Guzzetti, F., & Marchesini, I. (2020): Parameter-free delineation of slope units and terrain subdivision of Italy. Geomorphology, 358, 107124. DOI:10.1016/j.geomorph.2020.107124
SEE ALSO
r.slopeunits.create, r.slopeunits.clean, r.slopeunits.optimize
AUTHORS
Main authors: Ivan Marchesini, Massimiliano Alvioli, CNR-IRPI
Carmen Tawalika (translation to python),
mundialis
SOURCE CODE
Available at: r.slopeunits.metrics source code
(history)
Latest change: Wednesday May 07 16:16:50 2025 in commit 8af96b6