Skip to content

r.wateroutlet.lessmem

Creates watershed basins from a drainage direction map.

r.wateroutlet.lessmem input=name output=name coordinates=east,north [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.wateroutlet.lessmem input=name output=name coordinates=0.0

grass.script.run_command("r.wateroutlet.lessmem", input, output, coordinates, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.wateroutlet.lessmem", input="name", output="name", coordinates=0.0)

grass.tools.Tools.r_wateroutlet_lessmem(input, output, coordinates, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_wateroutlet_lessmem(input="name", output="name", coordinates=0.0)

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 input drainage direction map
output=name [required]
    Name for output watershed basin map
coordinates=east,north [required]
    Coordinates of outlet point
--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 input drainage direction map
    Used as: input, raster, name
output : str, required
    Name for output watershed basin map
    Used as: output, raster, name
coordinates : tuple[float, float] | list[float] | str, required
    Coordinates of outlet point
    Used as: input, coords, east,north
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 input drainage direction map
    Used as: input, raster, name
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output watershed basin map
    Used as: output, raster, name
coordinates : tuple[float, float] | list[float] | str, required
    Coordinates of outlet point
    Used as: input, coords, east,north
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.wateroutlet.lessmem is a modified version of r.water.outlet and requires about one third of memory compared to the original module. Input drainage direction information is stored as 4-bit segments in the buffer and output basin result is stored as 1-bit data. Because of heavy bitwise operations, there may be some performance penalty depending on the size of the input map. Other than memory management, this module uses the same interface and algorithm in r.water.outlet, so please refer to r.water.outlet for more details.

SEE ALSO

r.water.outlet

AUTHOR

Huidae Cho
based on r.water.outlet

SOURCE CODE

Available at: r.wateroutlet.lessmem source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819