Debian Codegraph @

raster/r.li/r.li.renyi/r.li.renyi.html

raw
1 <h2>DESCRIPTION</h2>
2
3 <em>r.li.renyi</em> calculates the "Renyi's diversity index" as:<br>
4 <img src="r_li_renyi.png" alt="r.li.renyi formula"> <br>
5 with:
6 <ul>
7 <li><b>H</b>: Renyi entropy</li>
8 <li><b>alpha</b>: order of the generalized entropy</li>
9 <li><b>i</b>: patch type</li>
10 <li><b>S</b>: number of different patch types</li>
11 <li><b>p<small><small>i</small></small></b>: proportional abundance of
12 patch type <i>i</i> </li>
13 </ul>
14
15 <h2>NOTES</h2>
16
17 Do not use absolute path names for the <b>config</b> and <b>output</b>
18 file/map parameters.
19
20 If the "moving window" method was selected in <b>g.gui.rlisetup</b>, then the
21 output will be a raster map, otherwise an ASCII file will be generated in
22 the folder <code>C:\Users\userxy\AppData\Roaming\GRASS8\r.li\output\</code>
23 (MS-Windows) or <code>$HOME/.grass8/r.li/output/</code> (GNU/Linux).
24 <p>
25 <!-- TODO: verify next: -->
26 If the input raster map contains only NULL values then <em>r.li.renyi</em>
27 returns NULL.
28
29 <h2>EXAMPLES</h2>
30
31 To calculate Renyi's diversity index on map <em>my_map</em>, using
32 <em>my_conf</em> configuration file (previously defined with
33 <em>g.gui.rlisetup</em>) and saving results in <em>my_out</em>, run:
34 <div class="code"><pre>
35 r.li.renyi input=my_map conf=my_conf output=my_out alpha=0.6
36 </pre></div>
37 <p>
38
39 Forest map (Spearfish sample dataset) example:
40 <div class="code"><pre>
41 g.region raster=landcover.30m -p
42 r.mapcalc "forests = if(landcover.30m &gt;= 41 &amp;&amp; landcover.30m &lt;= 43,1,null())"
43 r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7_a06 alpha=0.6
44 r.univar forests_renyi_mov7_a06
45 </pre></div>
46 <p>
47
48 Forest map (North Carolina sample dataset) example:
49 <div class="code"><pre>
50 g.region raster=landclass96 -p
51 r.mapcalc "forests = if(landclass96 == 5, 1, null() )"
52 r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7
53
54 # verify
55 r.univar forests_renyi_mov7
56 r.to.vect input=forests output=forests type=area
57 d.mon wx0
58 d.rast forests_renyi_mov7
59 d.vect forests type=boundary
60 </pre></div>
61
62 <h2>SEE ALSO</h2>
63
64 <em>
65 <a href="r.li.html">r.li</a> (package overview),
66 <a href="g.gui.rlisetup.html">g.gui.rlisetup</a>
67 </em>
68
69 <h2>REFERENCES</h2>
70
71 McGarigal, K., and B. J. Marks. 1995. FRAGSTATS: spatial pattern
72 analysis program for quantifying landscape structure. USDA For. Serv.
73 Gen. Tech. Rep. PNW-351. (<a href="https://doi.org/10.2737/PNW-GTR-351">PDF</a>)
74
75 <h2>AUTHORS</h2>
76
77 Luca Delucchi and Duccio Rocchini, Fondazione E. Mach (Italy), based on
78 the <em>r.li.shannon</em> code developed by Serena Pallecchi, student of
79 Computer Science University of Pisa (Italy).