Skip to content

r.hypso

Outputs a hypsometric and hypsographic graph.

r.hypso [-ab] map=name image=image [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.hypso map=name image=image

grass.script.run_command("r.hypso", map, image, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.hypso", map="name", image="image")

grass.tools.Tools.r_hypso(map, image, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_hypso(map="name", image="image")

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

Parameters

map=name [required]
    Name of input elevation raster map
image=image [required]
    Name for output graph file (png)
-a
    Generate hypsometric curve
-b
    Generate hypsographic curve
--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

map : str, required
    Name of input elevation raster map
    Used as: input, raster, name
image : str, required
    Name for output graph file (png)
    Used as: output, file, image
flags : str, optional
    Allowed values: a, b
    a
        Generate hypsometric curve
    b
        Generate hypsographic curve
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

map : str | np.ndarray, required
    Name of input elevation raster map
    Used as: input, raster, name
image : str, required
    Name for output graph file (png)
    Used as: output, file, image
flags : str, optional
    Allowed values: a, b
    a
        Generate hypsometric curve
    b
        Generate hypsographic curve
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 | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None will be returned.

DESCRIPTION

r.hypso produces the hypsometric and hypsographic curve related to a digital elevation model and prints the percentiles.

NOTES

The hypsographic curve gives the distribution of surfaces in different altitude ranges. Each point on the function reports on the y-axis the elevation and on the x-axis the portion of the basin surface placed above such elevation value. The hypsometric curve uses adimensional axes.

Flags

-a: generates hypsometric curve

-b: generates hyposographic curve

EXAMPLE

r.hypso -b map=elevation image=/tmp/hypso

generates hypsographic curve, and

r.hypso -a map=elevation image=/tmp/hypso

generates hypsometric curve.

Dependencies

  • Matplotlib

SEE ALSO

r.basin,

REFERENCES

Rodriguez-Iturbe I., Rinaldo A. — Fractal River Basins, Chance and Self-Organization. Cambridge Press (2001)

In Italian: Di Leo M., Di Stefano M., Claps P., Sole A. — Caratterizzazione morfometrica del bacino idrografico in GRASS GIS (Morphometric characterization of the catchment in GRASS GIS environment), Geomatics Workbooks, n. 9 (2010)

AUTHORS

Margherita Di Leo (grass-dev AT lists DOT osgeo DOT org), Massimo Di Stefano, Francesco Di Stefano

SOURCE CODE

Available at: r.hypso source code (history)
Latest change: Friday Feb 21 12:27:42 2025 in commit 8fce680