NAME

       r.li.shannon  - Calculates Shannon's diversity index on a raster map

KEYWORDS

       raster, landscape structure analysis, diversity index

SYNOPSIS

       r.li.shannon
       r.li.shannon help
       r.li.shannon map=name conf=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

       output=name
           Name for output raster map

DESCRIPTION

       r.li.shannon calculates the "shannon's diversity index" as:
       with:

                     i: patch type

                     m: number of patch type

                     pi: proportion of the landscape occupied by patch type i

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.

EXAMPLES

       To calculate shannon's diversity index on map my_map, using my_conf configuration file and
       saving results in my_out file run:

       r.li.shannon map=my_map conf=my_conf output=my_out

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.shannon returns -1.
       If you want to have null values instead run

       r.null setnull=-1 map=my_map
        after index calculation.

SEE ALSO

        r.li

AUTHORS

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

       Last changed: $Date: 2011-08-16 02:13:05 -0700 (Tue, 16 Aug 2011) $

       Full index

       © 2003-2013 GRASS Development Team