From e76c325998c8cd9053ce012a5adbb79f33ab0779 Mon Sep 17 00:00:00 2001 From: Markus Neteler Date: Tue, 19 Sep 2023 09:59:22 +0200 Subject: [PATCH] r.pi manual: completion of submodule list and HTML fixes (#940) - fix citation - fix HTML header - add missing keywords --- src/raster/r.pi/r.pi.corearea/main.c | 2 + src/raster/r.pi/r.pi.corr.mw/main.c | 2 + src/raster/r.pi/r.pi.csr.mw/main.c | 2 + src/raster/r.pi/r.pi.energy.pr/main.c | 2 + src/raster/r.pi/r.pi.energy/main.c | 2 + src/raster/r.pi/r.pi.enn.pr/main.c | 2 + src/raster/r.pi/r.pi.enn/main.c | 2 + src/raster/r.pi/r.pi.export/main.c | 2 + src/raster/r.pi/r.pi.fnn/main.c | 2 + src/raster/r.pi/r.pi.graph.dec/main.c | 2 + src/raster/r.pi/r.pi.graph.pr/main.c | 2 + src/raster/r.pi/r.pi.graph.red/main.c | 2 + src/raster/r.pi/r.pi.graph/main.c | 2 + src/raster/r.pi/r.pi.grow/main.c | 2 + src/raster/r.pi/r.pi.html | 90 +++++++++-------------- src/raster/r.pi/r.pi.import/main.c | 2 + src/raster/r.pi/r.pi.index/main.c | 2 + src/raster/r.pi/r.pi.lm/main.c | 3 + src/raster/r.pi/r.pi.neigh/main.c | 2 + src/raster/r.pi/r.pi.nlm.circ/main.c | 2 + src/raster/r.pi/r.pi.nlm.stats/main.c | 2 + src/raster/r.pi/r.pi.nlm/main.c | 2 + src/raster/r.pi/r.pi.odc/main.c | 2 + src/raster/r.pi/r.pi.prob.mw/main.c | 2 + src/raster/r.pi/r.pi.prox/main.c | 2 + src/raster/r.pi/r.pi.rectangle/main.c | 2 + src/raster/r.pi/r.pi.searchtime.mw/main.c | 2 + src/raster/r.pi/r.pi.searchtime.pr/main.c | 2 + src/raster/r.pi/r.pi.searchtime/main.c | 2 + 29 files changed, 92 insertions(+), 55 deletions(-) diff --git a/src/raster/r.pi/r.pi.corearea/main.c b/src/raster/r.pi/r.pi.corearea/main.c index e64123f748..1455682db5 100644 --- a/src/raster/r.pi/r.pi.corearea/main.c +++ b/src/raster/r.pi/r.pi.corearea/main.c @@ -87,6 +87,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("core area analysis")); module->description = _("Variable edge effects and core area analysis"); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.corr.mw/main.c b/src/raster/r.pi/r.pi.corr.mw/main.c index 293a5039c2..103a307984 100644 --- a/src/raster/r.pi/r.pi.corr.mw/main.c +++ b/src/raster/r.pi/r.pi.corr.mw/main.c @@ -54,6 +54,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("correlation analysis")); module->description = _("Moving window correlation analysis."); parm.input1 = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.csr.mw/main.c b/src/raster/r.pi/r.pi.csr.mw/main.c index 01fdc28096..2a04c319c7 100644 --- a/src/raster/r.pi/r.pi.csr.mw/main.c +++ b/src/raster/r.pi/r.pi.csr.mw/main.c @@ -77,6 +77,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("complete spatial randomness")); module->description = _("Complete Spatial Randomness analysis on moving window."); diff --git a/src/raster/r.pi/r.pi.energy.pr/main.c b/src/raster/r.pi/r.pi.energy.pr/main.c index fd4a8137fe..f36a99639a 100644 --- a/src/raster/r.pi/r.pi.energy.pr/main.c +++ b/src/raster/r.pi/r.pi.energy.pr/main.c @@ -111,6 +111,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Individual-based dispersal model for connectivity analysis (energy " "based) using iterative patch removal."); diff --git a/src/raster/r.pi/r.pi.energy/main.c b/src/raster/r.pi/r.pi.energy/main.c index 67cecd6040..f950827009 100644 --- a/src/raster/r.pi/r.pi.energy/main.c +++ b/src/raster/r.pi/r.pi.energy/main.c @@ -75,6 +75,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Individual-based dispersal model for connectivity " "analysis - energy based."); diff --git a/src/raster/r.pi/r.pi.enn.pr/main.c b/src/raster/r.pi/r.pi.enn.pr/main.c index 7ea4cb2ed6..9924e2fd5b 100644 --- a/src/raster/r.pi/r.pi.enn.pr/main.c +++ b/src/raster/r.pi/r.pi.enn.pr/main.c @@ -89,6 +89,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("patch index")); module->description = _("Patch relevance for Euclidean Nearest Neighbor patches."); diff --git a/src/raster/r.pi/r.pi.enn/main.c b/src/raster/r.pi/r.pi.enn/main.c index 96d5e517ab..5bdde4ad7f 100644 --- a/src/raster/r.pi/r.pi.enn/main.c +++ b/src/raster/r.pi/r.pi.enn/main.c @@ -104,6 +104,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("patch index")); module->description = _("Analysis of n-th Euclidean Nearest Neighbor distance."); diff --git a/src/raster/r.pi/r.pi.export/main.c b/src/raster/r.pi/r.pi.export/main.c index 91bf62212f..83b58d145a 100644 --- a/src/raster/r.pi/r.pi.export/main.c +++ b/src/raster/r.pi/r.pi.export/main.c @@ -88,6 +88,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("patch index")); module->description = _("Export of patch based information."); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.fnn/main.c b/src/raster/r.pi/r.pi.fnn/main.c index 6ae9c35d1f..227e162d3c 100644 --- a/src/raster/r.pi/r.pi.fnn/main.c +++ b/src/raster/r.pi/r.pi.fnn/main.c @@ -108,6 +108,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("patch index")); module->description = _("Determines patches of given value and performs " "a nearest-neighbor analysis."); diff --git a/src/raster/r.pi/r.pi.graph.dec/main.c b/src/raster/r.pi/r.pi.graph.dec/main.c index c8c73e7446..1f176ae5f6 100644 --- a/src/raster/r.pi/r.pi.graph.dec/main.c +++ b/src/raster/r.pi/r.pi.graph.dec/main.c @@ -137,6 +137,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Graph Theory - successive criteria-based deletion of patches."); diff --git a/src/raster/r.pi/r.pi.graph.pr/main.c b/src/raster/r.pi/r.pi.graph.pr/main.c index 5807e7e0f8..476ee26bc7 100644 --- a/src/raster/r.pi/r.pi.graph.pr/main.c +++ b/src/raster/r.pi/r.pi.graph.pr/main.c @@ -122,6 +122,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Graph Theory - iterative removal (patch relevance analysis)."); diff --git a/src/raster/r.pi/r.pi.graph.red/main.c b/src/raster/r.pi/r.pi.graph.red/main.c index 04ed4908c8..e105310fbf 100644 --- a/src/raster/r.pi/r.pi.graph.red/main.c +++ b/src/raster/r.pi/r.pi.graph.red/main.c @@ -134,6 +134,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Graph Theory - decreasing distance threshold option."); diff --git a/src/raster/r.pi/r.pi.graph/main.c b/src/raster/r.pi/r.pi.graph/main.c index b3d0b01075..ca1831f296 100644 --- a/src/raster/r.pi/r.pi.graph/main.c +++ b/src/raster/r.pi/r.pi.graph/main.c @@ -111,6 +111,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Graph Theory for connectivity analysis."); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.grow/main.c b/src/raster/r.pi/r.pi.grow/main.c index e72986fc63..d14d026f8f 100644 --- a/src/raster/r.pi/r.pi.grow/main.c +++ b/src/raster/r.pi/r.pi.grow/main.c @@ -73,6 +73,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("region growing")); module->description = _("Size and suitability based region growing."); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.html b/src/raster/r.pi/r.pi.html index 88dbfc9bfb..b4831c8249 100644 --- a/src/raster/r.pi/r.pi.html +++ b/src/raster/r.pi/r.pi.html @@ -1,3 +1,10 @@ + + + +

KEYWORDS

+ +raster, landscape structure analysis, neutral landscapes, patch index +

DESCRIPTION

r.pi (raster patch index) provides various functions to analyse @@ -24,85 +31,55 @@

DESCRIPTION

to get a better impression of problems, possibilities and caveats. -

OVERVIEW

- - - -

General and Connectivity Indices

Individual-based dispersal models

Patch-Relevance

Neutral Landscape Model

Various modules

EXAMPLES

@@ -185,9 +162,10 @@

SEE ALSO

REFERENCE

Disclaimer

@@ -208,3 +186,5 @@

AUTHORS

University of Wuerzburg, Germany

Port to GRASS GIS 7: Markus Metz +

+Documentation improvements: Markus Neteler diff --git a/src/raster/r.pi/r.pi.import/main.c b/src/raster/r.pi/r.pi.import/main.c index 222536b5f4..6f2f39aae7 100644 --- a/src/raster/r.pi/r.pi.import/main.c +++ b/src/raster/r.pi/r.pi.import/main.c @@ -65,6 +65,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("patch index")); module->description = _("Import and generation of patch raster data"); parm.input = G_define_option(); diff --git a/src/raster/r.pi/r.pi.index/main.c b/src/raster/r.pi/r.pi.index/main.c index 333fb710c1..469a0b00c9 100644 --- a/src/raster/r.pi/r.pi.index/main.c +++ b/src/raster/r.pi/r.pi.index/main.c @@ -95,6 +95,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("fragmentation analysis")); module->description = _("Basic patch based indices"); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.lm/main.c b/src/raster/r.pi/r.pi.lm/main.c index ff5fc5bbc8..7f6dcd606f 100644 --- a/src/raster/r.pi/r.pi.lm/main.c +++ b/src/raster/r.pi/r.pi.lm/main.c @@ -55,6 +55,9 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("linear regression analysis")); + G_add_keyword(_("regression")); module->description = _("Linear regression analysis for patches."); parm.input1 = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.neigh/main.c b/src/raster/r.pi/r.pi.neigh/main.c index 7fc6899187..70cafedcfb 100644 --- a/src/raster/r.pi/r.pi.neigh/main.c +++ b/src/raster/r.pi/r.pi.neigh/main.c @@ -85,6 +85,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("neighbourhood analysis")); module->description = _("Neighbourhood analysis - value of patches within a defined range."); diff --git a/src/raster/r.pi/r.pi.nlm.circ/main.c b/src/raster/r.pi/r.pi.nlm.circ/main.c index 317f10bc6c..fa48f0e752 100644 --- a/src/raster/r.pi/r.pi.nlm.circ/main.c +++ b/src/raster/r.pi/r.pi.nlm.circ/main.c @@ -219,6 +219,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("neutral landscapes")); module->description = _("Creates a random landscape with defined attributes."); diff --git a/src/raster/r.pi/r.pi.nlm.stats/main.c b/src/raster/r.pi/r.pi.nlm.stats/main.c index 56a319f6b8..df5aca7241 100644 --- a/src/raster/r.pi/r.pi.nlm.stats/main.c +++ b/src/raster/r.pi/r.pi.nlm.stats/main.c @@ -104,6 +104,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("neutral landscapes")); module->description = _("Neutral Landscape Generator - index statistics"); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.nlm/main.c b/src/raster/r.pi/r.pi.nlm/main.c index e20850bc26..1ff76ffa36 100644 --- a/src/raster/r.pi/r.pi.nlm/main.c +++ b/src/raster/r.pi/r.pi.nlm/main.c @@ -62,6 +62,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("neutral landscapes")); module->description = _("Creates a random generated map with values 0 or 1" "by given landcover and fragment count."); diff --git a/src/raster/r.pi/r.pi.odc/main.c b/src/raster/r.pi/r.pi.odc/main.c index f15341b336..ae4ce6e1c3 100644 --- a/src/raster/r.pi/r.pi.odc/main.c +++ b/src/raster/r.pi/r.pi.odc/main.c @@ -107,6 +107,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Omnidirectional connectivity analysis"); parm.input = G_define_standard_option(G_OPT_R_INPUT); diff --git a/src/raster/r.pi/r.pi.prob.mw/main.c b/src/raster/r.pi/r.pi.prob.mw/main.c index 84f4e93bd9..393b2c70a0 100644 --- a/src/raster/r.pi/r.pi.prob.mw/main.c +++ b/src/raster/r.pi/r.pi.prob.mw/main.c @@ -78,6 +78,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("proximity analysis")); module->description = _("Probability analysis of 2 random points being in the same patch."); diff --git a/src/raster/r.pi/r.pi.prox/main.c b/src/raster/r.pi/r.pi.prox/main.c index 315f30bddd..843ad4b00d 100644 --- a/src/raster/r.pi/r.pi.prox/main.c +++ b/src/raster/r.pi/r.pi.prox/main.c @@ -95,6 +95,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("proximity analysis")); module->description = _("Calculates correlation of two raster maps " "by calculating correlation function of two " diff --git a/src/raster/r.pi/r.pi.rectangle/main.c b/src/raster/r.pi/r.pi.rectangle/main.c index dca5ebba23..b8feb1ee9d 100644 --- a/src/raster/r.pi/r.pi.rectangle/main.c +++ b/src/raster/r.pi/r.pi.rectangle/main.c @@ -70,6 +70,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("study area")); module->description = _("Generates a rectangle based on a corner coordinate."); diff --git a/src/raster/r.pi/r.pi.searchtime.mw/main.c b/src/raster/r.pi/r.pi.searchtime.mw/main.c index f30827fbf7..23a6db0ed7 100644 --- a/src/raster/r.pi/r.pi.searchtime.mw/main.c +++ b/src/raster/r.pi/r.pi.searchtime.mw/main.c @@ -93,6 +93,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Individual-based dispersal model for connectivity " "analysis (time-based) using moving window"); diff --git a/src/raster/r.pi/r.pi.searchtime.pr/main.c b/src/raster/r.pi/r.pi.searchtime.pr/main.c index ae99f4d4bd..9c5584cfbe 100644 --- a/src/raster/r.pi/r.pi.searchtime.pr/main.c +++ b/src/raster/r.pi/r.pi.searchtime.pr/main.c @@ -93,6 +93,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Individual-based dispersal model for connectivity analysis " "(time-based) using iterative removal of patches"); diff --git a/src/raster/r.pi/r.pi.searchtime/main.c b/src/raster/r.pi/r.pi.searchtime/main.c index 2bcfcf4352..9291c48365 100644 --- a/src/raster/r.pi/r.pi.searchtime/main.c +++ b/src/raster/r.pi/r.pi.searchtime/main.c @@ -90,6 +90,8 @@ int main(int argc, char *argv[]) module = G_define_module(); G_add_keyword(_("raster")); + G_add_keyword(_("landscape structure analysis")); + G_add_keyword(_("connectivity analysis")); module->description = _("Individual-based dispersal model for connectivity " "analysis (time-based)");