Skip to content

r.pi.prox

Calculates correlation of two raster maps by calculating correlation function of two corresponding rectangular areas for each raster point and writing the result into a new raster map.

r.pi.prox [-a] input=name output=name keyval=integer method=string [min=integer] [max=integer] [title="phrase"] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.pi.prox input=name output=name keyval=integer method=string

grass.script.run_command("r.pi.prox", input, output, keyval, method, min=None, max=None, title=None, flags=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.pi.prox", input="name", output="name", keyval=integer, method="string")

Parameters

input=name [required]
    Name of input raster map
output=name [required]
    Name for output raster map
keyval=integer [required]
    Key value
method=string [required]
    Operation to perform on fragments
    Allowed values: proximity index, modified proximity index, neighborhood index
min=integer
    Minimum range for the operation measured by pixels, default 0
max=integer
    Maximum Range for the operation measured by pixels, default copmlete map
title="phrase"
    Title for resultant raster map
-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
output : str, required
    Name for output raster map
    Used as: output, raster, name
keyval : int, required
    Key value
method : str, required
    Operation to perform on fragments
    Allowed values: proximity index, modified proximity index, neighborhood index
min : int, optional
    Minimum range for the operation measured by pixels, default 0
max : int, optional
    Maximum Range for the operation measured by pixels, default copmlete map
title : str, optional
    Title for resultant raster map
    Used as: "phrase"
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: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

Calculates different proximity indices using defined buffer areas.

NOTES

...

EXAMPLE

An example for the North Carolina sample dataset:

g.region -d
...

SEE ALSO

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