Geografic-Information-System/raster/r.li/r.li.renyi/r.li.renyi.html

<h2>DESCRIPTION</h2>

<em>r.li.renyi</em> calculates the "Renyi's diversity index" as:<br>
<img src="r_li_renyi.png" alt="r.li.renyi formula"> <br>
with:
<ul>
  <li><b>H</b>: Renyi entropy</li>
  <li><b>alpha</b>: order of the generalized entropy</li>
  <li><b>i</b>: patch type</li>
  <li><b>S</b>: number of different patch types</li>
  <li><b>p<small><small>i</small></small></b>: proportional abundance of 
patch type <i>i</i> </li>
</ul>

<h2>NOTES</h2>

Do not use absolute path names for the <b>config</b> and <b>output</b>
file/map parameters.

If the "moving window" method was selected in <b>g.gui.rlisetup</b>, then the
output will be a raster map, otherwise an ASCII file will be generated in
the folder <tt>C:\Users\userxy\AppData\Roaming\GRASS7\r.li\output\</tt>
(MS-Windows) or <tt>$HOME/.grass7/r.li/output/</tt> (GNU/Linux).
<p>
<!-- TODO: verify next: -->
If the input raster map contains only NULL values then <em>r.li.renyi</em>
returns NULL.

<h2>EXAMPLES</h2>
To calculate Renyi's diversity index on map <em>my_map</em>, using
<em>my_conf</em> configuration file (previously defined with
<em>g.gui.rlisetup</em>) and saving results in <em>my_out</em>, run:
<div class="code"><pre>
r.li.renyi input=my_map conf=my_conf output=my_out alpha=0.6
</pre></div>
<p>

Forest map (Spearfish sample dataset) example:
<div class="code"><pre>
g.region raster=landcover.30m -p
r.mapcalc "forests = if(landcover.30m >= 41 && landcover.30m <= 43,1,null())"
r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7_a06 alpha=0.6
r.univar forests_renyi_mov7_a06
</pre></div>
<p>

Forest map (North Carolina sample dataset) example:
<div class="code"><pre>
g.region raster=landclass96 -p
r.mapcalc "forests = if(landclass96 == 5, 1, null() )"
r.li.renyi input=forests conf=movwindow7 out=forests_renyi_mov7

# verify
r.univar forests_renyi_mov7
r.to.vect input=forests output=forests type=area
d.mon wx0
d.rast forests_renyi_mov7
d.vect forests type=boundary
</pre></div>

<h2>SEE ALSO</h2>
<em>
<a href="r.li.html">r.li</a> - package overview<br>
<a href="g.gui.rlisetup.html">g.gui.rlisetup</a>
</em>

<h2>REFERENCES</h2>
McGarigal, K., and B. J. Marks. 1995. FRAGSTATS: spatial pattern
analysis program for quantifying landscape structure. USDA For. Serv.
Gen. Tech. Rep. PNW-351. (<a href="http://treesearch.fs.fed.us/pubs/3064">PDF</a>)

<h2>AUTHORS</h2>
Luca Delucchi and Duccio Rocchini, Fondazione E. Mach (Italy), based on
the <em>r.li.shannon</em> code developed by Serena Pallecchi student of
Computer Science University of Pisa (Italy).<br>

<p>
<i>Last changed: $Date$</i>