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

[svn_grass at osgeo.org]

Author: madi
Date: 2014-03-27 07:29:36 -0700 (Thu, 27 Mar 2014)
New Revision: 59419

Modified:
   grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html
Log:
consistency improved

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 14:13:50 UTC (rev 59418)
+++ grass-addons/grass7/raster/r.stream.distance/r.stream.distance.html	2014-03-27 14:29:36 UTC (rev 59419)
@@ -1,41 +1,47 @@
 <h2>OPTIONS</h2>
+
 <dl>
 <dt><b>-o</b></dt>
 <dd>Outlets. Downstream method only. Calculate distance and relative elevation
 to basin outlets instead of streams. It chooses only last outlets in the network
 ignoring nodes.</dd>
+
 <dt><b>-s</b></dt>
 <dd>Subbasins. Downstream method only. Calculate distance and elevation to
 stream nodes instead of streams. It creates distance and elevation parameters not
 for whole basins but for all elementary subbasins.</dd>
+
 <dt><b>-n</b></dt>
 <dd>Near. For upstream method only. Calculate distance and elevation to the
 nearest local maximum/divide. With the default option distance/elevation is
-calculated to the farthest possible maximum/divide.
-</dd>
-<dt><b>streams</b></dt>
+calculated to the farthest possible maximum/divide.</dd>
+
+
+<dt><b>stream_rast</b></dt>
 <dd>Stream network: name of input stream map on which ordering will be performed,
 produced by r.watershed or r.stream.extract. Because streams network produced by
 r.watershed and r.stream.extract may slighty 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 r.watershed and r.stream.extract. If not 0 or NULL use <a
-href="r.mapcalc.html">r.mapcalc</a> to set background values to NULL.  
-</dd>
-<dt><b>dirs</b></dt>
+href="r.mapcalc.html">r.mapcalc</a> to set background values to NULL.</dd>
+
+<dt><b>direction</b></dt>
 <dd>Flow direction: name of input direction map produced by r.watershed or
 r.stream.extract. 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
-resolution and map resoultion must be the same. Also <em>stream</em> network map
-must have the same resolution. It is checked by default. If resolutions differ
+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
 differ but it may lead to unexpected results.</dd>
+
 <dt><b>elevation</b></dt>
 <dd>Elevation: name of input elevation map. Map can be of type CELL, FCELL or
 DCELL. It is not restricted to resolution of region settings as stream and
-dir.</dd>
+direction.</dd>
+
 <dt><b>method</b></dt>
 <dd>It is possible to calculate distance with two method: <b>downstream</b> from
 any raster cell to the nearest stream cell/ junction cell or outlet or
@@ -97,13 +103,13 @@
 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 map comes from r.stream.extract also direction map from r.stream.extract
+stream_rast map comes from r.stream.extract also direction map from r.stream.extract
 must be used. If stream network was generated with MFD method also MFD direction
 map must be used.
 <p>
 Probably one of the most imortant features of r.stream.distance 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 dirs map. It can be a lake,
+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.
 
@@ -111,9 +117,11 @@
 
 <div class="code"><pre>
 g.region -p -a rast=elevation align=elevation
-r.watershed elevation=elevation threshold=10000 drainage=dirs stream=streams
-r.stream.distance stream=streams dirs=dirs elevation=elevation method=downstream distance=distance_stream_downstream difference=difference_stream_downstream
-r.stream.distance stream=streams dirs=dirs elevation=elevation method=upstream distance=distance_stream_upstream difference=difference_stream_upstream
+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
 </pre></div>
 
 <h2>SEE ALSO</h2>