Skip to content

r.green.hydro.closest

Move points to the closest vector map

r.green.hydro.closest points=name lines=name output=name max_dist=float [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.green.hydro.closest points=name lines=name output=name max_dist=10

grass.script.run_command("r.green.hydro.closest", points, lines, output, max_dist=10, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.green.hydro.closest", points="name", lines="name", output="name", max_dist=10)

grass.tools.Tools.r_green_hydro_closest(points, lines, output, max_dist=10, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_green_hydro_closest(points="name", lines="name", output="name", max_dist=10)

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

Parameters

points=name [required]
    Name of input vector map
    Or data source for direct OGR access
lines=name [required]
    Name of input vector map
    Or data source for direct OGR access
output=name [required]
    Name for output vector map
max_dist=float [required]
    Maximum distance from points to river
    Default: 10
--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

points : str, required
    Name of input vector map
    Or data source for direct OGR access
    Used as: input, vector, name
lines : str, required
    Name of input vector map
    Or data source for direct OGR access
    Used as: input, vector, name
output : str, required
    Name for output vector map
    Used as: output, vector, name
max_dist : float, required
    Maximum distance from points to river
    Default: 10
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

points : str, required
    Name of input vector map
    Or data source for direct OGR access
    Used as: input, vector, name
lines : str, required
    Name of input vector map
    Or data source for direct OGR access
    Used as: input, vector, name
output : str, required
    Name for output vector map
    Used as: output, vector, name
max_dist : float, required
    Maximum distance from points to river
    Default: 10
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

SEE ALSO

AUTHOR

Pietro Zambelli

SOURCE CODE

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