Skip to content

r.pi.graph.dec

Graph Theory - successive criteria-based deletion of patches.

r.pi.graph.dec [-al] input=name [id=string] output=string keyval=integer distance=float neighborhood=string index=string choice=string [seed=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.graph.dec input=name output=string keyval=0 distance=0.0 neighborhood=nearest_neighbor index=connectance_index choice=smallest_first

grass.script.run_command("r.pi.graph.dec", input, id=None, output, keyval, distance, neighborhood, index, choice, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.pi.graph.dec", input="name", output="string", keyval=0, distance=0.0, neighborhood="nearest_neighbor", index="connectance_index", choice="smallest_first")

grass.tools.Tools.r_pi_graph_dec(input, id=None, output, keyval, distance, neighborhood, index, choice, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_pi_graph_dec(input="name", output="string", keyval=0, distance=0.0, neighborhood="nearest_neighbor", index="connectance_index", choice="smallest_first")

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
id=string
    Base name for the ID raster files
output=string [required]
    Name of the output ASCII file
keyval=integer [required]
    Key value
distance=float [required]
    Bounding distance [0 for maximum distance]
neighborhood=string [required]
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index=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
choice=string [required]
    Cluster index
    Allowed values: smallest_first, biggest_first, random, link_min, link_max
seed=integer
    Seed for the random number generation
-a
    Set for 8 cell-neighbors. 4 cell-neighbors are default
-l
    Set to perform deletion for the whole landscape rather than cluster-wise
--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 raster map
    Used as: input, raster, name
id : str, optional
    Base name for the ID raster files
    Used as: output, raster
output : str, required
    Name of the output ASCII file
    Used as: output
keyval : int, required
    Key value
distance : float, required
    Bounding distance [0 for maximum distance]
neighborhood : str, required
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index : 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
choice : str, required
    Cluster index
    Allowed values: smallest_first, biggest_first, random, link_min, link_max
seed : int, optional
    Seed for the random number generation
flags : str, optional
    Allowed values: a, l
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
    l
        Set to perform deletion for the whole landscape rather than cluster-wise
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 raster map
    Used as: input, raster, name
id : str | type(np.ndarray) | type(np.array) | type(gs.array.array), optional
    Base name for the ID raster files
    Used as: output, raster
output : str, required
    Name of the output ASCII file
    Used as: output
keyval : int, required
    Key value
distance : float, required
    Bounding distance [0 for maximum distance]
neighborhood : str, required
    Neighborhood definition
    Allowed values: nearest_neighbor, relative_neighbor, gabriel, spanning_tree
index : 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
choice : str, required
    Cluster index
    Allowed values: smallest_first, biggest_first, random, link_min, link_max
seed : int, optional
    Seed for the random number generation
flags : str, optional
    Allowed values: a, l
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
    l
        Set to perform deletion for the whole landscape rather than cluster-wise
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

Graph Theory - successive criteria-based deletion of patches.

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.pr, r.pi.graph.red, 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.dec source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819