r.prominence
Calculates Llobera's prominence index
r.prominence [-algrq] input=name output=name radius=integer [--verbose] [--quiet] [--qq] [--ui]
Example:
r.prominence input=name output=name radius=0
grass.script.parse_command("r.prominence", input, output, radius, flags=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.parse_command("r.prominence", input="name", output="name", radius=0)
grass.tools.Tools.r_prominence(input, output, radius, flags=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_prominence(input="name", output="name", radius=0)
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
input=name [required]
FP raster map for which to calculate index
output=name [required]
FP raster to store output
radius=integer [required]
Radius of neighbourhood in map cells
-a
Calculate absolute differences
-l
Local data normalisation
-g
Global data normalisation
-r
Use quadratic neighbourhood
-q
Disable on-screen progress display
--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
FP raster map for which to calculate index
Used as: input, hist, name
output : str, required
FP raster to store output
Used as: radius, name
radius : int, required
Radius of neighbourhood in map cells
flags : str, optional
Allowed values: a, l, g, r, q
a
Calculate absolute differences
l
Local data normalisation
g
Global data normalisation
r
Use quadratic neighbourhood
q
Disable on-screen progress display
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, required
FP raster map for which to calculate index
Used as: input, hist, name
output : str, required
FP raster to store output
Used as: radius, name
radius : int, required
Radius of neighbourhood in map cells
flags : str, optional
Allowed values: a, l, g, r, q
a
Calculate absolute differences
l
Local data normalisation
g
Global data normalisation
r
Use quadratic neighbourhood
q
Disable on-screen progress display
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 | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned.
DESCRIPTION
r.prominence calculates the average difference between a central cell and its neighbors. It approximated the terrain 'ruggedness' by looking at average differences in elev_lid792_1m within a given neighborhood The radius is specified in number of map rows/columns.
EXAMPLE
North Carolina sample region:
g.region raster=elev_lid792_1m
# get region rows/columns
g.region -g
# calculate prominence (radius of 50 map rows)
r.prominence input=elev_lid792_1m output=prominence radius=50
# visualize over shaded DEM
r.relief input=elev_lid792_1m output=elev_lid792_1m_shaded
d.mon wx0
d.shade shade=elev_lid792_1m_shaded color=prominence
AUTHOR
Benjamin Ducke (benjamin.ducke - oxfordarch.co.uk)
Update to GRASS GIS 7: Markus Neteler -
mundialis
SOURCE CODE
Available at: r.prominence source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819