Scroll to navigation

r.li.renyi(1grass) Grass User's Manual r.li.renyi(1grass)

NAME

r.li.renyi - Calculates Renyi's diversity index on a raster map

KEYWORDS

raster, landscape structure analysis, diversity index

SYNOPSIS

r.li.renyi
 
r.li.renyi help
 
r.li.renyi map=name conf=string alpha=string output=name [--overwrite] [--verbose] [--quiet]

Flags:

--overwrite
 
Allow output files to overwrite existing files
--verbose
 
Verbose module output
--quiet
 
Quiet module output

Parameters:

map=name
 
Name of input raster map
conf=string
 
Configuration file
alpha=string
 
Alpha value is the order of the generalized entropy
output=name
 
Name for output raster map

DESCRIPTION

r.li.renyi calculates the "renyi's diversity index" as:
 
with:
 
H: Renyi entropy
alpha: order of the generalized entropy
i: ith class
S: number of classes
pi: proportion of the landscape occupied by class i

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.
 
If the input raster contains NULL value cells, r.li.renyi returns -1 for these cells.
 
If you want to keep NULL values instead, run subsequently on the resulting map:
 
 
r.null setnull=-1 map=my_map
 

EXAMPLES

To calculate Renyi's diversity index on map "my_map", using the previously created "my_conf" configuration file ( r.li.setup) and saving results in "my_out" raster map, run:
 
 
r.li.renyi map=my_map conf=my_conf output=my_out alpha=0.6
 

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.
 
If input raster is full of null values r.li.renyi returns -1.
 
If you want to have null values instead run
 
 
r.null setnull=-1 map=my_map
 
after index calculation.

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)

SEE ALSO

r.li, r.li.setup

AUTHORS

Luca Delucchi and Duccio Rocchini, Fondazione E. Mach (Italy), based on the r.li.shannon code developed by Serena Pallecchi student of Computer Science University of Pisa (Italy).
 
Last changed: $Date: 2010-11-24 17:49:21 +0100 (Wed, 24 Nov 2010) $
Full index
© 2003-2011 GRASS Development Team
GRASS 6.4.2