[GRASS-SVN] r59003 - in grass/branches/develbranch_6/raster/r.li: . r.li.cwed r.li.dominance r.li.edgedensity r.li.mpa r.li.mps r.li.padcv r.li.padrange r.li.padsd r.li.patchdensity r.li.patchnum r.li.pielou r.li.renyi r.li.richness r.li.setup r.li.shannon r.li.shape r.li.simpson

svn_grass at osgeo.org svn_grass at osgeo.org
Tue Feb 11 08:24:44 PST 2014


Author: neteler
Date: 2014-02-11 08:24:44 -0800 (Tue, 11 Feb 2014)
New Revision: 59003

Modified:
   grass/branches/develbranch_6/raster/r.li/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.cwed/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.dominance/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.edgedensity/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.mpa/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.mps/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.padcv/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.padrange/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.padsd/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.patchdensity/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.patchnum/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.pielou/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.renyi/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.richness/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.setup/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.shannon/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.shape/description.html
   grass/branches/develbranch_6/raster/r.li/r.li.simpson/description.html
Log:
r.li.* manuals: cosmetics

Modified: grass/branches/develbranch_6/raster/r.li/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -22,6 +22,7 @@
 <h2>DESCRIPTION</h2>
 
 The <em>r.li</em> suite is a toolset for multiscale analysis of landscape structure.
+<!-- rephrase reference to r.le which is long time ago ...-->
 It aims at replacing the <em>r.le</em> suite of modules through a client-server,
 multiprocess implementation. External software for quantitative measures of landscape
 structure is for example FRAGSTATS (McGarigal and Marks 1995).
@@ -63,9 +64,10 @@
 The <em>r.li.daemon</em> module also has a "main" function front-end
 which can be run, but it is only a template for development of new
 indices so not built by default.
-<!-- mhh ??: -->
-The function itself has no meaning, it is only useful as an example and
+<!-- mhh ??: 
+The function itself has no meaning, it is only useful as an example and 
 for debugging.
+-->
 
 <h2>EXAMPLE</h2>
 
@@ -198,9 +200,7 @@
 
 <h2>AUTHORS</h2>
 
-<a href="mailto:porta at cli.di.unipi.it">Claudio Porta</a> and 
-<a href="mailto:spano at cli.di.unipi.it">Lucio Davide Spano</a>,
- students of Computer Science 
+Claudio Porta and Lucio Davide Spano, students of Computer Science,
 University of Pisa (Italy).<br>
 Commission from Faunalia Pontedera (PI)<br>
 
@@ -213,6 +213,6 @@
 <a href="index.html">Main index</a>
  - <a href="raster.html">Raster index</a>
  - <a href="full_index.html">Full index</a>
-<p>© 2003-2014 <a href="http://grass.osgeo.org">GRASS Development Team</a>, GRASS GIS 6 Reference Manual</p>
+<p>© 2008-2014 <a href="http://grass.osgeo.org">GRASS Development Team</a>, GRASS GIS 6 Reference Manual</p>
 </body>
 </html>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.cwed/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.cwed/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.cwed/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -25,7 +25,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values it is considered to

Modified: grass/branches/develbranch_6/raster/r.li/r.li.dominance/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.dominance/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.dominance/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -15,7 +15,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.dominance</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.edgedensity/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.edgedensity/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.edgedensity/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -23,7 +23,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.edgedensity</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.mpa/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.mpa/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.mpa/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -16,7 +16,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.mpa</em> considers to

Modified: grass/branches/develbranch_6/raster/r.li/r.li.mps/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.mps/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.mps/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -15,7 +15,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster contains NULL value cells, <em>r.li.mps</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.padcv/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.padcv/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.padcv/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -17,7 +17,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 If input raster is not full of null values <em>r.li.padcv</em> returns a value >=0 that is PADcv. <br>
 If the input raster map contains only NULL values then <em>r.li.padcv</em> returns -1. <br>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.padrange/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.padrange/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.padrange/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -14,7 +14,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.padrange</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.padsd/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.padsd/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.padsd/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -14,7 +14,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 If input raster is not full of null values <em>r.li.padsd</em> returns a
 value >=0 that is PADsd. <br>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.patchdensity/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.patchdensity/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.patchdensity/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -13,7 +13,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 A map of NULL values is considered to have zero patches. <br>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.patchnum/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.patchnum/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.patchnum/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -9,7 +9,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO verify: -->
 If the input raster map contains only NULL values then it is considered to have zero patch. <br>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.pielou/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.pielou/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.pielou/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -14,7 +14,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 If the input raster contains NULL value cells, <em>r.li.pielou</em>
 returns -1 for these cells. <br>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.renyi/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.renyi/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.renyi/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -16,7 +16,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.renyi</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.richness/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.richness/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.richness/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -12,7 +12,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.richness</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.setup/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.setup/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.setup/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -1,7 +1,7 @@
 <h2>DESCRIPTION</h2>
 
 <em>r.li.setup</em>  creates and shows configuration files for the 
-others <em>r.li</em> modules. For a general introduction, see 
+other analytical <em>r.li</em> modules. For a general introduction, see 
 <a href="r.li.html">r.li</a>.
 <br>
 The configurations are raster map independent, 
@@ -53,7 +53,7 @@
  the user). The output can either be a new raster map (in case of 
  using a "moving window" analysis) or be an ASCII text file (when not 
  performing a "moving window" analysis) containing the result which 
- is then saved to the folder <tt>~/.r.li/output/</tt>.
+ is then saved to the folder <tt>$HOME/.r.li/output/</tt>.
  <br>
  <!-- TODO: applies to all output or only ASCII output?? -->
  All dimensions are percentages of raster rows or columns.</li>
@@ -143,18 +143,22 @@
   <li><em><b>Close</b></em> module window.</li>
 </ol>
 
+<h2>NOTES</h2>
+
+Configuration files are raster map independent because areas are saved using
+relative coordinates.
+
 <h2>EXAMPLES</h2>
 
 <h3>Moving window analysis on full region</h3>
 
-Example for a 7x7 moving window analysis on full region:
-
+Example for a 7x7 moving window analysis on full region, the output 
+is a raster map:
+<p>
+Click on "New", then:
 <ul>
-<li> Click on "New"</li>
- <ul>
-  <li> Configuration file name: "movwindow7"</li>
-  <li> Raster map name to use to select areas: "forests"</li>
- </ul>
+ <li> Configuration file name: "movwindow7"</li>
+ <li> Raster map name to use to select areas: "forests"</li>
 </ul>
 
 1. Setup sampling frame:
@@ -166,15 +170,14 @@
 <ul>
 <li> Define sampling areas: "Moving window", then "OK"</li>
 <li> Then click on "Use keyboard to define moving window dimension"</li>
+</ul>
+
+Select type of shape:
 <ul>
- <li>Select type of shape</li>
- <ul>
-  <li> [x] Rectangular</li>
-  <li> Width size (in cells)?: "7"</li>
-  <li> Height size (in cells)?: "7"</li>
-  <li> Then "Save settings"</li>
- </ul>
- </ul>
+<li> [x] Rectangular</li>
+<li> Width size (in cells)?: "7"</li>
+<li> Height size (in cells)?: "7"</li>
+<li> Then "Save settings"</li>
 </ul>
 
 3. Save settings: click on button
@@ -183,21 +186,53 @@
 <p>
 Now an anaysis can be performed using one of the analytical modules, e.g.
 <div class="code"><pre>
+g.region rast=forests -p
 r.li.patchdensity map=forests conf=movwindow7 output=forests_p_dens7
+r.univar forests_p_dens7
 </pre></div>
 
-The result is a new raster map "forests_p_dens7".
+The result is the new raster map "forests_p_dens7" which shows (in this example)
+the patch density of the forest areas.
 <br>
 See the respective modules for further examples.
 
-<!-- TODO: add configuration example which results in ASCII output rather than raster map -->
 
-<h2>NOTES</h2>
+<h3>Whole region analysis</h3>
 
-Configuration files are raster map independent because areas are saved using 
-relative coordinates.
+<!-- TODO: find a better example and briefly explain the meaning of result --> 
+Example for a whole region analysis, the output is a text file:
 
+Click on "New", then:
+<ul>
+ <li> Configuration file name: "whole_region"</li>
+ <li> Raster map name to use to select areas: "lsat7_2000_40"</li>
+</ul>
 
+1. Setup sampling frame:
+<ul>
+<li> Define a sampling frame (region for analysis): "Whole map layer", then "OK"</li>
+</ul>
+
+2. Setup sampling frame
+<ul>
+<li> Define sampling areas: "Whole map layer", then "OK"</li>
+</ul>
+
+3. Save settings: click on button
+<br>
+(4.) Close
+<p>
+Now an anaysis can be performed using one of the analytical modules, e.g.
+<div class="code"><pre>
+g.region rast=lsat7_2002_40 -p
+r.li.shannon map=lsat7_2000_40 conf=whole_region output=lsat7_2000_40_shannon
+</pre></div>
+
+The result is the new text file "forests_p_dens7" (stored in folder <tt>$HOME/.r.li/output/</tt>.
+<br>
+See the respective modules for further examples.
+
+
 <h2>SEE ALSO</h2>
 
 <em>
@@ -219,7 +254,7 @@
 Claudio Porta and Lucio Davide Spano, students of Computer Science<br>
 University of Pisa (Italy).<br>
 Commission from Faunalia Pontedera (PI)<br>
-Rebuild of <em>r.le.setup</em> from William L. Baker
+Rewritten from <em>r.le.setup</em> by William L. Baker
 
 <p>
 <i>Last changed: $Date$</i>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.shannon/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.shannon/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.shannon/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -15,7 +15,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.shannon</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.shape/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.shape/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.shape/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -8,7 +8,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.shape</em>

Modified: grass/branches/develbranch_6/raster/r.li/r.li.simpson/description.html
===================================================================
--- grass/branches/develbranch_6/raster/r.li/r.li.simpson/description.html	2014-02-11 16:23:59 UTC (rev 59002)
+++ grass/branches/develbranch_6/raster/r.li/r.li.simpson/description.html	2014-02-11 16:24:44 UTC (rev 59003)
@@ -15,7 +15,7 @@
 Do not use absolute path names for the <b>output</b> map/file.
 If the "moving window" method was selected in <b>r.li.setup</b>, then the
 output will be a raster map, otherwise an ASCII file will be generated in
-the <tt>~/.r.li/output/</tt> folder.
+the <tt>$HOME/.r.li/output/</tt> folder.
 <p>
 <!-- TODO: verify next: -->
 If the input raster map contains only NULL values then <em>r.li.simpson</em>



More information about the grass-commit mailing list