[GRASS-SVN] r29689 - in grass/branches/releasebranch_6_3/raster: r.carve r.clump r.coin r.volume

[svn_grass at osgeo.org]

Author: epatton
Date: 2008-01-12 20:01:00 -0500 (Sat, 12 Jan 2008)
New Revision: 29689

Modified:
   grass/branches/releasebranch_6_3/raster/r.carve/description.html
   grass/branches/releasebranch_6_3/raster/r.clump/description.html
   grass/branches/releasebranch_6_3/raster/r.coin/description.html
   grass/branches/releasebranch_6_3/raster/r.volume/description.html
Log:
Backported documentation fixes from TRUNK

Modified: grass/branches/releasebranch_6_3/raster/r.carve/description.html
===================================================================
--- grass/branches/releasebranch_6_3/raster/r.carve/description.html	2008-01-12 20:52:20 UTC (rev 29688)
+++ grass/branches/releasebranch_6_3/raster/r.carve/description.html	2008-01-13 01:01:00 UTC (rev 29689)
@@ -1,20 +1,16 @@
 <H2>DESCRIPTION</H2>
 
-<em>r.carve</em> takes vector stream data, transforms it to raster, and
-subtracts depth from the output DEM.
-
-<P>
-The program will take the vector stream data, transform them to
-raster, and subtracts a defaultdepth+additionaldepth from the DEM. If
-the given width is more than 1 cell it will carve the stream with the
-given width. With -n option it should eliminate all flat cells within
+<em>r.carve</em> accepts vector stream data as input, transforms them to
+raster, and subtracts a defaultdepth+additionaldepth from a DEM. If
+the given width is more than 1 cell, it will carve the stream with the
+given width. With the -n flag it should eliminate all flat cells within
 the stream, so when and if the water gets into the stream it will
 flow. The <em>points</em> option generates x,y,z for points which define the stream
-with the z value of the bottom of the carved-in stream. These points
+with the z-value of the bottom of the carved-in stream. These points
 can then be combined with contours to interpolate a new DEM with
 better representation of valleys.
 
-<H2>NOTES</H2>
+<H2>NOTE</H2>
 
 <em>r.carve</em> does not create a depressionless DEM because many
 depressions are in flat areas and not in the streams.
@@ -27,18 +23,12 @@
 r.carve rast=elevation.10m vect=streams out=carve_dem width=20 depth=5
 </pre></div>
 
-<H2>BUGS AND CAVEAT</H2>
-
+<H2>BUGS</H2>
+<!-- Is this still the case as of Jan 11, 2008? - EP -->
 The module does not operate yet in latitude-longitude locations.  It
-has not been thoroughly tested so not all option may work properly -
+has not been thoroughly tested, so not all options may work properly -
 but this was the intention.
 
-<H2>SEE ALSO</H2>
-<EM><A HREF="r.flow.html">r.flow</A></EM>,
-<EM><A HREF="r.fill.dir.html">r.fill.dir</A></EM>,
-<EM><A HREF="r.watershed.html">r.watershed</A></EM> 
-
-
 <H2>REFERENCES</H2>
 
 <a href="http://skagit.meas.ncsu.edu/~helena/gmslab/reports/cerl99/rep99.html">Terrain
@@ -46,6 +36,11 @@
 areas</a>, by Helena Mitasova, Lubos Mitas, William M. Brown, Douglas
 M.  Johnston, GMSL (Report for CERL 1999)
 
+<H2>SEE ALSO</H2>
+<EM><A HREF="r.flow.html">r.flow</A></EM>,
+<EM><A HREF="r.fill.dir.html">r.fill.dir</A></EM>,
+<EM><A HREF="r.watershed.html">r.watershed</A></EM> 
+
 <H2>AUTHOR</H2>
 Bill Brown (GMSL)<br>
 GRASS 6 update: Brad Douglas

Modified: grass/branches/releasebranch_6_3/raster/r.clump/description.html
===================================================================
--- grass/branches/releasebranch_6_3/raster/r.clump/description.html	2008-01-12 20:52:20 UTC (rev 29688)
+++ grass/branches/releasebranch_6_3/raster/r.clump/description.html	2008-01-13 01:01:00 UTC (rev 29689)
@@ -1,9 +1,9 @@
 <H2>DESCRIPTION</H2>
 
 <EM>r.clump</EM> finds all areas of contiguous cell category values in the
-input raster map layer <EM>name</B>.</EM> It assigns a unique category value
+input raster map layer <EM>name.</EM> It assigns a unique category value
 to each such area ("clump") in the resulting output raster map layer
-<EM>name</B>.</EM> If the user does not provide input and output map layer
+<EM>name.</EM> If the user does not provide input and output map layer
 names on the command line, the program will prompt the user for these names,
 using the standard <A HREF="parser.html">parser</A> interface.
 
@@ -13,20 +13,18 @@
 HREF="r.reclass.html">r.reclass</A></EM> prior to <EM>r.clump</EM> to
 recategorize cells and reassign cell category values.)
 
-<H2>ALGORITHM</H2>
+<H2>NOTES</H2>
 
 <EM>r.clump</EM> moves a 2x2 matrix over the input raster map layer. 
 The lower right-hand corner of the matrix is grouped with the cells above it, 
-or to the left of it. 
-(Diagonal cells are not considered.) 
+or to the left of it (diagonal cells are not considered.) 
+<P>
 
-<H2>NOTES</H2>
-
 <EM>r.clump</EM> works properly with raster map layers that
 contain only "fat" areas (more than a single cell in
 width).  Linear elements (lines that are a single cell
 wide) may or may not be clumped together depending on the
-direction of the line -- horizontal and vertical lines of
+direction of the line - horizontal and vertical lines of
 cells are considered to be contiguous, but diagonal lines
 of cells are not considered to be contiguous and are broken
 up into separate clumps.

Modified: grass/branches/releasebranch_6_3/raster/r.coin/description.html
===================================================================
--- grass/branches/releasebranch_6_3/raster/r.coin/description.html	2008-01-12 20:52:20 UTC (rev 29688)
+++ grass/branches/releasebranch_6_3/raster/r.coin/description.html	2008-01-13 01:01:00 UTC (rev 29689)
@@ -50,6 +50,20 @@
 
 <P>
 
+<H2>NOTES</H2>
+
+It is <B>not</B> a good idea to run <EM>r.coin</EM> on a
+map layer which has a monstrous number of categories (e.g.,
+unreclassed elevation).  Because <EM>r.coin</EM> reports
+information for each and every category, it is better to
+reclassify those categories (using <EM>r.reclass</EM>)
+into a more manageable number prior to running
+<EM>r.coin</EM> on the reclassed raster map layer.
+
+<P>
+
+<H2>EXAMPLE</H2>
+
 Below is a sample of tabular output produced by
 <EM>r.coin</EM>.  Here, map output is stated in units of
 square miles.  The report tabulates the coincidence of the
@@ -158,16 +172,6 @@
 +--------------------------------+
 </PRE>
 
-<H2>NOTES</H2>
-
-It is <B>not</B> a good idea to run <EM>r.coin</EM> on a
-map layer which has a monstrous number of categories (e.g.,
-unreclassed elevation).  Because <EM>r.coin</EM> reports
-information for each and every category, it is better to
-reclassify those categories (using <EM>r.reclass</EM>)
-into a more manageable number prior to running
-<EM>r.coin</EM> on the reclassed raster map layer.
-
 <P>
 
 <EM>r.coin</EM> calculates the coincidence of two raster

Modified: grass/branches/releasebranch_6_3/raster/r.volume/description.html
===================================================================
--- grass/branches/releasebranch_6_3/raster/r.volume/description.html	2008-01-12 20:52:20 UTC (rev 29688)
+++ grass/branches/releasebranch_6_3/raster/r.volume/description.html	2008-01-13 01:01:00 UTC (rev 29689)
@@ -9,24 +9,32 @@
 clump map is not specified, the current MASK is used.
 The sum is multiplied by the area of a cell to give the volume
 occupied by that cell.  See below for an example of the output
-table.  The table is placed in the user's home directory in the
+table. 
+
+<!-- The table is placed in the user's home directory in the
 file Gvol.report. (or not???)
 
+NOTE: I can't find any evidence of this in the source code, and I have tested 
+the module out as of Jan 10, 2008. I'll leave the above comment about
+automatic report generation commented out from the manpage for now, unless I get 
+notification otherwise. - EP
+-->
+
 <H2>NOTES</H2>
 <p>
 If a clump map is not given and a MASK not set, the program exits
 with an error message.
 <p>
-<em>r.volume</em> works in the current window and respects the current MASK.
+<em>r.volume</em> works in the current region and respects the current MASK.
 <p>
 
-<H2>EXAMPLE OF REPORT</H2>
+<H2>EXAMPLE</H2>
 
 The following report was generated by the command:
-(spearfish data base; fields.only is fields layer without the
+(spearfish data base; fields.only is the fields layer without the
 National Forest category)
 <p>
-  r.volume d=elevation c=fields.only centr=field.centers 
+r.volume data=elevation clump=fields.only centroids=field.centers 
 <p>
 
 <pre><tt>
@@ -79,6 +87,11 @@
 a separate category using <em>v.to.rast</em>.
 <p>
 
+<!-- As far as I can tell, no attributes are written to a table in Grass 6.3
+(Jan 2008), as this program hasn't been updated to use the Grass 6 vector library. - EP
+-->
+
+
 <h3>APPLICATIONS</h3>
 By preprocessing the elevation layer with <em>r.mapcalc</em> and using
 suitable masking or clump maps, very interesting applications can