[GRASS-SVN] r34566 - grass-addons/raster/r.watershed2/front

svn_grass at osgeo.org svn_grass at osgeo.org
Thu Nov 27 17:59:32 EST 2008


Author: neteler
Date: 2008-11-27 17:59:32 -0500 (Thu, 27 Nov 2008)
New Revision: 34566

Modified:
   grass-addons/raster/r.watershed2/front/description.html
Log:
use small caps tags + author

Modified: grass-addons/raster/r.watershed2/front/description.html
===================================================================
--- grass-addons/raster/r.watershed2/front/description.html	2008-11-27 22:59:30 UTC (rev 34565)
+++ grass-addons/raster/r.watershed2/front/description.html	2008-11-27 22:59:32 UTC (rev 34566)
@@ -1,107 +1,107 @@
-<H2>DESCRIPTION</H2>
+<h2>DESCRIPTION</h2>
 
-<EM>r.watershed</EM> generates a set of maps indicating:
+<em>r.watershed</em> generates a set of maps indicating:
 1) the location of watershed basins, and
 2) the LS and S factors of the Revised Universal Soil Loss Equation (RUSLE).
 
-<P>
+<p>
 <!-- Interactive mode not activated in GRASS 6.
-<EM>r.watershed</EM> can be run either interactively or non-interactively.
+<em>r.watershed</em> can be run either interactively or non-interactively.
 If the user types <tt>r.watershed</tt>
 on the command line without program arguments, the program will prompt the user
 with a verbose description of the input maps.  The interactive version of
-<EM>r.watershed</EM> can prepare inputs to lumped-parameter hydrologic models.
-After a verbose interactive session, <EM>r.watershed</EM> will query the user
+<em>r.watershed</em> can prepare inputs to lumped-parameter hydrologic models.
+After a verbose interactive session, <em>r.watershed</em> will query the user
 for a number of
 map layers.  Each map layer's values will be tabulated by watershed basin and sent
 to an output file.  This output file is organized to ease data entry into a
 lumped-parameter hydrologic model program.  The non-interactive version of
-<EM>r.watershed</EM> cannot create this file.
+<em>r.watershed</em> cannot create this file.
 
-<P>
+<p>
 The user can run the program non-interactively, by specifying input map names
 on the command line. Parameter names may be specified by their
 full names, or by any initial string that distinguish them from other parameter names.
-In <EM>r.watershed</EM>'s case, the first two letters of each name sufficiently
+In <em>r.watershed</em>'s case, the first two letters of each name sufficiently
 distinguishes parameter names.
-For example, the two expressions below are equivalent inputs to <EM>r.watershed</EM>:
-<P>
-<PRE>
+For example, the two expressions below are equivalent inputs to <em>r.watershed</em>:
+<p>
+<pre>
  el=elev.map th=100 st=stream.map ba=basin.map
 
  elevation=elev.map threshold=100 stream=stream.map basin=basin.map
-</PRE>
+</pre>
 -->
-<H2>OPTIONS</H2>
+<h2>OPTIONS</h2>
 
 <dl>
-<DT><EM>-m</EM> 
+<dt><em>-m</em> 
 
-<DD>Without this flag set, the entire analysis is run in memory
+<dd>Without this flag set, the entire analysis is run in memory
 maintained by the operating system.  This can be limiting, but is
 relatively fast.  Setting the flag causes the program to manage memory
 on disk which allows larger maps to be processes but is considerably
 slower.
 
-<DT><EM>-4</EM> 
+<dt><em>-4</em> 
 
-<DD>Allow only horizontal and vertical flow of water.
+<dd>Allow only horizontal and vertical flow of water.
 Stream and slope lengths are approximately the same as outputs from default surface
 flow (allows horizontal, vertical, and diagonal flow of water).
 This flag will also make the drainage basins look more homogeneous.
 
-<DT><EM>elevation</EM> 
+<dt><em>elevation</em> 
 
-<DD>Input map: Elevation on which entire analysis is based.
+<dd>Input map: Elevation on which entire analysis is based.
 
-<DT><EM>depression</EM> 
+<dt><em>depression</em> 
 
-<DD>Input map:  Map layer of actual depressions or sinkholes in the
+<dd>Input map:  Map layer of actual depressions or sinkholes in the
 landscape that are large enough to slow and store surface runoff from 
 a storm event.  Any non-zero values indicate depressions.
 
-<DT><EM>flow</EM> 
+<dt><em>flow</em> 
 
-<DD>Input map: amount of overland flow per cell.  This map indicates the
+<dd>Input map: amount of overland flow per cell.  This map indicates the
 amount of overland flow units that each cell will contribute to the
 watershed basin model.  Overland flow units represent the amount of
 overland flow each cell contributes to surface flow.  If omitted, a
 value of one (1) is assumed. The algorithm is D8 flow accumulation.
 
-<DT><EM>disturbed.land</EM> 
+<dt><em>disturbed_land</em> 
 
-<DD>Raster map input layer or value containing the percent of disturbed
+<dd>Raster map input layer or value containing the percent of disturbed
 land (i.e., croplands, and construction sites) where the raster or input
-value of 17 equals 17%.  If no map or value is given, <EM>r.watershed</EM>
+value of 17 equals 17%.  If no map or value is given, <em>r.watershed</em>
 assumes no disturbed land.  This input is used for the RUSLE calculations.
 
-<DT><EM>blocking</EM> 
+<dt><em>blocking</em> 
 
-<DD>Input map: terrain that will block overland surface flow.  Terrain
+<dd>Input map: terrain that will block overland surface flow.  Terrain
 that will block overland surface flow and restart the slope length
 for the RUSLE.  Any non-zero values indicate blocking terrain.
 
-<DT><EM>threshold</EM> 
+<dt><em>threshold</em> 
 
-<DD>The minimum size of an exterior watershed basin in cells, if no flow
+<dd>The minimum size of an exterior watershed basin in cells, if no flow
 map is input, or overland flow units when a flow map is given.
 Warning: low threshold values will dramactically increase run time and
-generate difficult too read basin and half.basin results.
+generate difficult too read basin and half_basin results.
 This parameter also controls the level of detail in the <em>stream</em>
 segments map.
 
-<DT><EM>max.slope.length</EM> 
+<dt><em>max_slope_length</em> 
 
-<DD>Input value indicating the maximum length of overland surface flow
+<dd>Input value indicating the maximum length of overland surface flow
 in meters.  If overland flow travels greater than the maximum length,
 the program assumes the maximum length (it assumes that landscape
 characteristics not discernible in the digital elevation model exist
 that maximize the slope length).  This input is used for the RUSLE calculations
 and is a sensitive parameter.
 
-<DT><EM>accumulation</EM> 
+<dt><em>accumulation</em> 
 
-<DD>Output map: The absolute value of each cell in this output map layer is
+<dd>Output map: The absolute value of each cell in this output map layer is
 the amount of overland flow that traverses the cell. This value will be
 the number of upland cells plus one if no overland flow map is given. If
 the overland flow map is given, the value will be in overland flow units.
@@ -110,9 +110,9 @@
 negative values cannot have their surface runoff and sedimentation yields
 calculated accurately.
 
-<DT><EM>drainage</EM> 
+<dt><em>drainage</em> 
 
-<DD>Output map: drainage direction.  Provides the "aspect" for each
+<dd>Output map: drainage direction.  Provides the "aspect" for each
 cell.  Multiplying positive values by 45 will give the direction in
 degrees that the surface runoff will travel from that cell.  The
 value -1 indicates that the cell is a depression area (defined by
@@ -121,124 +121,124 @@
 region.  The absolute value of these negative cells indicates the
 direction of flow.
 
-<DT><EM>basin</EM> 
+<dt><em>basin</em> 
 
-<DD>Output map: Unique label for each watershed basin.  Each basin will
+<dd>Output map: Unique label for each watershed basin.  Each basin will
 be given a unique positive even integer.  Areas along edges may not
 be large enough to create an exterior watershed basin.  0 values
 indicate that the cell is not part of a complete watershed basin
 in the current geographic region.
 
-<DT><EM>stream</EM> 
+<dt><em>stream</em> 
 
-<DD>Output map: stream segments.  Values correspond to the watershed
+<dd>Output map: stream segments.  Values correspond to the watershed
 basin values.
 
-<DT><EM>half.basin</EM> 
+<dt><em>half_basin</em> 
 
-<DD>Output map: each half-basin is given a unique value.  Watershed
+<dd>Output map: each half-basin is given a unique value.  Watershed
 basins are divided into left and right sides.  The right-hand side
 cell of the watershed basin (looking upstream) are given even values
 corresponding to the values in basin.  The left-hand side
 cells of the watershed basin are given odd values which are one less
 than the value of the watershed basin.
 
-<DT><EM>visual</EM> 
+<dt><em>visual</em> 
 
-<DD>Output map: useful for visual display of results.
+<dd>Output map: useful for visual display of results.
 Surface runoff accumulation with the values
 modified to provide for easy display.  All negative accumulation values
 are changed to zero.  All positive values above the basin threshold
 are given the value of the <em>threshold</em> parameter.
 
-<DT><EM>length.slope</EM> 
+<dt><em>length_slope</em> 
 
-<DD>Output map: slope length and steepness (LS) factor.  Contains the LS
+<dd>Output map: slope length and steepness (LS) factor.  Contains the LS
 factor for the Revised Universal Soil Loss Equation.  Equations taken
-from <EM>Revised Universal Soil Loss Equation for Western Rangelands</EM>
+from <em>Revised Universal Soil Loss Equation for Western Rangelands</em>
 (Weltz et al. 1987).
 Since the LS factor is a small number, it is multiplied by 100 for the
 GRASS output map.
 
-<DT><EM>slope.steepness</EM> 
+<dt><em>slope_steepness</em> 
 
-<DD>Output map: slope steepness (S) factor for RUSLE.
+<dd>Output map: slope steepness (S) factor for RUSLE.
 Contains the revised S factor for the Universal Soil
 Loss Equation.  Equations taken from article entitled
-<EM>Revised Slope Steepness Factor for the Universal Soil
-Loss Equation</EM> (McCool et al. 1987).  Since the S factor
+<em>Revised Slope Steepness Factor for the Universal Soil
+Loss Equation</em> (McCool et al. 1987).  Since the S factor
 is a small number (usually less than one), it is multiplied
 by 100 for the GRASS output map layer.
 </dd>
 </dl>
 
 
-<H2>NOTES</H2>
+<h2>NOTES</h2>
 
-<EM>r.watershed</EM> uses an algorithm designed to minimize the impact of
-DEM data errors. This algorithm works slower than <EM>r.terraflow</EM> but
+<em>r.watershed</em> uses an algorithm designed to minimize the impact of
+DEM data errors. This algorithm works slower than <em>r.terraflow</em> but
 provides more accurate results in areas of low slope as well as DEMs
 constructed with techniques that mistake canopy tops as the ground elevation.
 Kinner et al. (2005), for example, used SRTM and IFSAR DEMs to compare
-<EM>r.watershed</EM> against <EM>r.terraflow</EM> results in Panama.
-<EM>r.terraflow</EM> was unable to replicate stream locations in the larger
-valleys while  <EM>r.watershed</EM> performed much better. Thus, if forest
+<em>r.watershed</em> against <em>r.terraflow</em> results in Panama.
+<em>r.terraflow</em> was unable to replicate stream locations in the larger
+valleys while  <em>r.watershed</em> performed much better. Thus, if forest
 canopy exists in valleys, SRTM, IFSAR, and similar data products will cause
-major errors in <EM>r.terraflow</EM> stream output. Under similar conditions,
-<EM>r.watershed</EM> will generate better <b>stream</b> and <b>half.basin</b>
-results. If watershed divides contain flat to low slope, <EM>r.watershed</EM>
-will generate better basin results than <EM>r.terraflow</EM>.
-(<EM>r.terraflow</EM> uses the same type of algorithm as ESRI's ArcGIS
+major errors in <em>r.terraflow</em> stream output. Under similar conditions,
+<em>r.watershed</em> will generate better <b>stream</b> and <b>half_basin</b>
+results. If watershed divides contain flat to low slope, <em>r.watershed</em>
+will generate better basin results than <em>r.terraflow</em>.
+(<em>r.terraflow</em> uses the same type of algorithm as ESRI's ArcGIS
 watershed software which fails under these conditions.) Also, if watershed
 divides contain forest canopy mixed with uncanopied areas using SRTM, IFSAR,
-and similar data products, <EM>r.watershed</EM> will generate better basin
-results than <EM>r.terraflow</EM>.
+and similar data products, <em>r.watershed</em> will generate better basin
+results than <em>r.terraflow</em>.
 
-<P>
-There are two versions of this program: <EM>ram</EM> and <EM>seg</EM>.
-Which is version is run depends on whether the <EM>-m</EM> flag is set.
-<BR>
-The <EM>ram</EM> version uses virtual memory managed by the operating
-system to store all the data structures and is faster than the <EM>seg</EM>
+<p>
+There are two versions of this program: <em>ram</em> and <em>seg</em>.
+Which is version is run depends on whether the <em>-m</em> flag is set.
+<br>
+The <em>ram</em> version uses virtual memory managed by the operating
+system to store all the data structures and is faster than the <em>seg</em>
 version;
-<EM>seg</EM> uses the GRASS segmentation library which manages data in disk
-files. Thus <EM>seg</EM> uses much less system memory (RAM) allowing other
+<em>seg</em> uses the GRASS segmentation library which manages data in disk
+files. Thus <em>seg</em> uses much less system memory (RAM) allowing other
 processes to operate on the same CPU, even when the current geographic
 region is huge.
-<BR>
+<br>
 Due to memory requirements of both programs, it is quite easy to run out of
-memory when working with huge map regions. If the <EM>ram</EM> version runs
+memory when working with huge map regions. If the <em>ram</em> version runs
 out of memory and the resolution size of the current geographic region
 cannot be increased, either more memory  needs to be added to the computer,
-or the swap space size needs to be increased.  If <EM>seg</EM> runs out of
+or the swap space size needs to be increased.  If <em>seg</em> runs out of
 memory, additional disk space needs to be freed up for the program to run.
 
-<P>
+<p>
 Both versions use the A<sup>T</sup> least-cost search algorithm to determine
 the flow of water over the landscape (see <a href="#seealso">SEE ALSO</a>
 section).
 The algorithm produces results similar to those obtained when running
-<EM><A HREF="r.cost.html">r.cost</A></EM> and
-<EM><A HREF="r.drain.html">r.drain</A></EM> on every cell on the map.
+<em><a href="r.cost.html">r.cost</a></em> and
+<em><a href="r.drain.html">r.drain</a></em> on every cell on the map.
 
-<P>
+<p>
 In many situations, the elevation data will be too finely detailed for
-the amount of time or memory available.  Running <EM>r.watershed</EM> may
+the amount of time or memory available.  Running <em>r.watershed</em> may
 require use of a coarser resolution.  To make the results more closely
 resemble the finer terrain data, create a map layer containing the
 lowest elevation values at the coarser resolution.  This is done by:
 1) Setting the current geographic region equal to the elevation map
-layer with <EM>g.region</EM>, and 2) Use the <EM>r.neighbors</EM> or
-<EM>r.resamp.stats</EM> command to find the lowest value for an area
+layer with <em>g.region</em>, and 2) Use the <em>r.neighbors</em> or
+<em>r.resamp.stats</em> command to find the lowest value for an area
 equal in size to the desired resolution.  For example, if the resolution
 of the elevation data is 30 meters and the resolution of the geographic
-region for <EM>r.watershed</EM> will be 90 meters:  use the minimum 
+region for <em>r.watershed</em> will be 90 meters:  use the minimum 
 function for a 3 by 3 neighborhood.  After changing to the resolution at
-which <EM>r.watershed</EM> will be run, <EM>r.watershed</EM> should be run
-using the values from the <EM>neighborhood</EM> output map layer that
+which <em>r.watershed</em> will be run, <em>r.watershed</em> should be run
+using the values from the <em>neighborhood</em> output map layer that
 represents the minimum elevation within the region of the coarser cell.
 
-<P>
+<p>
 The minimum size of drainage basins, defined by the <em>threshold</em>
 parameter, is only relevant for those watersheds with a single stream
 having at least the <em>threshold</em> of cells flowing into it.
@@ -248,8 +248,8 @@
 an interior stream segment is determined by the distance between the
 tributaries flowing into it.
 
-<P>
-The <EM>r.watershed</EM> program does not require the user to have the
+<p>
+The <em>r.watershed</em> program does not require the user to have the
 current geographic region filled with elevation values.  Areas without
 elevation data MUST be masked out, by creating a raster map (or raster
 reclassification) named <tt>MASK</tt>.  Areas
@@ -258,33 +258,33 @@
 unimportant areas can significantly reduce processing time if the watersheds 
 of interest occupy a small percentage of the overall area.
 
-<P>
+<p>
 Zero data values will be treated as elevation data (not no_data).
 
-<P>
+<p>
 To isolate an individual river network using the output of this module,
 a number of approaches may be considered.
-<OL>
-<LI>Use a resample of the basins catchment raster map as a MASK.<BR>
+<ol>
+<li>Use a resample of the basins catchment raster map as a MASK.<br>
   The equivalent vector map method is similar using <em>v.select</em> or
   <em>v.overlay</em>.
-<LI>Use the <em>r.cost</em> module with a point in the river as a starting
+<li>Use the <em>r.cost</em> module with a point in the river as a starting
   point.
-<LI>Use the <em>v.net.iso</em> module with a node in the river as a
+<li>Use the <em>v.net.iso</em> module with a node in the river as a
   starting point.
-</OL>
+</ol>
 
 
-<P>
+<p>
 To create <i>river mile</i> segmentation from a vectorized streams map,
 try the <em>v.net.iso</em> or <em>v.lrs.segment</em> modules.
 
 
-<H2>EXAMPLES</H2>
+<h2>EXAMPLES</h2>
 <i>These examples use the Spearfish sample dataset.</i>
-<P>
+<p>
 Convert <em>r.watershed</em> streams map output to a vector layer.
-<P>
+<p>
 If you want a detailed stream network, set the threshold option
 small to create lots of catchment basins, as only one stream is
 presented per catchment. The r.to.vect -v flag preserves the
@@ -294,9 +294,9 @@
   r.watershed elev=elevation.dem stream=rwater.stream
   r.to.vect -v in=rwater.stream out=rwater_stream
 </pre></div>
-<BR>
+<br>
 
-<P>
+<p>
 Set a nice color table for the accumulation map:
 <div class="code"><pre>
   MAP=rwater.accum
@@ -320,10 +320,10 @@
     100% red
   EOF
 </pre></div>
-<BR>
+<br>
 
 
-<P>
+<p>
 Create a more detailed stream map using the accumulation map and convert
 it to a vector output map. The accumulation cut-off, and therefore fractal
 dimension, is arbitrary; in this example we use the map's mean number of
@@ -351,9 +351,9 @@
   points map and upload to that ?? -->
 <!-- Note value column containing accumulation cells in output vector
   may not necessarily reference the downstream end of the line! drop it? -->
-<BR>
+<br>
 
-<P>
+<p>
 Create watershed basins map and convert to a vector polygon map
 <div class="code"><pre>
   r.watershed elev=elevation.dem basin=rwater.basin thresh=15000
@@ -361,50 +361,50 @@
   v.db.dropcol map=rwater_basins column=label
   v.db.renamecol map=rwater_basins column=value,catchment
 </pre></div>
-<BR>
+<br>
 
-<P>
+<p>
 Display output in a nice way
 <div class="code"><pre>
   r.shaded.relief map=elevation.dem
   d.shadedmap rel=elevation.dem.shade drape=rwater.basin bright=40
   d.vect rwater_course color=orange
 </pre></div>
-<BR>
+<br>
 
 <a name="references"></a>
-<H2>REFERENCES</H2>
+<h2>REFERENCES</h2>
 
 
 Ehlschlaeger, C. (1989). <i>Using the A<sup>T</sup> Search Algorithm
 to Develop Hydrologic Models from Digital Elevation Data</i>,
 <b>Proceedings of International Geographic Information Systems (IGIS)
-Symposium '89</b>, pp 275-281 (Baltimore, MD, 18-19 March 1989).<BR>
+Symposium '89</b>, pp 275-281 (Baltimore, MD, 18-19 March 1989).<br>
 URL: <a href="http://faculty.wiu.edu/CR-Ehlschlaeger2/older/IGIS/paper.html">
 http://faculty.wiu.edu/CR-Ehlschlaeger2/older/IGIS/paper.html</a>
 
-<P>
+<p>
 Kinner D., H. Mitasova, R. Harmon, L. Toma, R., Stallard. (2005).
 <i>GIS-based Stream Network Analysis for The Chagres River Basin,
 Republic of Panama</i>. <b>The Rio Chagres: A Multidisciplinary Profile of
-a Tropical Watershed</b>, R. Harmon (Ed.), Springer/Kluwer, p.83-95.<BR>
+a Tropical Watershed</b>, R. Harmon (Ed.), Springer/Kluwer, p.83-95.<br>
 URL: <a href="http://skagit.meas.ncsu.edu/%7Ehelena/measwork/panama/panama.html">
 http://skagit.meas.ncsu.edu/~helena/measwork/panama/panama.html</a>
 
-<P>
+<p>
 McCool et al. (1987). <i>Revised Slope Steepness Factor for the Universal
 Soil Loss Equation</i>, <b>Transactions of the ASAE</b> Vol 30(5).
 
-<P>
+<p>
 Weltz M. A., K. G. Renard, J. R. Simanton (1987). <i>Revised Universal Soil
 Loss Equation for Western Rangelands</i>, <b>U.S.A./Mexico Symposium of
 Strategies for Classification and Management of Native Vegetation for
 Food Production In Arid Zones</b> (Tucson, AZ, 12-16 Oct. 1987).
 
 <a name="seealso"></a>
-<H2>SEE ALSO</H2>
+<h2>SEE ALSO</h2>
 
-<EM>
+<em>
 <a href="g.region.html">g.region</a>,
 <a href="r.cost.html">r.cost</a>,
 <a href="r.drain.html">r.drain</a>,
@@ -416,11 +416,12 @@
 <a href="r.terraflow.html">r.terraflow</a>,
 <a href="r.topidx.html">r.topidx</a>,
 <a href="r.water.outlet.html">r.water.outlet</a>
-</EM>
+</em>
 
 
-<H2>AUTHOR</H2>
+<h2>AUTHORS</h2>
 
-Charles Ehlschlaeger, U.S. Army Construction Engineering Research Laboratory
+Original version: Charles Ehlschlaeger, U.S. Army Construction Engineering Research Laboratory<br>
+Markus Metz <markus.metz.giswork at gmail.com>
 <p>
-<i>Last changed: $Date: 2008-02-23 19:20:42 +0100 (Sat, 23 Feb 2008) $</i>
+<i>Last changed: $Date: 2008-09-28 01:36:15 +0200 (Sun, 28 Sep 2008) $</i>



More information about the grass-commit mailing list