Skip to content

r.pi.grow

Size and suitability based region growing.

r.pi.grow [-a] input=name [costmap=string] output=name keyval=integer area=integer method=string [seed=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.grow input=name output=name keyval=0 area=0 method=circular

grass.script.run_command("r.pi.grow", input, costmap=None, output, keyval, area, method, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.pi.grow", input="name", output="name", keyval=0, area=0, method="circular")

grass.tools.Tools.r_pi_grow(input, costmap=None, output, keyval, area, method, seed=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_pi_grow(input="name", output="name", keyval=0, area=0, method="circular")

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
costmap=string
    Name of the cost map raster file
output=name [required]
    Name for output raster map
keyval=integer [required]
    Key value
area=integer [required]
    Area to grow
method=string [required]
    Method of growth
    Allowed values: circular, random, costbased
seed=integer
    Random number generator seed
-a
    Set for 8 cell-neighbors. 4 cell-neighbors are default
--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
costmap : str, optional
    Name of the cost map raster file
    Used as: input, raster
output : str, required
    Name for output raster map
    Used as: output, raster, name
keyval : int, required
    Key value
area : int, required
    Area to grow
method : str, required
    Method of growth
    Allowed values: circular, random, costbased
seed : int, optional
    Random number generator seed
flags : str, optional
    Allowed values: a
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
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
costmap : str | np.ndarray, optional
    Name of the cost map raster file
    Used as: input, raster
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output raster map
    Used as: output, raster, name
keyval : int, required
    Key value
area : int, required
    Area to grow
method : str, required
    Method of growth
    Allowed values: circular, random, costbased
seed : int, optional
    Random number generator seed
flags : str, optional
    Allowed values: a
    a
        Set for 8 cell-neighbors. 4 cell-neighbors are default
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

Size and suitability based region growing.

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