[GRASS-SVN] r46154 - in grass-addons/raster: r.stream.angle r.stream.basins r.stream.del r.stream.distance r.stream.extract r.stream.order r.stream.pos r.stream.stats

svn_grass at osgeo.org svn_grass at osgeo.org
Sun May 1 19:50:30 EDT 2011


Author: neteler
Date: 2011-05-01 16:50:30 -0700 (Sun, 01 May 2011)
New Revision: 46154

Modified:
   grass-addons/raster/r.stream.angle/description.html
   grass-addons/raster/r.stream.basins/description.html
   grass-addons/raster/r.stream.del/description.html
   grass-addons/raster/r.stream.distance/description.html
   grass-addons/raster/r.stream.extract/description.html
   grass-addons/raster/r.stream.order/description.html
   grass-addons/raster/r.stream.pos/description.html
   grass-addons/raster/r.stream.stats/description.html
Log:
html prettified

Modified: grass-addons/raster/r.stream.angle/description.html
===================================================================
--- grass-addons/raster/r.stream.angle/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.angle/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -79,14 +79,12 @@
 
 <h2>AUTHOR</h2>
 Jarek  Jasiewicz
+
 <h2>REFERENCES</h2>
-<P>Horton, R. E., (1932). Drainage basin characteristics: Am. Geophys. Union Trans., (3), 350-361.
-<P>Howard, A.D. (1971). Optimal angles of stream junction: Geometric, Stability to capture and Minimum Power Criteria, Water Resour. Res. 7(4), 863-873.
-<P>Howard, A.D. (1990). Theoretical model of optimal drainage networks Water Resour. Res., 26(9),  2107-2117.
-<P>Van, W., Ventura, J.A. (1997). Segmentation of Planar Curves into Straight-Line Segments and Elliptical Arcs, Graphical Models and Image Processing 59(6), 484-494.
+<p>Horton, R. E., (1932). Drainage basin characteristics: Am. Geophys. Union Trans., (3), 350-361.
+<p>Howard, A.D. (1971). Optimal angles of stream junction: Geometric, Stability to capture and Minimum Power Criteria, Water Resour. Res. 7(4), 863-873.
+<p>Howard, A.D. (1990). Theoretical model of optimal drainage networks Water Resour. Res., 26(9),  2107-2117.
+<p>Van, W., Ventura, J.A. (1997). Segmentation of Planar Curves into Straight-Line Segments and Elliptical Arcs, Graphical Models and Image Processing 59(6), 484-494.
 
-<HR>
-<P><a href="index.html">Main index</a> - <a href="raster.html">raster index</a> - <a href="full_index.html">Full index</a></P>
-<P>&copy; 2003-2009 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
-</body>
-</html>
+<p><i>Last changed: $Date$</i>
+

Modified: grass-addons/raster/r.stream.basins/description.html
===================================================================
--- grass-addons/raster/r.stream.basins/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.basins/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -160,8 +160,5 @@
 <h2>AUTHOR</h2>
 Jarek  Jasiewicz
 
-<HR>
-<P><a href="index.html">Main index</a> - <a href="raster.html">raster index</a> - <a href="full_index.html">Full index</a></P>
-<P>&copy; 2003-2009 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
-</body>
-</html>
+<p><i>Last changed: $Date$</i>
+

Modified: grass-addons/raster/r.stream.del/description.html
===================================================================
--- grass-addons/raster/r.stream.del/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.del/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -72,5 +72,5 @@
 <h2>AUTHOR</h2>
 Jarek  Jasiewicz
 
-</body>
-</html>
+<p><i>Last changed: $Date: 2010-11-13 13:02:26 +0100 (Sat, 13 Nov 2010) $</i>
+

Modified: grass-addons/raster/r.stream.distance/description.html
===================================================================
--- grass-addons/raster/r.stream.distance/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.distance/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -66,3 +66,5 @@
 <h2>AUTHOR</h2>
 Jarek Jasiewicz
 
+<p><i>Last changed: $Date$</i>
+

Modified: grass-addons/raster/r.stream.extract/description.html
===================================================================
--- grass-addons/raster/r.stream.extract/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.extract/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -144,7 +144,7 @@
 <a href="r.param.scale.html">r.param.scale</a> to weigh an accumulation
 map produced with <a href="r.watershed.html">r.watershed</a>.
 
-<pre>
+<div class="code"><pre>
 # set region
 g.region -p rast=elevation.10m at PERMANENT
 
@@ -170,13 +170,13 @@
 
 # copy color table from original accumulation map
 r.colors map=elevation.10m.acc.weighed raster=elevation.10m.acc
-</pre>
+</pre></div>
 
 Display both the original and the weighed accumulation map.
 <br>
 Compare them and proceed if the weighed accumulation map makes sense.
 
-<pre>
+<div class="code"><pre>
 # extract streams
 r.stream.extract elevation=elevation.10m at PERMANENT \
                  accumulation=elevation.10m.acc.weighed \
@@ -188,7 +188,7 @@
                  accumulation=elevation.10m.acc \
 		 threshold=1000 \
 		 stream_rast=elevation.10m.streams.noweight
-</pre>
+</pre></div>
 
 Now display both stream maps and decide which one is more realistic.
 

Modified: grass-addons/raster/r.stream.order/description.html
===================================================================
--- grass-addons/raster/r.stream.order/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.order/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -1,25 +1,51 @@
+<h2>DESCRIPTION</h2>
+
 <h2>OPTIONS</h2>
 <DL>
 <DT><b>-z</b></DT>
-<DD>Creates zero-value background instead of NULL. For some reason (like map algebra calculation) zero-valued background may be required. This flag produces zero-filled background instead of null (default).</DD>
+<DD>Creates zero-value background instead of NULL. For some reason (like map
+algebra calculation) zero-valued background may be required. This flag produces
+zero-filled background instead of null (default).</DD>
 <p>
 <DT><b>stream</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>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>
 <p>
 <DT><b>dir</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 and <em>accumulation</em> maps must have the same resolution. It is checked by default. If resolutions differ the module informs about it and stops. Region boundary
+<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 and <em>accumulation</em> maps 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 be differ but it may lead to unexpected results.</DD>
 <p>
 <DT><b>table</b></DT>
-<DD>Table where stream network topology can be stored. Because r.stream.order is prepared to work both with r.watershed and r.stream.extract, table by default is not attached to vector, but if stream network is produced by r.stream.extract it can be simply added to file using <a href="v.db.coonect.html">v.db.connect</a>. See DESCRIPTION for details</DD>
+<DD>Table where stream network topology can be stored. Because r.stream.order is
+prepared to work both with r.watershed and r.stream.extract, table by default is
+not attached to vector, but if stream network is produced by r.stream.extract it
+can be simply added to file using <a href="v.db.coonect.html">v.db.connect</a>.
+See DESCRIPTION for details</DD>
 
 <p>
 <DT><b>accum</b></DT>
-<DD>Flow accumulation (optional, not recommended): name of flow accumulation file produced by r.watershed or used in r.stream.extract. This map is an option only if Horton's or Hack's ordering is performed. Normally both Horton and Hack ordering is calculated on cumulative stream lrngth wchich is calculated internaly. Flow accumulation can be used if user want to calculate main stream as most accumulated stream. Flow accumulation map shall be of DCELL type, as is by default produced by r.watershed or converted do DCELL with r.mapcalc.</DD>
+<DD>Flow accumulation (optional, not recommended): name of flow accumulation
+file produced by r.watershed or used in r.stream.extract. This map is an option
+only if Horton's or Hack's ordering is performed. Normally both Horton and Hack
+ordering is calculated on cumulative stream lrngth wchich is calculated
+internaly. Flow accumulation can be used if user want to calculate main stream
+as most accumulated stream. Flow accumulation map shall be of DCELL type, as is
+by default produced by r.watershed or converted do DCELL with r.mapcalc.</DD>
 
 <h2>OUTPUTS</h2>
 
@@ -31,64 +57,135 @@
 <DD>Name of Shreve's stream magnitude output map: see notes for detail.</DD>
 
 <DT><b>horton</b></DT>
-<DD>Name of Horton's stream order output map (require accum file): see notes for detail.</DD>
+<DD>Name of Horton's stream order output map (require accum file): see notes for
+detail.</DD>
 
 <DT><b>hack</b></DT>
 <DD>Name of Hack's main streams output map : see notes for detail.</DD>
 
 <DT><b>top</b></DT>
-<DD>Name of topological dimensions streams output map: see notes for detail.</DD>
+<DD>Name of topological dimensions streams output map: see notes for
+detail.</DD>
 
 </DL>
 
-<h2>DESCRIPTION</h2>
+<h3>Stream ordering example:</h3>
 <center>
-<h3>Stream ordering example:<h3>
 <img src=orders.png border=1><br>
 </center>
 
 <P>
 <H4>Strahler's stream order</H4>
-Strahler's stream order is a modification of Horton's streams order which fixes the ambiguity of Horton's ordering. 
-In Strahler's ordering the main channel is not determined; instead the ordering is based on the hierarchy of tributaries. The 	
-ordering follows these rules:
+Strahler's stream order is a modification of Horton's streams order which fixes
+the ambiguity of Horton's ordering. 
+In Strahler's ordering the main channel is not determined; instead the ordering
+is based on the hierarchy of tributaries. The ordering follows these rules:
 <OL>
-<li>if the node has no children, its Strahler order is 1.
-<li>if the node has one and only one tributuary with Strahler greatest order i, and all other tributuaries have order less than i, then the order remains i.
-<li>if the node has two or more tributuaries with greatest order i, then the Strahler order of the node is i + 1.
+<li>if the node has no children, its Strahler order is 1.
+<li>if the node has one and only one tributuary with Strahler greatest order i,
+and all other tributuaries have order less than i, then the order remains i.
+<li>if the node has two or more tributuaries with greatest order i, then the
+Strahler order of the node is i + 1.
 </OL>
-Strahler's stream ordering starts in initial links which assigns order one. It proceeds downstream. At every node it verifies that there are at least 2 equal tributaries with maximum order. If not it continues with highest order, if yes it increases the node's order by 1 and continues downstream with new order. 
+Strahler's stream ordering starts in initial links which assigns order one. It
+proceeds downstream. At every node it verifies that there are at least 2 equal
+tributaries with maximum order. If not it continues with highest order, if yes
+it increases the node's order by 1 and continues downstream with new order. 
 <BR>
 <B>Advantages and disadvantages of Strahler's ordering: </B>
- Strahler's stream order has a good mathematical background. All catchments with streams in this context are directed graphs, oriented from the root towards the leaves. Equivalent definition of the Strahler number of a tree is that it is the height of the largest complete binary tree that can be homeomorphically embedded into the given tree; the Strahler number of a node in a tree is equivalent to the height of the largest complete binary tree that can be embedded below that node. The disadvantage of that methods is the lack of distinguishing a main channel which may interfere with the analytical process in highly elongated catchments
-
+ Strahler's stream order has a good mathematical background. All catchments with
+streams in this context are directed graphs, oriented from the root towards the
+leaves. Equivalent definition of the Strahler number of a tree is that it is the
+height of the largest complete binary tree that can be homeomorphically embedded
+into the given tree; the Strahler number of a node in a tree is equivalent to
+the height of the largest complete binary tree that can be embedded below that
+node. The disadvantage of that methods is the lack of distinguishing a main
+channel which may interfere with the analytical process in highly elongated
+catchments
+
 <H4>Horton's stream order</H4>
-Horton's stream order applies to the stream as a whole but not to segments or links since the order on any channel remains unchanged from source till it "dies" in the higher order stream or in the outlet of the catchment. The main segment of the catchment gets the order of the whole catchment, while its tributaries get the order of their own subcatchments. The main difficulties of the Horton's order are criteria to be considered to distinguish between "true" first order segments and extension of higher order segments. That is the reason why Horton's ordering has rather historical sense and is substituted by the more unequivocal Strahler's ordering system. There are no natural algorithms to order stream network according to Horton' paradigm. The algorithm used in r.stream.order requires to first calculate Strahler's stream order (downstream) and next recalculate to Horton ordering (upstream). To make a decision about proper ordering it uses first Strahler ordering, and next, 
 if both branches have the same orders it uses flow accumulation to choose the actual link. The algorithm starts with the outlet, where the outlet link is assigned the corresponding Strahler order. Next it goes upstream and determines links according to Strahler ordering. If the orders of tributaries differ, the algorithm proceeds with the channel of highest order, if all orders are the same, it chooses that one with higher flow length rate or higher catchment area if accumulation is used. When it reaches the initial channel it goes back to the last undetermined branch, assign its Strahler order as Horton order and goes upstream to the next initial links. In that way stream orders remain unchanged from the point where Horton's order have been determined to the source. 
-  
+Horton's stream order applies to the stream as a whole but not to segments or
+links since the order on any channel remains unchanged from source till it
+"dies" in the higher order stream or in the outlet of the catchment. The main
+segment of the catchment gets the order of the whole catchment, while its
+tributaries get the order of their own subcatchments. The main difficulties of
+the Horton's order are criteria to be considered to distinguish between "true"
+first order segments and extension of higher order segments. That is the reason
+why Horton's ordering has rather historical sense and is substituted by the more
+unequivocal Strahler's ordering system. There are no natural algorithms to order
+stream network according to Horton' paradigm. The algorithm used in
+r.stream.order requires to first calculate Strahler's stream order (downstream)
+and next recalculate to Horton ordering (upstream). To make a decision about
+proper ordering it uses first Strahler ordering, and next, if both branches have
+the same orders it uses flow accumulation to choose the actual link. The
+algorithm starts with the outlet, where the outlet link is assigned the
+corresponding Strahler order. Next it goes upstream and determines links
+according to Strahler ordering. If the orders of tributaries differ, the
+algorithm proceeds with the channel of highest order, if all orders are the
+same, it chooses that one with higher flow length rate or higher catchment area
+if accumulation is used. When it reaches the initial channel it goes back to the
+last undetermined branch, assign its Strahler order as Horton order and goes
+upstream to the next initial links. In that way stream orders remain unchanged
+from the point where Horton's order have been determined to the source. 
+ 
 <BR>
-<B>Advantages and disadvantages of Horton's ordering:</B> 
-The main advantages of Horton's ordering is that it produces natural stream ordering with main streams and its tributaries. The main disadvantage is that it requires prior Strahler's ordering. In some cases this may result in unnatural ordering, where the highest order will be ascribed not to the channel with higher accumulation but to the channel which leads to the most branched parts of the the catchment. 
+<B>Advantages and disadvantages of Horton's ordering:</B> 
+The main advantages of Horton's ordering is that it produces natural stream
+ordering with main streams and its tributaries. The main disadvantage is that it
+requires prior Strahler's ordering. In some cases this may result in unnatural
+ordering, where the highest order will be ascribed not to the channel with
+higher accumulation but to the channel which leads to the most branched parts of
+the the catchment. 
 <P>
 <H4>Shreve's stream magnitude</H4>
-That ordering method is similar to Consisted Associated Integers proposed by Scheidegger. It assigns magnitude of 1 for every initial channel. The magnitude of the following channel is the sum of magnitudes of its tributaries. The number of a particular link is the number of initials which contribute to it. To achive Consisted Associated Integers the result of Shreve's magnitude is to be multiplied by 2: 
-<P>
+That ordering method is similar to Consisted Associated Integers proposed by
+Scheidegger. It assigns magnitude of 1 for every initial channel. The magnitude
+of the following channel is the sum of magnitudes of its tributaries. The number
+of a particular link is the number of initials which contribute to it. To achive
+Consisted Associated Integers the result of Shreve's magnitude is to be
+multiplied by 2: 
+<P>
 <code>r.mapcalc scheidegger=shreve*2</code>
-The algorithm is very similar to Strahler's algorithm, it proceeds downstream, and at every node the stream magnitude is the sum of its tributaries.
+The algorithm is very similar to Strahler's algorithm, it proceeds downstream,
+and at every node the stream magnitude is the sum of its tributaries.
 <P>
 <H4>Hack's main streams order</H4>
-This method of ordering calculates main streams of main catchment and every subcatchments. Main stream of every catchment is set to 1, and consequently all its tributaries receive order 2. Their tributaries receive order 3 etc. The order of every stream remains constant up to its initial link. The route of every main stream is determined according to the maximum flow length value of particular streams. So the main stream of every subcatchment is the longest stream or strean with highest accumulation rate if accumulation map is used. In most cases the main stream is the longest watercourse of the catchment, but in some cases, when a catchment consists of both rounded and elongated subcatchments these rules may not be maintained. The algorithm assigns 1 to every outlets stream and goes upstream according to maximum flow accumulation of every branch. When it reaches an initial stream it step back to the first unassigned confluence. It assigns order 2 to unordered tributaries an
 d again goes upstream to the next initial stream. The process runs until all branches of all outlets are ordered. 
-<BR>
-<B>Advantages and disadvantages of main stream ordering:</B>
-The biggest advantage of that method is the possibility to compare and analyze topology upstream, according to main streams. Because all tributaries of main channel have order of 2, streams can be quickly and easily filtered and its proprieties and relation to main stream determined. The main disadvantage of that method is the problem with the comparison of subcatchment topology of the same order. Subcatchments of the same order may be both highly branched and widespread in the catchment area and a small subcatchment with only one stream. 
+This method of ordering calculates main streams of main catchment and every
+subcatchments. Main stream of every catchment is set to 1, and consequently all
+its tributaries receive order 2. Their tributaries receive order 3 etc. The
+order of every stream remains constant up to its initial link. The route of
+every main stream is determined according to the maximum flow length value of
+particular streams. So the main stream of every subcatchment is the longest
+stream or strean with highest accumulation rate if accumulation map is used. In
+most cases the main stream is the longest watercourse of the catchment, but in
+some cases, when a catchment consists of both rounded and elongated
+subcatchments these rules may not be maintained. The algorithm assigns 1 to
+every outlets stream and goes upstream according to maximum flow accumulation of
+every branch. When it reaches an initial stream it step back to the first
+unassigned confluence. It assigns order 2 to unordered tributaries and again
+goes upstream to the next initial stream. The process runs until all branches of
+all outlets are ordered. 
+<BR>
+<B>Advantages and disadvantages of main stream ordering:</B>
+The biggest advantage of that method is the possibility to compare and analyze
+topology upstream, according to main streams. Because all tributaries of main
+channel have order of 2, streams can be quickly and easily filtered and its
+proprieties and relation to main stream determined. The main disadvantage of
+that method is the problem with the comparison of subcatchment topology of the
+same order. Subcatchments of the same order may be both highly branched and
+widespread in the catchment area and a small subcatchment with only one stream. 
 <H4>Topological dimension streams order</H4>
-This method of ordering calculates topological distance of every stream from catchment outlet. The topopological distance is defined as the number of segments which separates the current segment from the outlet basin 
+This method of ordering calculates topological distance of every stream from
+catchment outlet. The topopological distance is defined as the number of
+segments which separates the current segment from the outlet basin 
 <BR>
 
 
 <H4>Stream network topology table description</H4>
 	<li><b>cat</b> integer: category;
 	<li><b>stream</b>integer: stream number, usually equal to cat;
-	<li><b>next_stream</b> integer: stream to which contribute current stream (downstream);
+	<li><b>next_stream</b> integer: stream to which contribute current
+stream (downstream);
 	<li><b>prev_streams</b>; two or more contributing streams (upstream);
 	<li><b>strahler</b> integer: Strahler's stream order:
 	<li><b>horton</b> integer: Hortons's stream order:
@@ -97,13 +194,22 @@
 	<li><b>topo</b> integer: Topological dimension streams order;
 	<li><b>length</b> double precision: stream length;
 	<li><b>cum_length</b> double precision: length of stream from source;
-	<li><b>out_dist</b> double precision: distance of current stream init from outlet;
+	<li><b>out_dist</b> double precision: distance of current stream init
+from outlet;
 	<li><b>stright</b> double precision: length of stream as stright line;
-	<li><b>fractal</b> double precision: fractal dimention: stream length/stright stream length
+	<li><b>fractal</b> double precision: fractal dimention: stream
+length/stright stream length
 
 <h2>NOTES</H2>
 <P>
-Module can work only if direction map, stream map and region map has same settings. It is also required that stream map and direction map come from the same source. For lots of reason this limitation probably cannot be omitted. 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 f direction map comes from r.stream.extract  must be patched by direction map from r.watershed. (with r.patch). 
+Module can work only if direction map, stream map and region map has same
+settings. It is also required that stream map and direction map come from the
+same source. For lots of reason this limitation probably cannot be omitted. 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 f direction map comes from
+r.stream.extract  must be patched by direction map from r.watershed. (with
+r.patch). 
 
 <h2>SEE ALSO</h2>
 
@@ -117,16 +223,22 @@
 
 
 <h2>REFERENCES</h2>
-Claps, P., Fiorentino, M., Oliveto, G., (1994), <i>Informational entropy of fractal river networks</i>,
+Claps, P., Fiorentino, M., Oliveto, G., (1994), <i>Informational entropy of
+fractal river networks</i>,
 Journal of Hydrology, 187(1-2), 145-156 .</p>
-Hack, J., (1957), <i>Studies of longitudinal stream profiles in Virginia and Maryland</i>, 
+Hack, J., (1957), <i>Studies of longitudinal stream profiles in Virginia and
+Maryland</i>, 
 <b>U.S. Geological Survey Professional Paper</b>, 294-B<p>
-Horton, R. E. (1945), <i>Erosional development of streams and their drainage basins: hydro-physical approach to quantitative morphology</i>, 
+Horton, R. E. (1945), <i>Erosional development of streams and their drainage
+basins: hydro-physical approach to quantitative morphology</i>, 
 <b>Geological Society of America Bulletin</b> 56 (3): 275-370<p>
-Shreve, R., <i>Statistical Law of Stream Numbers</i>, <b>J. Geol.</b>, 74, (1966), 17-37.<p>
-Strahler, A. N. (1952), <i>Hypsometric (area-altitude) analysis of erosional topology</i>, 
+Shreve, R., <i>Statistical Law of Stream Numbers</i>, <b>J. Geol.</b>, 74,
+(1966), 17-37.<p>
+Strahler, A. N. (1952), <i>Hypsometric (area-altitude) analysis of erosional
+topology</i>, 
 <b>Geological Society of America Bulletin</b> 63 (11): 1117–1142<p>
-Strahler, A. N. (1957), <i>Quantitative analysis of watershed geomorphology</i>, 
+Strahler, A. N. (1957), <i>Quantitative analysis of watershed
+geomorphology</i>, 
 <b>Transactions of the American Geophysical Union</b> 8 (6): 913–920.<p>
 
 
@@ -134,8 +246,5 @@
 <h2>AUTHOR</h2>
 Jarek  Jasiewicz, Markus Metz
 
-<HR>
-<P><a href="index.html">Main index</a> - <a href="raster.html">raster index</a> - <a href="full_index.html">Full index</a></P>
-<P>&copy; 2003-2009 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
-</body>
-</html>
+<p><i>Last changed: $Date$</i>
+

Modified: grass-addons/raster/r.stream.pos/description.html
===================================================================
--- grass-addons/raster/r.stream.pos/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.pos/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -1,43 +1,81 @@
 <h2>OPTIONS</h2>
 <DL>
 <DT><b>-s</b></DT>
-<DD>Creates new category sequence for stream network instead of original. It may be usefull for calculating pixel position in ordered network (i.e Strahler or Horton). By defualt it use original category of streams</DD>
+<DD>Creates new category sequence for stream network instead of original. It may
+be usefull for calculating pixel position in ordered network (i.e Strahler or
+Horton). By defualt it use original category of streams</DD>
 <p>
 <DT><b>stream</b></DT>
-<DD>Stream network: name of input stream map on which calculation are be performed produced by r.watershed, r.stream.extract or r.stream.order. 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, r.stream.extract and r.stream.order. If not 0 or NULL use <a href="r.mapcalc.html">r.mapcalc</a> to set background values to null.  
+<DD>Stream network: name of input stream map on which calculation are be
+performed produced by r.watershed, r.stream.extract or r.stream.order. 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,
+r.stream.extract and r.stream.order. If not 0 or NULL use <a
+href="r.mapcalc.html">r.mapcalc</a> to set background values to null.  
 </DD>
 <p>
 <DT><b>dir</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 the module informs about it and stops. Region boundary
+<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 the module informs about it and stops. Region
+boundary
 and maps boundary may be differ but it may lead to unexpected results.</DD>
 
 <p>
 <DT><b>multipier</b></DT>
-<DD>Integer used to multiply stream category for cells output map. Default is 1000. To store in one file both origial stream category and current pixel position the stream category is multipied by multipier and next current cell position is added.
- For typical network, where stream segments are below 1000 cells such multipier seems to be enough. For bigger networks or ordered networks may be to small in that multiper shall be increased to larger number: 10000 or 100000. Wrong multipier (ie not power of 10) do not stop calculation but may lead to wrong results.</DD>
+<DD>Integer used to multiply stream category for cells output map. Default is
+1000. To store in one file both origial stream category and current pixel
+position the stream category is multipied by multipier and next current cell
+position is added.
+ For typical network, where stream segments are below 1000 cells such multipier
+seems to be enough. For bigger networks or ordered networks may be to small in
+that multiper shall be increased to larger number: 10000 or 100000. Wrong
+multipier (ie not power of 10) do not stop calculation but may lead to wrong
+results.</DD>
 
 <h2>OUTPUTS</h2>
 
 <P>At least one output map is required: </p>
 <DT><b>cells</b></DT>
-<DD>Name of integer map storing both original (or new) stream category and current pixel downstream position  according formula <CODE>category * multipier + cur_pix_pos</CODE>.</DD>
+<DD>Name of integer map storing both original (or new) stream category and
+current pixel downstream position  according formula <CODE>category * multipier
++ cur_pix_pos</CODE>.</DD>
 
 <DT><b>lengths</b></DT>
-<DD>Name of floation point map storing current pixel upstream distance (in map units) to the begining of the stream. Categoy is not stored.</DD>
+<DD>Name of floation point map storing current pixel upstream distance (in map
+units) to the begining of the stream. Categoy is not stored.</DD>
 
 
 <h2>DESCRIPTION</h2>
 <P>
-Module r.stream.pos is typical helper module which can be used to fine-tune investigation on stream network at pixel scale and linear geostatistics. Module can be used together with other GRASS modules and R-CRAN to investigate local geomorphometric properties at any stream position.
+Module r.stream.pos is typical helper module which can be used to fine-tune
+investigation on stream network at pixel scale and linear geostatistics. Module
+can be used together with other GRASS modules and R-CRAN to investigate local
+geomorphometric properties at any stream position.
 
-For limiting oputput size, cells stores two informations in one file. To recive current pixel stream category use (in R-CRAN) function <CODE>floor(cells, multipier)</CODE>, where multipier is the multipier value used in r.stream.pos calculation. To recive current pixel position in segment use modulo operator: <CODE>cell %% multipier</CODE>. The lengths map store only upstream distance in map units from current pixel to the stream begining.
+For limiting oputput size, cells stores two informations in one file. To recive
+current pixel stream category use (in R-CRAN) function <CODE>floor(cells,
+multipier)</CODE>, where multipier is the multipier value used in r.stream.pos
+calculation. To recive current pixel position in segment use modulo operator:
+<CODE>cell %% multipier</CODE>. The lengths map store only upstream distance in
+map units from current pixel to the stream begining.
 
 
 <h2>NOTES</H2>
 <P>
-Module can work only if direction map, stream map and region map has same settings. It is also required that stream map and direction map come from the same source. For lots of reason this limitation probably cannot be omitted. 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.
+Module can work only if direction map, stream map and region map has same
+settings. It is also required that stream map and direction map come from the
+same source. For lots of reason this limitation probably cannot be omitted. 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.
 
 <h2>SEE ALSO</h2>
 
@@ -51,8 +89,5 @@
 <h2>AUTHOR</h2>
 Jarek  Jasiewicz
 
-<HR>
-<P><a href="index.html">Main index</a> - <a href="raster.html">raster index</a> - <a href="full_index.html">Full index</a></P>
-<P>&copy; 2003-2009 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
-</body>
-</html>
+<p><i>Last changed: $Date: 2010-11-13 13:02:26 +0100 (Sat, 13 Nov 2010) $</i>
+

Modified: grass-addons/raster/r.stream.stats/description.html
===================================================================
--- grass-addons/raster/r.stream.stats/description.html	2011-05-01 20:37:17 UTC (rev 46153)
+++ grass-addons/raster/r.stream.stats/description.html	2011-05-01 23:50:30 UTC (rev 46154)
@@ -2,32 +2,62 @@
 <DL>
 
 <DT><b>stream</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>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>
 <p>
 <DT><b>dir</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 the module informs about it and stops. Region boundary and maps boundary may be differ but it may lead to unexpected results.</DD>
+<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 the module informs about it and stops. Region
+boundary and maps boundary may be differ but it may lead to unexpected
+results.</DD>
 <p>
 <DT><b>elev</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>
+<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>
 
 
 
 <h2>OUTPUTS</h2>
-Output statistics are send to standard output. If there are no errors no addational messages are send to standard output. To redirect output to file use redarection operators: > or >>.
+Output statistics are send to standard output. If there are no errors no
+addational messages are send to standard output. To redirect output to file use
+redarection operators: > or >>.
 </DL>
 
 <h2>DESCRIPTION</h2>
 <P>
-Module r.stream.stats is prepared to calculate Hotron's statistics of drainage network.
+Module r.stream.stats is prepared to calculate Hotron's statistics of drainage
+network.
 <P>
-These statistics are calculated according formulas given by R.Horton (1945). Because Horton do not defined precisely what is stream slope, I proposed 2 different approaches: first (slope) use cell-by-cell slope calculation, second (gradient) use difference between elevation of outlet and source of every channel to its length to calculate formula. Bifurcation ratio for every order is calculated acording formula: 
+These statistics are calculated according formulas given by R.Horton (1945).
+Because Horton do not defined precisely what is stream slope, I proposed 2
+different approaches: first (slope) use cell-by-cell slope calculation, second
+(gradient) use difference between elevation of outlet and source of every
+channel to its length to calculate formula. Bifurcation ratio for every order is
+calculated acording formula: 
 <P>
 <CODE>n_streams[1]/n_stream[i+1]</CODE>
 <P> 
-where i the current order and i+1 next higher order. For max order of the map number of streams is zero. Rest of the ratios are calculated in similar mode. The bifurcation and other ratios for the whole catchment (map) is calculated as mean i.e sum of all bifurcation ratio / max_order-1 (for max_order stream bifurcation ratio = 0)
-It is strongly recommended to extract stream network using basin map created with r.stream.basin. If whole stream order map is used the calculation will be performed but results may not have hydrological sense.
+where i the current order and i+1 next higher order. For max order of the map
+number of streams is zero. Rest of the ratios are calculated in similar mode.
+The bifurcation and other ratios for the whole catchment (map) is calculated as
+mean i.e sum of all bifurcation ratio / max_order-1 (for max_order stream
+bifurcation ratio = 0)
+It is strongly recommended to extract stream network using basin map created
+with r.stream.basin. If whole stream order map is used the calculation will be
+performed but results may not have hydrological sense.
 
 For every order (std) means that statstic is calculated with standard deviation:
 <UL>
@@ -39,7 +69,8 @@
 
 <li>average length of streams of given order (std)
 <li>average slope (cell by cell inclination) of streams of given order (std)
-<li>average gradient (spring to outlet inclination ) of streams of given order (std)
+<li>average gradient (spring to outlet inclination ) of streams of given order
+(std)
 <li>average area of basins of given order (std)
 <li>avarage elevation difference of given order (std)
 <P>ratios:
@@ -65,15 +96,28 @@
 
 <h2>NOTES</h2>
 <P>
-Module calculates statistics for all streams in input stream map.It is strongly recomended to extract only network of one basin, but it is not necessary for computation.  Streams for desired basin first can be extracted  with following mapcalc formula:
+Module calculates statistics for all streams in input stream map.It is strongly
+recomended to extract only network of one basin, but it is not necessary for
+computation.  Streams for desired basin first can be extracted  with following
+mapcalc formula:
 
 <P>
-<CODE>echo 'sel_streams=if(basin==xxx,streams,null())'|r.mapcalc #xxx category of desired basin<CODE>
+<CODE>echo 'sel_streams=if(basin==xxx,streams,null())'|r.mapcalc #xxx category
+of desired basin<CODE>
 <P>
 
-It is also possible to calculate Horton's statistics for Shreve ordering but it has limited hydrological sense. Hack main stream is not the same what so called Horton's reverse ordering.
+It is also possible to calculate Horton's statistics for Shreve ordering but it
+has limited hydrological sense. Hack main stream is not the same what so called
+Horton's reverse ordering.
 <P>
-Module can work only if direction map, stream map and region map has same settings. It is also required that stream map and direction map come from the same source. For lots of reason this limitation probably cannot be omitted.   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 f direction map comes from r.stream.extract  must be patched by direction map from r.watershed. (with r.patch).
+Module can work only if direction map, stream map and region map has same
+settings. It is also required that stream map and direction map come from the
+same source. For lots of reason this limitation probably cannot be omitted.  
+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 f direction map comes from
+r.stream.extract  must be patched by direction map from r.watershed. (with
+r.patch).
 
 <h2>SEE ALSO</h2>
 
@@ -90,3 +134,5 @@
 <h2>AUTHOR</h2>
 Jarek Jasiewicz
 
+<p><i>Last changed: $Date$</i>
+



More information about the grass-commit mailing list