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

NAME

6       r.li.shannon  - Calculates Shannon’s diversity index on a raster map
7

KEYWORDS

9       raster, landscape structure analysis, diversity index
10

SYNOPSIS

12       r.li.shannon
13       r.li.shannon --help
14       r.li.shannon    input=name   config=name   output=name    [--overwrite]
15       [--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       output=name [required]
41           Name for output raster map
42

DESCRIPTION

44       r.li.shannon calculates the "Shannon’s diversity index" as:
45       with:
46
47           •   i: patch type
48
49           •   m: number of different patch types
50
51           •   pi: proportional abundance of patch type i
52

NOTES

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

EXAMPLES

65       To calculate Shannon’s diversity index on  map  my_map,  using  my_conf
66       configuration  file (previously defined with g.gui.rlisetup) and saving
67       results in my_out, run:
68       r.li.shannon input=my_map conf=my_conf output=my_out
69
70       Forest map (Spearfish sample dataset) example:
71       g.region raster=landcover.30m -p
72       r.mapcalc "forests = if(landcover.30m >= 41 && landcover.30m <= 43,1,null())"
73       r.li.shannon input=forests conf=movwindow7 out=forests_shannon_mov7
74       r.univar forests_shannon_mov7
75
76       Forest map (North Carolina sample dataset) example:
77       g.region raster=landclass96 -p
78       r.mapcalc "forests = if(landclass96 == 5, 1, null() )"
79       r.li.shannon input=forests conf=movwindow7 out=forests_shannon_mov7
80       # verify
81       r.univar forests_shannon_mov7
82       r.to.vect input=forests output=forests type=area
83       d.mon wx0
84       d.rast forests_shannon_mov7
85       d.vect forests type=boundary
86

SEE ALSO

88        r.li - package overview
89       g.gui.rlisetup
90

REFERENCES

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

AUTHORS

97       Serena  Pallecchi  student  of  Computer  Science  University  of  Pisa
98       (Italy).
99       Commission from Faunalia Pontedera (PI), Italy (www.faunalia.it)
100

SOURCE CODE

102       Available at: r.li.shannon source code (history)
103
104       Accessed: Saturday Jan 21 21:14:57 2023
105
106       Main  index  | Raster index | Topics index | Keywords index | Graphical
107       index | Full index
108
109       © 2003-2023 GRASS Development Team, GRASS GIS 8.2.1 Reference Manual
110
111
112
113GRASS 8.2.1                                                    r.li.shannon(1)