r.li.renyi(1grass)

1r.li.renyi(1)               GRASS GIS User's Manual              r.li.renyi(1)
2
3
4

NAME

6       r.li.renyi  - Calculates Renyi’s diversity index on a raster map
7

KEYWORDS

9       raster, landscape structure analysis, diversity index
10

SYNOPSIS

12       r.li.renyi
13       r.li.renyi --help
14       r.li.renyi  input=name  config=name  alpha=string output=name  [--over‐
15       write]  [--help]  [--verbose]  [--quiet]  [--ui]
16
17   Flags:
18       --overwrite
19           Allow output files to overwrite existing files
20
21       --help
22           Print usage summary
23
24       --verbose
25           Verbose module output
26
27       --quiet
28           Quiet module output
29
30       --ui
31           Force launching GUI dialog
32
33   Parameters:
34       input=nameÂ [required]
35           Name of input raster map
36
37       config=nameÂ [required]
38           Configuration file
39
40       alpha=stringÂ [required]
41           Alpha value is the order of the generalized entropy
42
43       output=nameÂ [required]
44           Name for output raster map
45

DESCRIPTION

47       r.li.renyi calculates the "Renyi’s diversity index" as:
48       with:
49
50           •   H: Renyi entropy
51
52           •   alpha: order of the generalized entropy
53
54           •   i: patch type
55
56           •   S: number of different patch types
57
58           •   pi: proportional abundance of patch type i
59

NOTES

61       Do not use absolute path names for the config and output  file/map  pa‐
62       rameters.    If   the   "moving   window"   method   was   selected  in
63       g.gui.rlisetup, then the output will be  a  raster  map,  otherwise  an
64       ASCII  file  will  be  generated  in  the  folder  C:\Users\userxy\App‐
65       Data\Roaming\GRASS8\r.li\output\            (MS-Windows)             or
66       $HOME/.grass8/r.li/output/ (GNU/Linux).
67
68       If  the  input raster map contains only NULL values then r.li.renyi re‐
69       turns NULL.
70

EXAMPLES

72       To calculate Renyi’s diversity index on map my_map, using my_conf  con‐
73       figuration file (previously defined with g.gui.rlisetup) and saving re‐
74       sults in my_out, run:
75       r.li.renyi input=my_map conf=my_conf output=my_out alpha=0.6
76
77       Forest map (Spearfish sample dataset) example:
78       g.region raster=landcover.30m -p
79       r.mapcalc "forests = if(landcover.30m >= 41 && landcover.30m <= 43,1,null())"
80       r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7_a06 alpha=0.6
81       r.univar forests_renyi_mov7_a06
82
83       Forest map (North Carolina sample dataset) example:
84       g.region raster=landclass96 -p
85       r.mapcalc "forests = if(landclass96 == 5, 1, null() )"
86       r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7
87       # verify
88       r.univar forests_renyi_mov7
89       r.to.vect input=forests output=forests type=area
90       d.mon wx0
91       d.rast forests_renyi_mov7
92       d.vect forests type=boundary
93

REFERENCES

99       McGarigal, K., and B. J. Marks. 1995. FRAGSTATS: spatial pattern analy‐
100       sis  program for quantifying landscape structure. USDA For. Serv.  Gen.
101       Tech. Rep. PNW-351. (PDF)
102

AUTHORS

104       Luca Delucchi and Duccio Rocchini, Fondazione E. Mach (Italy), based on
105       the r.li.shannon code developed by Serena Pallecchi student of Computer
106       Science University of Pisa (Italy).
107

SOURCE CODE

109       Available at: r.li.renyi source code (history)
110
111       Accessed: Saturday Jan 21 21:14:56 2023
112
113       Main index | Raster index | Topics index | Keywords index  |  Graphical
114       index | Full index
115
116       Â© 2003-2023 GRASS Development Team, GRASS GIS 8.2.1 Reference Manual
117
118
119
120GRASS 8.2.1                                                      r.li.renyi(1)