Skip to content

r.pi.prob.mw

Probability analysis of 2 random points being in the same patch.

r.pi.prob.mw [-p] input=name output=name [mask=string] keyval=integer n=integer [size=integer] [distance=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.prob.mw input=name output=name keyval=0 n=0

grass.script.run_command("r.pi.prob.mw", input, output, mask=None, keyval, n, size=None, distance=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("r.pi.prob.mw", input="name", output="name", keyval=0, n=0)

grass.tools.Tools.r_pi_prob_mw(input, output, mask=None, keyval, n, size=None, distance=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.r_pi_prob_mw(input="name", output="name", keyval=0, n=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 raster map
output=name [required]
    Name for output raster map
mask=string
    Name of the mask raster file
keyval=integer [required]
    Category value of the patches
n=integer [required]
    Number of tests
size=integer
    Size of the output matrix
distance=integer
    Maximum distance at which two patches are seen as one
-p
    Patch only flag. When set only places test-points in patches
--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
output : str, required
    Name for output raster map
    Used as: output, raster, name
mask : str, optional
    Name of the mask raster file
    Used as: input, raster
keyval : int, required
    Category value of the patches
n : int, required
    Number of tests
size : int, optional
    Size of the output matrix
distance : int, optional
    Maximum distance at which two patches are seen as one
flags : str, optional
    Allowed values: p
    p
        Patch only flag. When set only places test-points in patches
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
output : str | type(np.ndarray) | type(np.array) | type(gs.array.array), required
    Name for output raster map
    Used as: output, raster, name
mask : str | np.ndarray, optional
    Name of the mask raster file
    Used as: input, raster
keyval : int, required
    Category value of the patches
n : int, required
    Number of tests
size : int, optional
    Size of the output matrix
distance : int, optional
    Maximum distance at which two patches are seen as one
flags : str, optional
    Allowed values: p
    p
        Patch only flag. When set only places test-points in patches
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

Probability analysis of 2 random points being in the same patch.

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.grow, r.pi.import, r.pi.index, r.pi.lm, r.pi.odc, 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.prob.mw source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819