[GRASS-SVN] r59608 - grass/trunk/raster/r.stream.distance

[svn_grass at osgeo.org]

Author: madi
Date: 2014-04-06 07:21:35 -0700 (Sun, 06 Apr 2014)
New Revision: 59608

Modified:
   grass/trunk/raster/r.stream.distance/r.stream.distance.html
Log:
improved readability of documentation

Modified: grass/trunk/raster/r.stream.distance/r.stream.distance.html
===================================================================
--- grass/trunk/raster/r.stream.distance/r.stream.distance.html	2014-04-06 13:56:08 UTC (rev 59607)
+++ grass/trunk/raster/r.stream.distance/r.stream.distance.html	2014-04-06 14:21:35 UTC (rev 59608)
@@ -110,7 +110,7 @@
 following <em>r.mapcalc</em> formula:
 
 <div class="code"><pre>
-r.mapcalc "dist_corrected = sqrt(distance^2 + elevation^2)"
+r.mapcalc expression = "dist_corrected = sqrt(distance^2 + elevation^2)"
 </pre></div>
 
 <p>
@@ -126,7 +126,7 @@
 was generated with MFD method also MFD direction map must be used.
 
 <p>
-Probably one of the most imortant features of <em>r.stream.distance</em> is the ability to
+Probably one of the most important features of <em>r.stream.distance</em> is the ability to
 calculate the distance not only for streams generated by <em>r.stream.extract</em>, but also
 for any integer map, as long ast the resolution corresponds to that of <em>direction</em> map. 
 It can be a lake, swamp, depression and lake boundaries even divided into smaller fragments each
@@ -135,14 +135,32 @@
 <h2>EXAMPLE</h2>
 
 <div class="code"><pre>
-g.region -p -a rast=elevation
-r.watershed elevation=elevation threshold=10000 drainage=direction stream=streams
-r.stream.distance stream_rast=streams direction=direction elevation=elevation \
-  method=downstream distance=distance_stream_downstream difference=difference_stream_downstream
-r.stream.distance stream_rast=streams direction=direction elevation=elevation \
-  method=upstream distance=distance_stream_upstream difference=difference_stream_upstream
+    
+# Set the region to match with elevation
+g.region -ap rast = elevation
+
+# Calculate flow direction and stream network
+r.watershed elevation = elevation threshold = 10000 drainage = direction stream = streams
+
+# Calculate elevation above and distance to stream network using downstream method
+r.stream.distance stream_rast = streams direction = direction elevation = elevation \
+  method = downstream distance = distance_stream_downstream difference = difference_stream_downstream
+  
+# Calculate elevation above and distance to stream network using upstream method
+r.stream.distance stream_rast = streams direction = direction elevation = elevation \
+  method = upstream distance = distance_stream_upstream difference = difference_stream_upstream
+
 </pre></div>
 
+<!--
+
+TODO : add the following examples:
+elevation above outlet 
+distance to outlet
+
+-->
+
+
 <h2>SEE ALSO</h2>
 <em>
 <a href="r.watershed.html">r.watershed</a>,