[GRASS-SVN] r59441 - grass-addons/grass7/raster/r.stream.basins
svn_grass at osgeo.org
svn_grass at osgeo.org
Thu Mar 27 09:28:30 PDT 2014
Author: hellik
Date: 2014-03-27 09:28:29 -0700 (Thu, 27 Mar 2014)
New Revision: 59441
Modified:
grass-addons/grass7/raster/r.stream.basins/r.stream.basins.html
Log:
r.stream.basin: manual reorder and formatting
Modified: grass-addons/grass7/raster/r.stream.basins/r.stream.basins.html
===================================================================
--- grass-addons/grass7/raster/r.stream.basins/r.stream.basins.html 2014-03-27 16:21:58 UTC (rev 59440)
+++ grass-addons/grass7/raster/r.stream.basins/r.stream.basins.html 2014-03-27 16:28:29 UTC (rev 59441)
@@ -1,3 +1,32 @@
+<h2>DESCRIPTION</h2>
+
+Module <em>r.stream.basins</em> is prepared to delineate basins and subbasins with
+different input data. Module is prepared to delineate unrestricted number of
+basins in one step. It can delineate basins with three methods:
+<ul>
+<li>Using coordinates: this option simply copies functionality of <a
+href="r.water.outlet.html">r.water.outlet</a>.
+<li>Using vector points: it allow to manually point outlets with any method
+<li>Using streams (most advanced) it allow on lots of modifications. See
+examples for more details.
+</ul>
+Only one method can be used at once. Methods cannot be mixed.
+<p>
+The most recommended method requires two maps: direction and streams. In spite of
+stream map we can store information required to proper delineation, we can
+also enumerate stream categories for which basins are to be created (cats
+option). Module is prepared to work with output data of <em>r.watershed,
+r.stream.extract, r.stream.order</em> also with modification done by
+<em>r.reclass</em> and <em>r.mapcalc</em>. r.stream.basin can delineate basins
+according outlets marked by raster streams, and polygons, vector points and
+numerical coordinates. If outlets are marked by points or coordinates it
+delineates basins which cells contribute to that points, if outlets are marked by
+streams it delineate cells which contribute to the last (downstream) cell of the
+every stream. If outlets are marked by polygon it delineate cells contributing
+to most downstream cell of the polygon. If polygon covers more outlets than of
+one basins it will create collective basin for all outlets with common
+category.
+
<h2>OPTIONS</h2>
<dl>
<dt><b>-z</b></dt>
@@ -5,7 +34,7 @@
algebra calculation) zero-valued background may be required. This flag produces
zero-filled background instead of NULL (default).</dd>
<dt><b>-c</b></dt>
-<dd>By default r.stream.basins uses streams category as basin category. In some
+<dd>By default <em>r.stream.basins</em> uses streams category as basin category. In some
cases - for example if stream map is a product of map algebra and separate streams
may not have unique values this option will create a new category sequence for
each basin (do not work in vector point mode).
@@ -18,7 +47,7 @@
<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
+r.stream.extract. 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 type CELL values. Region
@@ -60,41 +89,9 @@
</dd>
</dl>
-
<h2>OUTPUTS</h2>
<p>The module produces one raster map with basins according user's rules</p>
-
-<h2>DESCRIPTION</h2>
-
-Module r.stream.basins is prepared to delineate basins and subbasins with
-different input data. Module is prepared to delineate unrestricted number of
-basins in one step. It can delineate basins with three methods:
-<ul>
-<li>Using coordinates: this option simply copies functionality of <a
-href="r.water.outlet.html">r.water.outlet</a>.
-<li>Using vector points: it allow to manually point outlets with any method
-<li>Using streams (most advanced) it allow on lots of modifications. See
-examples for more details.
-</ul>
-Only one method can be used at once. Methods cannot be mixed.
-<p>
-The most recommended method requires two maps: direction and streams. In spite of
-stream map we can store information required to proper delineation, we can
-also enumerate stream categories for which basins are to be created (cats
-option). Module is prepared to work with output data of <em>r.watershed,
-r.stream.extract, r.stream.order</em> also with modification done by
-<em>r.reclass</em> and <em>r.mapcalc</em>. r.stream.basin can delineate basins
-according outlets marked by raster streams, and polygons, vector points and
-numerical coordinates. If outlets are marked by points or coordinates it
-delineates basins which cells contribute to that points, if outlets are marked by
-streams it delineate cells which contribute to the last (downstream) cell of the
-every stream. If outlets are marked by polygon it delineate cells contributing
-to most downstream cell of the polygon. If polygon covers more outlets than of
-one basins it will create collective basin for all outlets with common
-category.
-
-
<h2>NOTES</h2>
<p>
To receive good results outlets markers created by user shall overlapping with
@@ -107,8 +104,8 @@
This means, if stream 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. Nowadays, if direction map comes from
-r.stream.extract, it must be patched by direction map from r.watershed. (with
-r.patch).
+r.stream.extract, it must be patched by direction map from <em>r.watershed</em>. (with
+<em>r.patch</em>).
<h2>EXAMPLES</h2>
<p>
@@ -173,14 +170,7 @@
<h2>SEE ALSO</h2>
-<em>
-<a href="r.watershed.html">r.watershed</a>,
-<a href="r.stream.extract.html">r.stream.extract</a>,
-<a href="r.stream.order.html">r.stream.order</a>,
-<a href="r.stream.stats.html">r.stream.stats</a>,
-<a href="r.mapcalc.html">r.mapcalc</a>,
-<a href="r.reclass.html">r.reclass</a>,
-<a href="r.patch.html">r.patch</a>
+<em> <a href="r.watershed.html">r.watershed</a>, <a href="r.stream.extract.html">r.stream.extract</a>, <a href="r.stream.order.html">r.stream.order</a>, <a href="r.stream.stats.html">r.stream.stats</a>, <a href="r.mapcalc.html">r.mapcalc</a>, <a href="r.reclass.html">r.reclass</a>, <a href="r.patch.html">r.patch</a>
</em>
<h2>AUTHOR</h2>
More information about the grass-commit
mailing list