Skip to content

r.pi.graph.red

Graph Theory - decreasing distance threshold option.

r.pi.graph.red [-a] input=name output=string keyval=integer distance=float step=float neighborhood=string index=string [,string,...] stats=string [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.graph.red input=name output=string keyval=0 distance=0.0 step=0.0 neighborhood=nearest_neighbor index=connectance_index stats=average

grass.script.run_command("r.pi.graph.red", input, output, keyval, distance, step, neighborhood, index, stats, flags=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.pi.graph.red", input="name", output="string", keyval=0, distance=0.0, step=0.0, neighborhood="nearest_neighbor", index="connectance_index", stats="average")

grass.tools.Tools.r_pi_graph_red(input, output, keyval, distance, step, neighborhood, index, stats, flags=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_pi_graph_red(input="name", output="string", keyval=0, distance=0.0, step=0.0, neighborhood="nearest_neighbor", index="connectance_index", stats="average")

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 raster map
output=string [required]
    Name of the output ASCII file
keyval=integer [required]
    Key value
distance=float [required]
    Distance at which to begin decreasing
step=float [required]
    Step to decrease the distance
neighborhood=string [required]
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index=string [,string,...] [required]
    Cluster index
    Allowed values: connectance_index, gyration_radius, cohesion_index, percent_patches, percent_area, number_patches, number_links, mean_patch_size, largest_patch_size, largest_patch_diameter, graph_diameter
stats=string [required]
    Statistical method to perform on the values
    Allowed values: average, median, variance, std_deviat, min, max
-a
    Set for 8 cell-neighbors. 4 cell-neighbors are default
--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 raster map
    Used as: input, raster, name
output : str, required
    Name of the output ASCII file
    Used as: output
keyval : int, required
    Key value
distance : float, required
    Distance at which to begin decreasing
step : float, required
    Step to decrease the distance
neighborhood : str, required
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index : str | list[str], required
    Cluster index
    Allowed values: connectance_index, gyration_radius, cohesion_index, percent_patches, percent_area, number_patches, number_links, mean_patch_size, largest_patch_size, largest_patch_diameter, graph_diameter
stats : str, required
    Statistical method to perform on the values
    Allowed values: average, median, variance, std_deviat, min, max
flags : str, optional
    Allowed values: a
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
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 raster map
    Used as: input, raster, name
output : str, required
    Name of the output ASCII file
    Used as: output
keyval : int, required
    Key value
distance : float, required
    Distance at which to begin decreasing
step : float, required
    Step to decrease the distance
neighborhood : str, required
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index : str | list[str], required
    Cluster index
    Allowed values: connectance_index, gyration_radius, cohesion_index, percent_patches, percent_area, number_patches, number_links, mean_patch_size, largest_patch_size, largest_patch_diameter, graph_diameter
stats : str, required
    Statistical method to perform on the values
    Allowed values: average, median, variance, std_deviat, min, max
flags : str, optional
    Allowed values: a
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
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

Graph Theory - decreasing distance threshold option.

NOTES

...

EXAMPLE

An example for the North Carolina sample dataset:

g.region -d
...

SEE ALSO

r.pi.corearea, r.pi.corr.mw, r.pi.csr.mw, r.pi.export, r.pi.graph, r.pi.graph.dec, r.pi.graph.pr, r.pi.grow, r.pi.import, r.pi.index, r.pi.lm, r.pi.odc, r.pi.prob.mw, r.pi.rectangle, r.pi

AUTHORS

Programming: Elshad Shirinov
Scientific concept: Dr. Martin Wegmann
Department of Remote Sensing
Remote Sensing and Biodiversity Unit
University of Wuerzburg, Germany

Port to GRASS GIS 7: Markus Metz

SOURCE CODE

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