[GRASS-SVN] r49392 - in grass-addons/raster/r.pi: r.pi.energy r.pi.searchtime

[svn_grass at osgeo.org]

Author: wegmann
Date: 2011-11-27 07:45:55 -0800 (Sun, 27 Nov 2011)
New Revision: 49392

Modified:
   grass-addons/raster/r.pi/r.pi.energy/description.html
   grass-addons/raster/r.pi/r.pi.searchtime/description.html
Log:
fixed manual pages, added various working examples

Modified: grass-addons/raster/r.pi/r.pi.energy/description.html
===================================================================
--- grass-addons/raster/r.pi/r.pi.energy/description.html	2011-11-27 15:23:54 UTC (rev 49391)
+++ grass-addons/raster/r.pi/r.pi.energy/description.html	2011-11-27 15:45:55 UTC (rev 49392)
@@ -1,26 +1,75 @@
 <h2>DESCRIPTION</h2>
 
-Isolation or connectivity of singular patches of a defined landcover class using individual-based dispersal models. This function is based on a maximum amount of energy for each individuals dispersing through the landscape which is deminished by a fricition or cost map.
+Isolation or connectivity of singular patches of a defined landcover class using individual-based dispersal models. This function is based on a maximum amount of energy for each individuals dispersing through the landscape which is deminished by a fricition or cost map. Unlike the related function <em>r.pi.energy</em> does this function allows individuals to stay or move within a patch until the energy is depleted.
 
 <h2>NOTES</h2>
 
-...
+Amount of successful immigrants or emigrants are not taken individual into account which emigrated from and immigrated into the same patch (pseudo immigration).
 
+The suitability matrix impacts the step direction, while the costmap relates to the depletion of assigned energy.
+
 <h2>EXAMPLE</h2>
 
 An example for the North Carolina sample dataset:
 
+The amount of successful emigrants (*_emi), immigrants (*_imi), the percentage of immigrants per patch (*_imi_percent), the amount of lost indivuals (*_lost), the amount of migrants (*_mig), successful (*_mig_succ) and unsuccessful migrants (_mig_unsucc) can be retrieved using this command:
 <div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80
+</pre></div>
 
 
-g.region -d
-...
+introducing costs for movement results in different immigration counts:
+<div class="code"><pre>
+r.mapcalc "cost_raster = if(landclass96==5,0,if(landclass96 == 1, 10, if (landclass96==3,2, if(landclass96==4,1,if(landclass96==6,100)))))"
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 costmap=cost_raster
 </pre></div>
 
+introducing a suitability for the movement:
+<div class="code"><pre>
+# the suitability for the next step selection is defined as: class 5 and 3 (forest and grassland) have a high suitability, while shrubland (class 4) only a moderate and water and developed areas (class 6 and 1) have a very low suitability:
+r.mapcalc "suit_raster = if(landclass96==5,100,if(landclass96 == 3, 100, if (landclass96==1,1, if(landclass96==6,1,if(landclass96==4,50)))))"
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 suitability=suit_raster
+</pre></div>
+
+further settings can be changed and information retrieved:
+
+setting the perception range to 10 pixel:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 perception=10
+</pre></div>
+
+increasing the attraction to move towards patches to 10:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 multiplicator=10
+</pre></div>
+
+output of each movement location for a defined step frequency. Here every 10th step is provided as output raster:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 out_freq=10
+</pre></div>
+
+output of a raster which immigration counts:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 out_immi=immi_counts
+</pre></div>
+
+output of a binary immigration matrix. Each patch emigration and immigration for all patch combinations is recorded as 0 or 1:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 binary_matrix=binary_matrix.txt
+</pre></div>
+
+output of a matrix with immigration counts for each patch:
+<div class="code"><pre>
+r.pi.energy input=landclass96 output=energy1 keyval=5 n=1000 step_length=5 energy=10 percent=80 immi_matrix=immi_counts.txt
+</pre></div>
+
+
+
 <h2>SEE ALSO</h2>
 
 <em>
-<a href="r.pi.energy.iter.html">r.energy.iter</a>,
+<a href="r.pi.energy.iter.html">r.pi.energy.iter</a>,
+<a href="r.pi.energy.html">r.pi.energy</a>,
 <a href="r.pi.html">r.pi</a>
 </em>
 

Modified: grass-addons/raster/r.pi/r.pi.searchtime/description.html
===================================================================
--- grass-addons/raster/r.pi/r.pi.searchtime/description.html	2011-11-27 15:23:54 UTC (rev 49391)
+++ grass-addons/raster/r.pi/r.pi.searchtime/description.html	2011-11-27 15:45:55 UTC (rev 49392)
@@ -28,11 +28,6 @@
 r.pi.searchtime input=landclass96 output=searchtime1 keyval=5 step_length=5 stats=average,variance percent=80 n=1000 perception=10
 </pre></div>
 
-setting the perception range to 10 pixel:
-<div class="code"><pre>
-r.pi.searchtime input=landclass96 output=searchtime1 keyval=5 step_length=5 stats=average,variance percent=80 n=1000 perception=10
-</pre></div>
-
 increasing the attraction to move towards patches to 10:
 <div class="code"><pre>
 r.pi.searchtime input=landclass96 output=searchtime1 keyval=5 step_length=5 stats=average,variance percent=80 n=1000 multiplicator=10