[GRASS-SVN] r59452 - grass-addons/grass7/raster/r.stream.distance

[svn_grass at osgeo.org]

Author: neteler
Date: 2014-03-27 11:03:21 -0700 (Thu, 27 Mar 2014)
New Revision: 59452

Modified:
   grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html
Log:
r.stream.distance manual: HTML beautified

Modified: grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html
===================================================================
--- grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html	2014-03-27 17:53:23 UTC (rev 59451)
+++ grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html	2014-03-27 18:03:21 UTC (rev 59452)
@@ -46,19 +46,18 @@
 
 <dt><b>stream_rast</b></dt>
 <dd>Stream network: name of input stream map on which ordering will be performed,
-produced by <em>r.watershed</em> or <em>r.stream.extract</em>. Because streams network produced by
-<em>r.watershed</em> and <em>r.stream.extract</em> may slightly differ in detail it is required to
-use both stream and direction map produced by the same module. Stream background
-shall have NULL value or zero value. Background values of NULL are by default
-produced by <em>r.watershed</em> and <em>r.stream.extract</em>. If not 0 or NULL use <em><a
-href="r.mapcalc.html">r.mapcalc</a></em> to set background values to NULL.</dd>
+produced by <em>r.watershed</em> or <em>r.stream.extract</em>. Because streams
+network produced by <em>r.watershed</em> and <em>r.stream.extract</em> may
+slighty differ in detail it is required to use both stream and direction map
+produced by the same module. Non-stream cell values must be set to NULL.</dd>
 
 <dt><b>direction</b></dt>
-<dd>Flow direction: name of input direction map produced by <em>r.watershed</em> or
-<em>r.stream.extract</em>. If r.stream.extract output map is used, it only has non-NULL
-values in places where streams occur. NULL (nodata) cells are ignored, zero and
-negative values are valid direction data if they vary from -8 to 8 (CCW from
-East in steps of 45 degrees). Direction map shall be of type CELL values. Region
+<dd>Flow direction: name of input direction map produced by r.watershed or
+<em>r.stream.extract</em>. If <em>r.stream.extract</em> output map is used,
+it only has non-NULL values in places where streams occur. NULL (nodata) cells
+are ignored, zero and negative values are valid direction data if they vary
+from -8 to 8 (CCW from East in steps of 45 degrees). Direction map shall be of
+integer type (CELL). Region
 resolution and map resoultion must be the same. Also <em>stream_rast</em> network map
 must have the same resolution. It is checked by default. If resolutions differ,
 the module informs about it and stops. Region boundary and maps boundary may
@@ -96,18 +95,18 @@
 Latitude-Longitude projections. The distance is calculated for flat areas not
 corrected by topography. Distance correction by topography may be done with
 following <em>r.mapcalc</em> formula:
-<p>
-<code>echo 'dist_corrected = sqrt(distance^2 + elevation^2)' | r.mapcalc</code>
-<p>
+<div class="code"><pre>
+r.mapcalc "dist_corrected = sqrt(distance^2 + elevation^2)"
+</pre></div>
 The module can work only if direction map, streams map and region have the same settings.
 It is also required that streams map and direction map come from the same source.
 For lots of reason this limitation probably cannot be omitted. This means that if
-stream_rast map comes from r.stream.extract also direction map from <em>r.stream.extract</em>
+stream_rast map comes from <em>r.stream.extract</em> also direction map from <em>r.stream.extract</em>
 must be used. If stream network was generated with MFD method also MFD direction
 map must be used.
 <p>
-Probably one of the most important features of <em>r.stream.distance</em> is the ability to
-calculate distance not only for streams generated with <em>r.stream.extract</em>, but also
+Probably one of the most imortant features of <em>r.stream.distance</em> is the ability to
+calculate distance not only for streams generated with r.stream.extract, but also
 to any CELL map with resolution corresponding to direction map. It can be a lake,
 swamp, depression and lake boundaries even divided into smaller fragments each
 with its own category.
@@ -115,12 +114,12 @@
 <h2>EXAMPLE</h2>
 
 <div class="code"><pre>
-g.region -p -a rast=elevation align=elevation
+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
+  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
+  method=upstream distance=distance_stream_upstream difference=difference_stream_upstream
 </pre></div>
 
 <h2>SEE ALSO</h2>