r.pi.enn.pr
Patch relevance for Euclidean Nearest Neighbor patches.
r.pi.enn.pr [-a] input=name output=name keyval=integer method=string statmethod=string [title="phrase"] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
r.pi.enn.pr input=name output=name keyval=0 method=distance statmethod=sum
grass.script.run_command("r.pi.enn.pr", input, output, keyval, method, statmethod, title=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("r.pi.enn.pr", input="name", output="name", keyval=0, method="distance", statmethod="sum")
grass.tools.Tools.r_pi_enn_pr(input, output, keyval, method, statmethod, title=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.r_pi_enn_pr(input="name", output="name", keyval=0, method="distance", statmethod="sum")
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
keyval=integer [required]
Key value of patches in the input file
method=string [required]
Aspect of the nearest patch to use.
Allowed values: distance, area
statmethod=string [required]
Statistical method to perform on differences.
Allowed values: sum, average
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 of patches in the input file
method : str, required
Aspect of the nearest patch to use.
Allowed values: distance, area
statmethod : str, required
Statistical method to perform on differences.
Allowed values: sum, average
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: 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
keyval : int, required
Key value of patches in the input file
method : str, required
Aspect of the nearest patch to use.
Allowed values: distance, area
statmethod : str, required
Statistical method to perform on differences.
Allowed values: sum, average
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: 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
Patch relevance for Euclidean Nearest Neighbor patches.
r.pi.enn.pr computes distance and area differences for the first NN after removal of patch i.
NOTES
The keyval operator determines which category value is taken for the Patch Index analysis.
The method operators determine what measure is applied on the nth NN (area or distance).
Differences of distance/area after removal of patch i are provided as output as well as the amount of patches to be affected by its removal (percent) (PP) and the amount of area in these patches (PA - Percent Area)
EXAMPLE
An example for the North Carolina sample dataset:
Analysing the differences (average) in distance when patch i of class 5 is removed:
r.pi.enn.pr input=landclass96 output=dist_iter keyval=5 method=distance statmethod=average
SEE ALSO
r.pi.index, r.pi.enn, r.pi.fnn, r.pi.searchtime.pr, 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.enn.pr source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819