.TH r.li.renyi 1grass "" "GRASS 6.4.2" "Grass User's Manual"
.SH NAME
\fI\fBr.li.renyi\fR\fR  - Calculates Renyi's diversity index on a raster map
.SH KEYWORDS
raster, landscape structure analysis, diversity index
.SH SYNOPSIS
\fBr.li.renyi\fR
.br
\fBr.li.renyi help\fR
.br
\fBr.li.renyi map\fR=\fIname\fR \fBconf\fR=\fIstring\fR \fBalpha\fR=\fIstring\fR \fBoutput\fR=\fIname\fR  [--\fBoverwrite\fR]  [--\fBverbose\fR]  [--\fBquiet\fR] 
.SS Flags:
.IP "\fB--overwrite\fR" 4m
.br
Allow output files to overwrite existing files
.IP "\fB--verbose\fR" 4m
.br
Verbose module output
.IP "\fB--quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBmap\fR=\fIname\fR" 4m
.br
Name of input raster map
.IP "\fBconf\fR=\fIstring\fR" 4m
.br
Configuration file
.IP "\fBalpha\fR=\fIstring\fR" 4m
.br
Alpha value is the order of the generalized entropy
.IP "\fBoutput\fR=\fIname\fR" 4m
.br
Name for output raster map
.PP
.SH DESCRIPTION
\fIr.li.renyi\fR 
calculates the "renyi's diversity index" as:
.br
with: 
.br
.RS
.IP
\fBH\fR: Renyi entropy
.IP
\fBalpha\fR: order of the generalized entropy
.IP
\fBi\fR: ith class
.IP
\fBS\fR: number of classes
.IP
\fBpi\fR: proportion of the landscape occupied by class i
.RE
.SH NOTES
Do not use absolute path names for output files. They are raster if
moving window disposition was selected, otherwise they are in
~/.r.li/output/ folder.
.br
If the input raster contains NULL value cells, \fIr.li.renyi\fR
returns -1 for these cells. 
.br
If you want to keep NULL values instead, run subsequently on the resulting map:
.br
\fC
.DS
.br
r.null setnull=-1 map=my_map
.br
.DE
\fR
.SH EXAMPLES
To calculate Renyi's diversity index on map "my_map", using the
previously created "my_conf" configuration file (\fIr.li.setup\fR)
and saving results in "my_out" raster map, run:
.br
\fC
.DS
.br
r.li.renyi map=my_map conf=my_conf output=my_out alpha=0.6
.br
.DE
\fR
.SH NOTES
Do not use absolute path names for output files. They are raster if
moving window disposition was selected, otherwise they are in
~/.r.li/output folder. 
.br
If input raster is full of null values \fIr.li.renyi\fR returns -1.
.br
If you want to have null values instead run 
.br
\fC
.DS
.br
r.null setnull=-1 map=my_map
.br
.DE
\fR
after index calculation.
.SH REFERENCES
McGarigal, K., and B. J. Marks. 1995. FRAGSTATS: spatial pattern
analysis program for quantifying landscape structure. USDA For. Serv.
Gen. Tech. Rep. PNW-351. (PDF)
.SH SEE ALSO
\fI
r.li,
r.li.setup
\fR
.SH AUTHORS
Luca Delucchi and Duccio Rocchini, Fondazione E. Mach (Italy), based on the \fIr.li.shannon\fR code
developed by Serena Pallecchi student of Computer Science University of Pisa (Italy).
.br
.PP
\fILast changed: $Date: 2010-11-24 17:49:21 +0100 (Wed, 24 Nov 2010) $\fR
.PP
Full index
.PP
© 2003-2011 GRASS Development Team