[GRASS-SVN] r46155 - in grass-addons/grass7/raster/r.stream:
r.stream.basins r.stream.channel r.stream.distance
r.stream.order r.stream.segment r.stream.slope r.stream.snap
r.stream.stats
svn_grass at osgeo.org
svn_grass at osgeo.org
Sun May 1 19:56:54 EDT 2011
Author: neteler
Date: 2011-05-01 16:56:53 -0700 (Sun, 01 May 2011)
New Revision: 46155
Modified:
grass-addons/grass7/raster/r.stream/r.stream.basins/r.stream.basins.html
grass-addons/grass7/raster/r.stream/r.stream.channel/r.stream.channel.html
grass-addons/grass7/raster/r.stream/r.stream.distance/r.stream.distance.html
grass-addons/grass7/raster/r.stream/r.stream.order/r.stream.order.html
grass-addons/grass7/raster/r.stream/r.stream.segment/r.stream.segment.html
grass-addons/grass7/raster/r.stream/r.stream.slope/r.stream.slope.html
grass-addons/grass7/raster/r.stream/r.stream.snap/r.stream.snap.html
grass-addons/grass7/raster/r.stream/r.stream.stats/r.stream.stats.html
Log:
html slightly prettified
Modified: grass-addons/grass7/raster/r.stream/r.stream.basins/r.stream.basins.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.basins/r.stream.basins.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.basins/r.stream.basins.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,31 +1,62 @@
<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>
<DT><b>-c</b></DT>
-<DD>By default r.stream.basins uses streams category as basin category. In some cases - for example if stream map is product of map algebra and separete streams may not have unique values this option will create new category sequence for each basin (do not work in vector point mode)
+<DD>By default r.stream.basins uses streams category as basin category. In some
+cases - for example if stream map is product of map algebra and separete streams
+may not have unique values this option will create new category sequence for
+each basin (do not work in vector point mode)
</DD>
<DT><b>-l</b></DT>
-<DD>By default r.stream.basins create basins for all unique streams. This option delinate basins only for last streams ignoring upstreams (do not work in vector point mode).
+<DD>By default r.stream.basins create basins for all unique streams. This option
+delinate basins only for last streams ignoring upstreams (do not work in vector
+point mode).
</DD>
<DT><b>dirs</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 (if used) and direction 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 (if used) and direction 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>
<DT><b>coors</b></DT>
-<DD>East and north coordinates for basin outlet. It can delinate only one basin using that option. This option simply copies funcionality of <a href="r.water.outlet.html">r.water.outlet</a>.
+<DD>East and north coordinates for basin outlet. It can delinate only one basin
+using that option. This option simply copies funcionality of <a
+href="r.water.outlet.html">r.water.outlet</a>.
</DD>
<DT><b>streams</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>
<DT><b>cats</b></DT>
-<DD>Stream categories to delineate basins for: All categories which are not in stream map are ignored. It can be used with stream network created by r.watershed, r.stream.extract or r.stream.order. For r.stream.order use category of order for which basins must be created. For example to delineate only basins for order two use cats=2. If you need unique category for every basin use -c flag.
+<DD>Stream categories to delineate basins for: All categories which are not in
+stream map are ignored. It can be used with stream network created by
+r.watershed, r.stream.extract or r.stream.order. For r.stream.order use category
+of order for which basins must be created. For example to delineate only basins
+for order two use cats=2. If you need unique category for every basin use -c
+flag.
</DD>
<DT><b>points</b></DT>
-<DD>Vector file containing basins outlet as vector points. Only point's categories are used to prepare basins. Table attached to it is ignored. Every point shall heve his own unique category. In that mode flags -l and -c are ignored
+<DD>Vector file containing basins outlet as vector points. Only point's
+categories are used to prepare basins. Table attached to it is ignored. Every
+point shall heve his own unique category. In that mode flags -l and -c are
+ignored
</DD>
</DL>
@@ -36,21 +67,48 @@
<h2>DESCRIPTION</h2>
-Module r.stream.basins is prepared to delineate basins and subasins with different input data. Module is prepared to delineate unrestricted number of basins in one step. It can delineate basins with three methods:
+Module r.stream.basins is prepared to delineate basins and subasins 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: his option simply copies funcionality of <a href="r.water.outlet.html">r.water.outlet</a>.
+<LI>Using coordinates: his option simply copies funcionality of <a
+href="r.water.outlet.html">r.water.outlet</a>.
<LI>Using vector points: it allow to mannually point outlets with any method
-<LI>Using streams (most advanced) it allow on lots of modifications. See examples for more details.
+<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 require two maps: direction and streams. In spite of in stream map we can store information required to proper delineation, we can also enumarate 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.recalss</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 delineate 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 c
ommon category.
+The most recommended method require two maps: direction and streams. In spite of
+in stream map we can store information required to proper delineation, we can
+also enumarate 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.recalss</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
+delineate 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 streams. On the other way basins could results with very small area. Input maps must be in CELL format (default output of r.watershed, r.stream.order and r.stream.extract)<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).
+To receive good results outlets markers created by user shall overlapping with
+streams. On the other way basins could results with very small area. Input maps
+must be in CELL format (default output of r.watershed, r.stream.order and
+r.stream.extract)<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).
<h2>EXAMPLES</h2>
<P>
@@ -58,7 +116,9 @@
<P>
<CODE>r.stream.basins dir=dirs stream=streams basins=bas_basins_elem</CODE>
<P>
-To determine major and minor basins in area, definied by outlets, ignoring subbasins use - l flag. That flag ignores all nodes and uses only real outlets (in most cases that on map border):
+To determine major and minor basins in area, definied by outlets, ignoring
+subbasins use - l flag. That flag ignores all nodes and uses only real outlets
+(in most cases that on map border):
<P>
<CODE>r.stream.basins -l dir=dirs stream=streams basins=bas_basins_last</CODE>
@@ -66,7 +126,8 @@
<CODE>r.stream.basins dir=dirs coors=639936.623832,216939.836449</CODE>
<P>
-To delineate one or more particular basins defined by given streams, add simply stream categories:
+To delineate one or more particular basins defined by given streams, add simply
+stream categories:
<CODE>
r.stream.basins -lc dirs=dirs streams=streams cats=2,7,184 basins=bas_basin
</CODE>
@@ -75,29 +136,41 @@
Do delineate basins of particular order we must use the following procedure:
<CODE>
-r.stream.basins -lc dirs=dirs streams=strahler cats=2 basins=bas_basin_strahler_2
+r.stream.basins -lc dirs=dirs streams=strahler cats=2
+basins=bas_basin_strahler_2
</CODE>
<P>
-The usage of polygons as outlets markers is very useful when exact stream course cannot be cleary determined before running analysis, but the area of its occurrence can be determined (mostly in iterative simulations) Example uses r.circle but can be substituted by any polygon created for example with v.digit:
+The usage of polygons as outlets markers is very useful when exact stream course
+cannot be cleary determined before running analysis, but the area of its
+occurrence can be determined (mostly in iterative simulations) Example uses
+r.circle but can be substituted by any polygon created for example with
+v.digit:
<CODE>
r.circle -b output=circle coordinate=639936.623832,216939.836449 max=200
r.stream.basins -c dirs=dirs streams=circle basins=bas_simul
</CODE>
<P>
-To determine areas of contribution to streams of particular order use as streams the result of ordering:
+To determine areas of contribution to streams of particular order use as
+streams the result of ordering:
<P>
-<CODE>r.stream.basins dirs=dirs streams=ord_strahler basins=bas_basin_strahler</CODE>
+<CODE>r.stream.basins dirs=dirs streams=ord_strahler
+basins=bas_basin_strahler</CODE>
<P>
-Determination of areas of potential source of pollution. The example will be done for lake marked with FULL_HYDR 8056 in North Carolina sample dataset. The lake shall be extracted and converted to binary raster map.
+Determination of areas of potential source of pollution. The example will be
+done for lake marked with FULL_HYDR 8056 in North Carolina sample dataset. The
+lake shall be extracted and converted to binary raster map.
<CODE>
-v.extract -d input=lakes at PERMANENT output=lake8056 type=area layer=1 'where=FULL_HYDRO = 8056' new=-1
+v.extract -d input=lakes at PERMANENT output=lake8056 type=area layer=1
+'where=FULL_HYDRO = 8056' new=-1
v.to.rast input=lake8056 output=lake8056 use=val type=area layer=1 value=1
r.stream.basins dirs=dirs streams=lake8056 basins=bas_basin_lake
</CODE>
<P>
-See aslo tutorial: <a href="http://grass.osgeo.org/wiki/R.stream.*">http://grass.osgeo.org/wiki/R.stream.*</a>
+See also tutorial: <a
+href="http://grass.osgeo.org/wiki/R.stream.*">http://grass.osgeo.org/wiki/R.
+stream.*</a>
<h2>SEE ALSO</h2>
@@ -112,4 +185,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.channel/r.stream.channel.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.channel/r.stream.channel.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.channel/r.stream.channel.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -5,60 +5,103 @@
<DT><b>-c</b></DT>
<DD>Calculate distance in cells instead of meters. See output for detials.</DD>
<DT><b>-d</b></DT>
-<DD>Calculate downstream distance (from current cell DOWNSTREAM to outlet/join). Default is upstream (from current cell upstream to init/join.</DD>
+<DD>Calculate downstream distance (from current cell DOWNSTREAM to outlet/join).
+Default is upstream (from current cell upstream to init/join.</DD>
<DT><b>-m</b></DT>
-<DD>Only for very large data sets. Use segment library to optimize memory consumption during analysis</DD>
+<DD>Only for very large data sets. Use segment library to optimize memory
+consumption during analysis</DD>
<DT><b>stream</b></DT>
-<DD>Stream network: name of input stream map. Map may be ordered according one of the r.stream.order ordering system as well as unordered (with origilan stream identifiers) 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. Map may be ordered according one
+of the r.stream.order ordering system as well as unordered (with origilan stream
+identifiers) 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>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>
<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 streams and dirs.</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 streams and
+dirs.</DD>
</DL>
<h2>OUTPUTS</h2>
<DL>
<DT><b>distance</b></DT>
<DD>Upstream distance of current cell to the init/join. Flag modifications: <BR>
<b>d:</b> downstream distance of current cell to the join/outlet;<BR>
-<b>l:</b> local distance between current cell and next cell. In most cases cell resolution and sqrt2 of cell resolution. usefull when projection is LL or NS and WE resolutions differs. Flag d ignored<BR>
-<b>c:</b> distance in cells. Map is written as double. Use mapcalc to convetrt to integer. Flags l and d ignored.<BR>
+<b>l:</b> local distance between current cell and next cell. In most cases cell
+resolution and sqrt2 of cell resolution. usefull when projection is LL or NS and
+WE resolutions differs. Flag d ignored<BR>
+<b>c:</b> distance in cells. Map is written as double. Use mapcalc to convetrt
+to integer. Flags l and d ignored.<BR>
</DD>
<DT><b>difference</b></DT>
-<DD>Upstream elevation difference between current cell to the init/join. It we need to calculate parameters different than elevation. If we need to calculate different parameters than elevation along streams (for example precipitation or so) use neccesary map as elevation. Flag modifications: <BR>
+<DD>Upstream elevation difference between current cell to the init/join. It we
+need to calculate parameters different than elevation. If we need to calculate
+different parameters than elevation along streams (for example precipitation or
+so) use neccesary map as elevation. Flag modifications: <BR>
<b>d:</b> downstream difference of current cell to the join/outlet;<BR>
-<b>l:</b> local difference between current cell and next cell. With flag calculates difference between previous cell and current cell<BR>
+<b>l:</b> local difference between current cell and next cell. With flag
+calculates difference between previous cell and current cell<BR>
<b>c:</b> Ignored.
</DD>
<DT><b>gradient</b></DT>
-<DD>Upstream mean gradient between current cell and the init/join. Flag modifications: <BR>
-<b>d:</b> downstream mean gradient between current cell and the the join/outlet;<BR>
+<DD>Upstream mean gradient between current cell and the init/join. Flag
+modifications: <BR>
+<b>d:</b> downstream mean gradient between current cell and the the
+join/outlet;<BR>
<b>l:</b> local gradient between current cell and next cell. Flag d ignored<BR>
<b>c:</b> Ignored.
</DD>
<DT><b>curvature</b></DT>
-<DD>Local stream course curvature of current cell. Calculated according formula: <i>first_derivative/(1-second_derivative<sup>2</sup>)<sup>3/2</sup></i> Flag modifications: <BR>
+<DD>Local stream course curvature of current cell. Calculated according
+formula: <i>first_derivative/(1-second_derivative<sup>2</sup>)<sup>3/2</sup></i>
+Flag modifications: <BR>
<b>d:</b> ignored;<BR>
<b>l:</b> Ignored.<BR>
<b>c:</b> Ignored.
</DD>
<DT><b>identifier</b></DT>
-<DD> Integer map: In ordered stream network there are more than one segment (segment: a part of the network where order ramains unchanged) with the same order. To identify particular segments (for further analysis) every segment recive his unique identifier.</DD>
+<DD> Integer map: In ordered stream network there are more than one segment
+(segment: a part of the network where order ramains unchanged) with the same
+order. To identify particular segments (for further analysis) every segment
+recive his unique identifier.</DD>
</DL>
<h2>DESCRIPTION</h2>
<P>
-Module r.stream.channel is prepared to calculate some local properties of the stream network. It is suplementary module for r.stream.order, and r.stream.distance to investigate channel subsystem. For slope subsystem parameters is r.stream.slope. It may use ordered or unordered network. It calculate parameters for every segment between it init to outlet/join to the next stream. it also may calculate parameters between outlet and segment's init. It can calculate parameters for every orders but best results are for these orders where order remains unchanged from stream init to natural outlet (Hack and Horton ordering).
+Module r.stream.channel is prepared to calculate some local properties of the
+stream network. It is suplementary module for r.stream.order, and
+r.stream.distance to investigate channel subsystem. For slope subsystem
+parameters is r.stream.slope. It may use ordered or unordered network. It
+calculate parameters for every segment between it init to outlet/join to the
+next stream. it also may calculate parameters between outlet and segment's init.
+It can calculate parameters for every orders but best results are for these
+orders where order remains unchanged from stream init to natural outlet (Hack
+and Horton ordering).
<P>
<h2>EGZAMPLE</h2>
-This example shows how to visualise the change of gradient map along the main stream of the catchment:
+This example shows how to visualise the change of gradient map along the main
+stream of the catchment:
<PRE>
<CODE>
r.watershed elevation=elevation.10m treshold=1000 stream=streams drainage=dirs
r.stream.order streams=streams dirs=dirs hack=hack
-r.stream.channel streams=hack dirs=dirs elevation=elevation.10m identifier=stream_identifier gradient=stream_gradient distance=stream_distance
+r.stream.channel streams=hack dirs=dirs elevation=elevation.10m
+identifier=stream_identifier gradient=stream_gradient distance=stream_distance
#495 is a stream identifier. May be different in different situaltion
r.mapcalc stgrad=if(stream_identifier==495,float(stream_gradient),null())
r.mapcalc stdist=if(stream_identifier==495,float(stream_distance),null())
@@ -85,4 +128,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.distance/r.stream.distance.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.distance/r.stream.distance.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.distance/r.stream.distance.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,51 +1,111 @@
<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 choose only last outlets in the network ignoring nodes.</DD>
+<DD>Outlets. Downstream method only. Calculate distance and relative elevation
+to basin outlets instead of streams. It choose 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 create distance and elevation parameters not for whole basins but for all elementary subbasins.</DD>
+<DD>Subbasins. Downstream method only. Calculate distance and elevation to
+stream nodes instead of streams. It create distance and elevation parameters not
+for whole basins but for all elementary subbasins.</DD>
<DT><b>-n</b></DT>
-<DD>Near. For upstram 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>Near. For upstram 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>
-<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>
<DT><b>dirs</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>
<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>
+<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>
<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 <b>upstream</b> from any cell upstream to the nearest maximum or divide</DD>
+<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
+<b>upstream</b> from any cell upstream to the nearest maximum or divide</DD>
</DL>
<h2>OUTPUTS</h2>
<DL>
<DT><b>difference</b></DT>
-<DD>Returns elevation difference to the targer (outlet, node, stream, divide, maximum) along watercoures. The map is of FCELL type</DD>
+<DD>Returns elevation difference to the targer (outlet, node, stream, divide,
+maximum) along watercoures. The map is of FCELL type</DD>
<DT><b>distance</b></DT>
-<DD>Returns distance to the targer (outlet, node, stream, divide, maximum) along watercoures. The map is of FCELL type</DD>
+<DD>Returns distance to the targer (outlet, node, stream, divide, maximum) along
+watercoures. The map is of FCELL type</DD>
</DL>
<h2>DESCRIPTION</h2>
<P>
-Module r.stream.distance may calculate distance using two methods: downstream and upstream.
+Module r.stream.distance may calculate distance using two methods: downstream
+and upstream.
<P>
-The default is downstream method when it calculate distance to streams and outlets and relative elevation to streams and outlets. The distance and elevation is calculated along watercourses. In outlets mode it can also calculate parameters for subbasins.
+The default is downstream method when it calculate distance to streams and
+outlets and relative elevation to streams and outlets. The distance and
+elevation is calculated along watercourses. In outlets mode it can also
+calculate parameters for subbasins.
<P>
-In streams mode (default) it calculates that parameters downstream to streams which are added as stream mask. In outlets mode there are some additional possibilities. If subbasin is off it calculate parameters only for last point of last (downstream) CELL. In subbasin mode it calculates parameters for every subbasin separately. Subbasin mode acts similar to subbasin mask. Streams file prepared to create basins and subbasins with r.stream.basins can use to to calculate distance and elevation parameters.
+In streams mode (default) it calculates that parameters downstream to streams
+which are added as stream mask. In outlets mode there are some additional
+possibilities. If subbasin is off it calculate parameters only for last point of
+last (downstream) CELL. In subbasin mode it calculates parameters for every
+subbasin separately. Subbasin mode acts similar to subbasin mask. Streams file
+prepared to create basins and subbasins with r.stream.basins can use to to
+calculate distance and elevation parameters.
<P>
-With upstream method it calculate distance to the local maximum or divide. Opposite to downstream method, where every cell has one and only one downstream cell in upstream method every cell has usssualy more than one upstream cell. So it is impossible to determine nterchangeable path from any cell. The upstream method offers two alternative modes switched with -n flag: nearest local maximum/divide: means the shortest path to local maximum and default option farthest maximum/divide means the longest path. In hydrological sense nearest mode means the shortest path which particle of water must run from divide to reach particular cell, while farthest mode means the possible longest path.
+With upstream method it calculate distance to the local maximum or divide.
+Opposite to downstream method, where every cell has one and only one downstream
+cell in upstream method every cell has usssualy more than one upstream cell. So
+it is impossible to determine nterchangeable path from any cell. The upstream
+method offers two alternative modes switched with -n flag: nearest local
+maximum/divide: means the shortest path to local maximum and default option
+farthest maximum/divide means the longest path. In hydrological sense nearest
+mode means the shortest path which particle of water must run from divide to
+reach particular cell, while farthest mode means the possible longest path.
<h2>NOTES</h2>
<P>
-If there are more than one point or one stream networks and some separate points or separate streams networks are in catchment area defined by others it will results as in subbasin mode. In stream mode subbasin options is ommited. Input maps must be in CELL format (default output of r.watershed, r.stream.order and r.stream.extract)
-The distance are calculated in meters both for planimeters and Latitude-Longitude projections. The distance is calculated for flat areas not corrected by topography. Distance correction by topography may be done with following mapcalc formula:
+If there are more than one point or one stream networks and some separate points
+or separate streams networks are in catchment area defined by others it will
+results as in subbasin mode. In stream mode subbasin options is ommited. Input
+maps must be in CELL format (default output of r.watershed, r.stream.order and
+r.stream.extract)
+The distance are calculated in meters both for planimeters and
+Latitude-Longitude projections. The distance is calculated for flat areas not
+corrected by topography. Distance correction by topography may be done with
+following mapcalc formula:
<P>
<CODE>echo 'dist_corrected = sqrt(distance^2 + elevation ^2)'|r.mapcalc<CODE>
<P>
-Module can work only if direction map, stream map and region 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 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.
<P>
-Probably one of the most imortant features of r.stream.extract is the ability to calculate distnace not only for streams generated with r.stream.order, but also to any CELL map with resoultion coresponding to dirs map. It can be a lake, swamp, depression and lake boundaries even divided into smaller fragments each with its own category.
+Probably one of the most imortant features of r.stream.extract is the ability to
+calculate distnace not only for streams generated with r.stream.order, but also
+to any CELL map with resoultion coresponding to dirs map. It can be a lake,
+swamp, depression and lake boundaries even divided into smaller fragments each
+with its own category.
<h2>SEE ALSO</h2>
<em>
@@ -58,4 +118,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.order/r.stream.order.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.order/r.stream.order.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.order/r.stream.order.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,31 +1,59 @@
+<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>
<DT><b>-a</b></DT>
-<DD>Uses accumulation map instead of cumulated stream length to determine main branch at bifuraction. Works well only with SFD networks</DD>
+<DD>Uses accumulation map instead of cumulated stream length to determine main
+branch at bifuraction. Works well only with SFD networks</DD>
<DT><b>-m</b></DT>
-<DD>Only for very large data sets. Use segment library to optimise memory consumption during analysis</DD>
+<DD>Only for very large data sets. Use segment library to optimise memory
+consumption during analysis</DD>
<DT><b>stream network map</b></DT>
-<DD>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>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>flow direction map</b></DT>
-<DD>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>direction</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>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>direction</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>
<DT><b>accumulation map</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>
<DT><b>elevation map</b></DT>
-<DD>Used to calculate geometrical properites of the network stored in the table.</DD>
+<DD>Used to calculate geometrical properites of the network stored in the
+table.</DD>
</DL>
<h2>OUTPUTS</h2>
<P>At least one output map is required: </p>
<DL>
<DT><b>vector</b></DT>
-<DD>Vector network with table where stream network topology can be stored. Because r.stream.order is prepared to work both with r.watershed and r.stream.extract, it may be yused to create correct vector from r.watershed results.<DD>
+<DD>Vector network with table where stream network topology can be stored.
+Because r.stream.order is prepared to work both with r.watershed and
+r.stream.extract, it may be yused to create correct vector from r.watershed
+results.<DD>
<DT><b>strahler</b></DT>
<DD>Name of Strahler's stream order output map: see notes for detail. </DD>
@@ -34,96 +62,193 @@
<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
+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 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. Thqat 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. Thqat 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.
+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.
+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.
<H4>Scheidegger's stream magnitude</H4>
-That ordering method is similar to Shreve's stream magnitude. It assigns magnitude of 2 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 streams -1 contributing to it. Consisted Associated Integers (Scheidegger) is aviallable only in attribute table. To achive Consisted Associated Integers (Scheidegger) raster the result of Shreve's magnitude is to be multiplied by 2:
+That ordering method is similar to Shreve's stream magnitude. It assigns
+magnitude of 2 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 streams -1 contributing to it. Consisted Associated Integers
+(Scheidegger) is aviallable only in attribute table. To achive Consisted
+Associated Integers (Scheidegger) raster the result of Shreve's magnitude is to
+be multiplied by 2:
<P>
<code>r.mapcalc scheidegger=shreve*2</code>
<P>
<H4>Drwal's stream hierarchy (old style)</H4>
-That ordering method is a compromise between Strahler ordering and Shreve magnitude. It assigns order of 1 for every initial channel. The order of the following channel is calculated according Strahler formula, except, that streams which do not increase order of next channel are not lost. To increase next channel to the hiher order R+1 are require two channels of order R, or one R and two R-1 or one R, and four R-2 or one R, one R-1 and two R-2 etc. The the order of particular link show the possible value of Strahler'order if the network was close to idealised binary tree. Drwal's order is aviallable only in attribute table.To achive Drwal's raster the result of Shreve's magnitude is to be recalculated according formula: <b>floor(log(shreve,2))+1</b>
+That ordering method is a compromise between Strahler ordering and Shreve
+magnitude. It assigns order of 1 for every initial channel. The order of the
+following channel is calculated according Strahler formula, except, that streams
+which do not increase order of next channel are not lost. To increase next
+channel to the hiher order R+1 are require two channels of order R, or one R and
+two R-1 or one R, and four R-2 or one R, one R-1 and two R-2 etc. The the order
+of particular link show the possible value of Strahler'order if the network was
+close to idealised binary tree. Drwal's order is aviallable only in attribute
+table.To achive Drwal's raster the result of Shreve's magnitude is to be
+recalculated according formula: <b>floor(log(shreve,2))+1</b>
<P>
<code>r.mapcalc drwal=int(log(shreve,2))+1</code>
<P>
<B>Advantages and disadvantages of Drwal's hierarhy:</B>
-The main advantages of Drwal's hierarchy is that it produces natural stream ordering with whcich takes into advantage both ordering and magnitude. It shows the real impact of particular links of the network run-off. The main desadvantage is that it minimise bifuraction ratio ot the network.
+The main advantages of Drwal's hierarchy is that it produces natural stream
+ordering with whcich takes into advantage both ordering and magnitude. It shows
+the real impact of particular links of the network run-off. The main
+desadvantage is that it minimise bifuraction ratio ot the network.
<P>
<H4>Hack's main streams or Gravelius 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.
+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.
+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.
+This method of ordering calculates topological distance of every stream from
+catchment outlet.
<BR>
<H4>Stream network topology table description connected with vector file</H4>
<ul>
<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:
<li><b>shreve</b> integer: Shreve's stream magnitude;
- <li><b>scheidegger</b> integer: Scheidegger's Consisted Associated Integers;
+ <li><b>scheidegger</b> integer: Scheidegger's Consisted Associated
+Integers;
<li><b>drwal</b> integer: Drwal's stream hierarchy;
<li><b>hack</b> integer: Hack's main streams or Gravelius order;
<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>sinusiod</b> double precision: fractal dimention: stream length/stright stream length;
+ <li><b>sinusiod</b> double precision: fractal dimention: stream
+length/stright stream length;
<li><b>elev_init</b> double precision: elevation of stream init;
<li><b>elev_outlet</b> double precision: elevation of stream outlet;
- <li><b>drop</b> double precision: difference between stream init and outlet + drop outlet;
+ <li><b>drop</b> double precision: difference between stream init and
+outlet + drop outlet;
<li><b>out_drop</b> double precision: drop at the outlet of the stream;
<li><b>gradient</b> double precision: drop/length;
</ul>
<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>
@@ -136,17 +261,29 @@
</em>
<h2>REFERENCES</h2>
-Drwal, J., (1982), <i>Wykształecenie i organizacja sieci hydrograficznej jako podstawa oceny struktury odpływu na terenach młodoglacjalnych</i>, <b>Rozprawy i monografie</b>, Gdańsk 1982, 130 pp (in Polish)<p>
-Hack, J., (1957), <i>Studies of longitudinal stream profiles in Virginia and Maryland</i>,
+Drwal, J., (1982), <i>Wykształecenie i organizacja sieci hydrograficznej jako
+podstawa oceny struktury odpływu na terenach młodoglacjalnych</i>, <b>Rozprawy i
+monografie</b>, Gdańsk 1982, 130 pp (in Polish)<p>
+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>,<b>Geological Society of America Bulletin</b> 56 (3): 275-370<BR>
-Scheidegger A. E., (1966), <i>Statistical Description of River Networks</i>. <b>Water Resour. Res.</b>, 2(4): 785-790
-Shreve, R., (1966),<i>Statistical Law of Stream Numbers</i>, <b>J. Geol.</b>, 74, 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>,<b>Transactions of the American Geophysical Union</b> 8 (6): 913–920.<p>
-Woldenberg, M. J., (1967), <i>Geography and properties of surfaces,</i> <b>Harvard Papers in Theoretical Geography</b>, 1: 95–189.
+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<BR>
+Scheidegger A. E., (1966), <i>Statistical Description of River Networks</i>.
+<b>Water Resour. Res.</b>, 2(4): 785-790
+Shreve, R., (1966),<i>Statistical Law of Stream Numbers</i>, <b>J. Geol.</b>,
+74, 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>,<b>Transactions of the American Geophysical Union</b> 8 (6):
+913–920.<p>
+Woldenberg, M. J., (1967), <i>Geography and properties of surfaces,</i>
+<b>Harvard Papers in Theoretical Geography</b>, 1: 95–189.
<h2>AUTHOR</h2>
Jarek Jasiewicz
-</body>
-</html>
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.segment/r.stream.segment.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.segment/r.stream.segment.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.segment/r.stream.segment.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,3 +1,5 @@
+<h2>DESCRIPTION</h2>
+
<h2>OPTIONS</h2>
<DL>
<DT><b>-r</b></DT>
@@ -3,25 +5,58 @@
<DD>Directions and azimut output in radians. Default is degrees.</DD>
<DT><b>-m</b></DT>
-<DD>Only for very large data sets. Use segment library to optimize memory consumption during analysis</DD>
+<DD>Only for very large data sets. Use segment library to optimize memory
+consumption during analysis</DD>
<DT><b>stream</b></DT>
-<DD>Stream network: name of input stream map. Streams shall be ordered according one of the r.stream.order ordering system as well as unordered (with original stream identifiers) 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. Streams shall be ordered according
+one of the r.stream.order ordering system as well as unordered (with original
+stream identifiers) 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>
-<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>
<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 streams and dirs.</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 streams and
+dirs.</DD>
<DT><b>length</b></DT>
-<DD>Integer values indicating the search length (in cells) to determine stright line. The longest length parameter the module treats more tolerant local stream undulation and inequalities. Default value of 15 is suitable for 30 meters DEMS. More detail DEMS may requre longer length.</DD>
+<DD>Integer values indicating the search length (in cells) to determine stright
+line. The longest length parameter the module treats more tolerant local stream
+undulation and inequalities. Default value of 15 is suitable for 30 meters
+DEMS. More detail DEMS may requre longer length.</DD>
<DT><b>skip</b></DT>
-<DD>Integer values indicating the length (in cells) local short segment to skip and join them to the longer neigbour. The shortest length parameter the more short segments will be produced by the module due to undulation and inequalities. Default value of 5 is suitable for 30 meters DEMS. More details DEMS may requre longer length.</DD>
+<DD>Integer values indicating the length (in cells) local short segment to skip
+and join them to the longer neigbour. The shortest length parameter the more
+short segments will be produced by the module due to undulation and
+inequalities. Default value of 5 is suitable for 30 meters DEMS. More details
+DEMS may requre longer length.</DD>
<DT><b>treshold</b></DT>
-<DD>real value indicates the internal angle between upstream and downsteam direction to treat actual cell as lying on the stright line. Grater value (up to 180 degrees) produces more segments. Lesser values produced less segments. Values below 90 in most cases will not produce any addational segments to these resulting from ordering
+<DD>real value indicates the internal angle between upstream and downsteam
+direction to treat actual cell as lying on the stright line. Grater value (up to
+180 degrees) produces more segments. Lesser values produced less segments.
+Values below 90 in most cases will not produce any addational segments to these
+resulting from ordering
</DL>
<DL>
<h2>OUTPUTS</h2>
-<P>The module produces two vector maps: one representing original segments (where segment is a streamline where its order remains unchanged) and second divided into near stright line sectors resulting form segmentation proccess. Most of segment and sectors attributes are the same as in r.stream.order vector output.</p>
+<P>The module produces two vector maps: one representing original segments
+(where segment is a streamline where its order remains unchanged) and second
+divided into near stright line sectors resulting form segmentation proccess.
+Most of segment and sectors attributes are the same as in r.stream.order vector
+output.</p>
<DL>
<DT><b>segments</b></DT>
@@ -36,21 +71,30 @@
<li><B>direction</B>: double precision, full segment direction (0-360)
<li><B>azimuth</B>: double precision, full segment azimuth (0-180)
<li><B>length</B>: double precision, segment length
-<li><B>stright</B>: double precision, length of stright line between segment nodes
+<li><B>stright</B>: double precision, length of stright line between segment
+nodes
<li><B>sinusoid</B>: double precision, sinusoid (length/stright)
-<li><B>elev_min</B>: double precision, minimum elevation (elevation at segment start)
-<li><B>elev_max</B>: double precision, maximum elevation (elevation at segment end)
-<li><B>s_drop</B>: double precision, deifference between start and end of the segment
+<li><B>elev_min</B>: double precision, minimum elevation (elevation at segment
+start)
+<li><B>elev_max</B>: double precision, maximum elevation (elevation at segment
+end)
+<li><B>s_drop</B>: double precision, deifference between start and end of the
+segment
<li><B>gradient</B>: double precision, drop/length
-<li><B>out_direction</B>: double precision, direction (0-360) of segment end sector
+<li><B>out_direction</B>: double precision, direction (0-360) of segment end
+sector
<li><B>out_azimuth</B>: double precision, azimuth (0-180) of segment end sector
<li><B>out_length</B>: double precision, length of segment end sector
<li><B>out_drop</B>: double precision, drop of segment end sector
<li><B>out_gradient</B>: double precision, gradient of segment end sector
-<li><B>tangent_dir</B>: double precision, direction of tangent in segment outlet to the next stream
-<li><B>tangent_azimuth</B>: double precision, azimuth of tangent in segment outlet to the next stream
-<li><B>next_direction</B>: double precision, direction of next stream in join with current segment
-<li><B>next_azimuth</B>: double precision, azimuth of next stream in join with current segment
+<li><B>tangent_dir</B>: double precision, direction of tangent in segment outlet
+to the next stream
+<li><B>tangent_azimuth</B>: double precision, azimuth of tangent in segment
+outlet to the next stream
+<li><B>next_direction</B>: double precision, direction of next stream in join
+with current segment
+<li><B>next_azimuth</B>: double precision, azimuth of next stream in join with
+current segment
</ul>
<img src="dirs.png">
</DD>
@@ -63,28 +107,65 @@
<li><B>direction</B>: double precision, sector direction
<li><B>azimuth</B>: double precision, sector azimuth
<li><B>length</B>: double precision, sector length
-<li><B>stright</B>: double precision, length of stright line between sector nodes
+<li><B>stright</B>: double precision, length of stright line between sector
+nodes
<li><B>sinusoid</B>: double precision, sinusoid (length/stright)
-<li><B>elev_min</B>: double precision, minimum elevation (elevation at sector start)
-<li><B>elev_max</B>: double precision, minimum elevation (elevation at sector end)
-<li><B>s_drop</B>: double precision, deifference between start and end of the sector
+<li><B>elev_min</B>: double precision, minimum elevation (elevation at sector
+start)
+<li><B>elev_max</B>: double precision, minimum elevation (elevation at sector
+end)
+<li><B>s_drop</B>: double precision, deifference between start and end of the
+sector
<li><B>gradient</B>: double precision, drop/length
</ul>
<img src="sectors.png">
Relation between segments and sector may be set up by segment key.
</DD>
</DL>
-<h2>DESCRIPTION</h2>
<P>
-The main idea comes from works of Horton (1932) and Howard (1971, 1990). The module is designed to inverstigate network lineaments and calculate angle relations between tributaries and its major streams. The main problem in calculating directional parameters is that streams usually are not straight lines. Therefore as the first step of the procedure, partitioning of streams into near-straight-line segments is required.
+The main idea comes from works of Horton (1932) and Howard (1971, 1990). The
+module is designed to inverstigate network lineaments and calculate angle
+relations between tributaries and its major streams. The main problem in
+calculating directional parameters is that streams usually are not straight
+lines. Therefore as the first step of the procedure, partitioning of streams
+into near-straight-line segments is required.
<P>
-The segmentation process uses a method similar to the one used by Van & Ventura (1997) to detect corners and partition curves into straight lines and gentle arcs. Because it is almost impossible to determine exactly straight sections without creating numerous very short segments, the division process requires some approximation. The approximation is made based on three parameters: (1) the downstream/upstream search length, (2) the short segment skipping threshold, and (3) the maximum angle between downstream/upstream segments to be considered as a straight line. In order to designate straight sections of the streams, the algorithm is searching for those points where curves significantly change their direction.
-The definition of stream segments depends on the ordering method selected by the user, Strahler's, Horton's or Hack's main stream, or the network may remain unordered. All junctions of streams to streams of higher order are always split points, but for ordered networks, streams of higher order may be divided into sections which ignore junctions with streams of lower order. In unordered networks all junctions are always split points.
-In extended mode the module also calculates the direction of a stream to its higher order stream If the higher order stream begins at the junction with the current stream (Strahler's ordering only) or if the network is unordered, the direction is calculated as the direction of the line between junction point and downstream point (Howard 1971) within the user-defined global search distance. If a higher order stream continues at the junction, its direction is calculated as the direction of the tangent line to the stream of higher order at the junction point. To avoid local fluctuation, the tangent line is approximated as a secant line joining downstream/upstream points at a distance globally defined by the search length parameter (1). Such a definition of the angle between streams is not fully compatible with Horton's original criterion.
+The segmentation process uses a method similar to the one used by Van & Ventura
+(1997) to detect corners and partition curves into straight lines and gentle
+arcs. Because it is almost impossible to determine exactly straight sections
+without creating numerous very short segments, the division process requires
+some approximation. The approximation is made based on three parameters: (1) the
+downstream/upstream search length, (2) the short segment skipping threshold, and
+(3) the maximum angle between downstream/upstream segments to be considered as a
+straight line. In order to designate straight sections of the streams, the
+algorithm is searching for those points where curves significantly change their
+direction.
+The definition of stream segments depends on the ordering method selected by the
+user, Strahler's, Horton's or Hack's main stream, or the network may remain
+unordered. All junctions of streams to streams of higher order are always split
+points, but for ordered networks, streams of higher order may be divided into
+sections which ignore junctions with streams of lower order. In unordered
+networks all junctions are always split points.
+In extended mode the module also calculates the direction of a stream to its
+higher order stream If the higher order stream begins at the junction with the
+current stream (Strahler's ordering only) or if the network is unordered, the
+direction is calculated as the direction of the line between junction point and
+downstream point (Howard 1971) within the user-defined global search distance.
+If a higher order stream continues at the junction, its direction is calculated
+as the direction of the tangent line to the stream of higher order at the
+junction point. To avoid local fluctuation, the tangent line is approximated as
+a secant line joining downstream/upstream points at a distance globally defined
+by the search length parameter (1). Such a definition of the angle between
+streams is not fully compatible with Horton's original criterion.
<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>
@@ -100,10 +181,19 @@
</em>
<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.
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.slope/r.stream.slope.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.slope/r.stream.slope.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.slope/r.stream.slope.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,29 +1,44 @@
+<h2>DESCRIPTION</h2>
+
<h2>OPTIONS</h2>
<DL>
<DT><b>dirs</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.</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.</DD>
<DT><b>elevation</b></DT>
-<DD>Elevation: name of input elevation map or any other map we want to calculate . Map can be of type CELL, FCELL or DCELL. It is not restricted to resolution of region settings like <b>dirs</b>. </DD>
+<DD>Elevation: name of input elevation map or any other map we want to calculate
+. Map can be of type CELL, FCELL or DCELL. It is not restricted to resolution of
+region settings like <b>dirs</b>. </DD>
</DL>
<h2>OUTPUTS</h2>
<DL>
<DT><b>difference</b></DT>
-<DD>Downstream elevation difference: Difference between elevation of current cell and downstream cell. Shall always be posivtive. Negative values show, that current cell is pit or depression cell. Module is prepared to be used with elevation but can be also used to calculate local difference of any feature along watercourses in slope subsystem. In that way elevation map must be replaced by map we want to calculate. If we use differnt map than elevation, rest of parameters have no sense to calculate</DD>
+<DD>Downstream elevation difference: Difference between elevation of current
+cell and downstream cell. Shall always be posivtive. Negative values show, that
+current cell is pit or depression cell. Module is prepared to be used with
+elevation but can be also used to calculate local difference of any feature
+along watercourses in slope subsystem. In that way elevation map must be
+replaced by map we want to calculate. If we use differnt map than elevation,
+rest of parameters have no sense to calculate</DD>
<DT><b>gradient</b></DT>
-<DD>Downstream gradinet: Downstream elevation difference divided by distance.</DD>
+<DD>Downstream gradinet: Downstream elevation difference divided by
+distance.</DD>
<DT><b>maxcurv</b></DT>
-<DD>Maximum linear curvature along watercourse.Calculated along watercourse between highest upstream cell, current cell and downstream cell (there can be only one or no downstream cell but more than on upstream)</DD>
+<DD>Maximum linear curvature along watercourse.Calculated along watercourse
+between highest upstream cell, current cell and downstream cell (there can be
+only one or no downstream cell but more than on upstream)</DD>
<DT><b>maxcurv</b></DT>
-<DD>Calculated along watercourse between lowest upstream cell, current cell and downstream cell (there can be only one or no downstream cell but more than on upstream)</DD>
+<DD>Calculated along watercourse between lowest upstream cell, current cell and
+downstream cell (there can be only one or no downstream cell but more than on
+upstream)</DD>
</DL>
-<h2>DESCRIPTION</h2>
-<P>
-Module r.stream.local is suplementary module for r.stream to calculate local parameters of slope subsystem.
-<P>
-
<h2>SEE ALSO</h2>
<em>
@@ -35,4 +50,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.snap/r.stream.snap.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.snap/r.stream.snap.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.snap/r.stream.snap.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,48 +1,77 @@
+<h2>DESCRIPTION</h2>
+<P>
+Module r.stream.snap is a suplementary module for r.stream.extract and
+r.stream.basins to correct position of outlets or stream init points as they do
+not lie on the streamliens.
+<BR>
+For outlets situation is clear. Points are snapped to nearest point whcich lies
+on the streamline. In situaltion where there can be a small tributuary nearer
+than main stream accumulation treshold shall be high enough to force program
+ignoring this tributuary and snap to the main stream. If there is no
+accumulation map points will be snapped to nearest stream line whcich in
+particular situation may be wrong. Bacuase r.stream is perepared to work with
+MFD accum maps, both stream network and accum map is neccesary to resolve the
+problem.
+<BR>
+While it is assumed accum map is a MFD map, if stream network is not supplied,
+snap point is calculated in different way: treshold is used to select only these
+points in search radius wchich are accum value is greater than treshold. Next
+mean value of these points is calculated and its value is taken as a new
+treshold. This procedure guarantee that points are snapped to the center of
+stream tube. While for inits small tresholds are in use, it is probable than
+points were snapped to the streamtube border instead of its center.
+</p>
+<p>
+It is strongly recommended, to use both stream network (even pre-genearted with
+small accum treshold) and accumulation map, than accum or stream map only.
+</p>
+
<h2>OPTIONS</h2>
<DL>
<DT><b>streams</b></DT>
-<DD>Stream network created by r.stream.extract or r.watershed. If used, points are snapped to the nearest streamline point which accumulation is grater than treshold. If accumulation is not used point is snapped to the nearest stream. </DD>
+<DD>Stream network created by r.stream.extract or r.watershed. If used, points
+are snapped to the nearest streamline point which accumulation is grater than
+treshold. If accumulation is not used point is snapped to the nearest stream.
+</DD>
<DT><b>accum</b></DT>
-<DD>Accumulation map created with r.waterhed and used to genearte stream network with r.stream.extract. If stream network is not in use, point is adaptively snapped to the to point where value is greater than mean values of accumulation grater than given treshold in a searcyh radius. See description for details.
+<DD>Accumulation map created with r.waterhed and used to genearte stream network
+with r.stream.extract. If stream network is not in use, point is adaptively
+snapped to the to point where value is greater than mean values of accumulation
+grater than given treshold in a searcyh radius. See description for details.
</DD>
<DT><b>radius</b></DT>
-<DD>Search radius (in cells). If there are no streams in search radius, point is not snapped. If there are no cells with accumulation grater than accumtreshold point also is not snapped.
+<DD>Search radius (in cells). If there are no streams in search radius, point is
+not snapped. If there are no cells with accumulation grater than accumtreshold
+point also is not snapped.
</DD>
<DT><b>accumtres</b></DT>
-<DD>Minimum value of accumulation which cell must have to snap point. This option is added to snap stream inits to the stream tubes and to distinguish between local tributuaries and main streams.
+<DD>Minimum value of accumulation which cell must have to snap point. This
+option is added to snap stream inits to the stream tubes and to distinguish
+between local tributuaries and main streams.
</DD>
<DT><b>input</b></DT>
-<DD>Vector file containing outlets or inits as vector points. Only point's categories are used Table attached to it is ignored. Every point shall heve his own unique category.
+<DD>Vector file containing outlets or inits as vector points. Only point's
+categories are used Table attached to it is ignored. Every point shall heve his
+own unique category.
</DD>
</DL>
<h2>OUTPUTS</h2>
-<P>Vector file containing outlets or inits after snapping. On layer 1 oryginal categories are preserved, on layer 2 there are four categories which mean:</p>
+<P>Vector file containing outlets or inits after snapping. On layer 1 oryginal
+categories are preserved, on layer 2 there are four categories which mean:</p>
<ol>
<li>skipped (not in use yet)
<li>unresolved (points remain unsnapped due to lack of streams in search radius
<li>snapped (points snapped to streamlines)
-<li>correct (points whcich remain on its original position, wchich was originally corected
+<li>correct (points whcich remain on its original position, wchich was
+originally corected
</ol>
-
-<h2>DESCRIPTION</h2>
-<P>
-Module r.stream.snap is a suplementary module for r.stream.extract and r.stream.basins to correct position of outlets or stream init points as they do not lie on the streamliens.
-<BR>
-For outlets situation is clear. Points are snapped to nearest point whcich lies on the streamline. In situaltion where there can be a small tributuary nearer than main stream accumulation treshold shall be high enough to force program ignoring this tributuary and snap to the main stream. If there is no accumulation map points will be snapped to nearest stream line whcich in particular situation may be wrong. Bacuase r.stream is perepared to work with MFD accum maps, both stream network and accum map is neccesary to resolve the problem.
-<BR>
-While it is assumed accum map is a MFD map, if stream network is not supplied, snap point is calculated in different way: treshold is used to select only these points in search radius wchich are accum value is greater than treshold. Next mean value of these points is calculated and its value is taken as a new treshold. This procedure guarantee that points are snapped to the center of stream tube. While for inits small tresholds are in use, it is probable than points were snapped to the streamtube border instead of its center.
-</p>
-<p>
-It is strongly recommended, to use both stream network (even pre-genearted with small accum treshold) and accumulation map, than accum or stream map only.
-</p>
-
<h2>SEE ALSO</h2>
<em>
@@ -57,4 +86,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
Modified: grass-addons/grass7/raster/r.stream/r.stream.stats/r.stream.stats.html
===================================================================
--- grass-addons/grass7/raster/r.stream/r.stream.stats/r.stream.stats.html 2011-05-01 23:50:30 UTC (rev 46154)
+++ grass-addons/grass7/raster/r.stream/r.stream.stats/r.stream.stats.html 2011-05-01 23:56:53 UTC (rev 46155)
@@ -1,33 +1,69 @@
<h2>OPTIONS</h2>
<DL>
<DT><b>-c</b></DT>
-<DD>Print only catchment's characteristics. Useful for shell script calculation or collecting data in external tables</DD>
+<DD>Print only catchment's characteristics. Useful for shell script calculation
+or collecting data in external tables</DD>
<DT><b>-o</b></DT>
-<DD>Print only prameters for every order. Usefull to visualise Horton's law with external software (see example)</DD>
+<DD>Print only prameters for every order. Usefull to visualise Horton's law with
+external software (see example)</DD>
<DT><b>-m</b></DT>
-<DD>Only for very large data sets. Use segment library to optimise memory consumption during analysis</DD>
+<DD>Only for very large data sets. Use segment library to optimise memory
+consumption during analysis</DD>
<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>
<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>
<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 streams and dirs.</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 streams and
+dirs.</DD>
<h2>OUTPUTS</h2>
-Output statistics are send to standard output. To redirect output to file use redirection operators: > or >>. If redirection is used, output messages are printed on stderr (ussually terminal) while statistics are written to the file. Statistics can be print as a formatted summary information with number of parameters or as a catchement's descriptive statistics and table with statistics for every order.
+Output statistics are send to standard output. To redirect output to file use
+redirection operators: > or >>. If redirection is used, output messages are
+printed on stderr (ussually terminal) while statistics are written to the file.
+Statistics can be print as a formatted summary information with number of
+parameters or as a catchement's descriptive statistics and table with statistics
+for every order.
<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, it has been proposed 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, it has been
+proposed 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:
<CODE>n_streams[1]/n_stream[i+1]</CODE>
-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 +75,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:
@@ -62,22 +99,36 @@
<li>area ratio (std)
</ul>
<P>
-For the whole basins ratios are calculated acording two formulas: as a mean of ratios for every order, or as a antilog of slope coeficient of the regression model: order vs. log10(parameter)
+For the whole basins ratios are calculated acording two formulas: as a mean of
+ratios for every order, or as a antilog of slope coeficient of the regression
+model: order vs. log10(parameter)
<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 no hydrological sense. Hack (or Gravelius hierarchy) main stream is not the same what so called Horton's reverse ordering (see: Horton 1945).
+It is also possible to calculate Horton's statistics for Shreve ordering but it
+has no hydrological sense. Hack (or Gravelius hierarchy) main stream is not the
+same what so called Horton's reverse ordering (see: Horton 1945).
<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>EXAMPLE</h2>
-Create table with order statistics. This table can easily sended to exteranl program (like R) to be visulised:
+Create table with order statistics. This table can easily sended to exteranl
+program (like R) to be visulised:
<PRE>
<CODE>
r.stream.stats -o streams=horton dirs=dirs elevation=elevation.10m > tmp_file
@@ -103,4 +154,8 @@
</em>
<h2>AUTHOR</h2>
-Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation Institute.
+Jarek Jasiewicz, Adam Mickiewicz University, Geoecology and Geoinformation
+Institute.
+
+<p><i>Last changed: $Date$</i>
+
More information about the grass-commit
mailing list