Skip to content

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=float cvmin=float resolution=float

grass.script.run_command("r.slopeunits.metrics", basin, demmap, slumapclean, cleansize=25000, areamin, cvmin, resolution, outfile=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.slopeunits.metrics", basin="name", demmap="name", slumapclean="name", cleansize=25000, areamin=float, cvmin=float, resolution=float)

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: 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.slopeunits.metrics creates metrics for slope units. Returns output "areamin, cvmin, v_fin and i_fin" to stdout, optionally writes to a file.

NOTES

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

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: Thursday Feb 20 13:02:26 2025 in commit 53de819