[GRASS-SVN] r30273 - grass/branches/releasebranch_6_3/raster/r.describe

Wed Feb 20 21:02:34 EST 2008

Author: epatton
Date: 2008-02-20 21:02:34 -0500 (Wed, 20 Feb 2008)
New Revision: 30273

Modified:
   grass/branches/releasebranch_6_3/raster/r.describe/description.html
Log:
Backported updates to manpage from TRUNK

Modified: grass/branches/releasebranch_6_3/raster/r.describe/description.html
===================================================================

--- grass/branches/releasebranch_6_3/raster/r.describe/description.html	2008-02-21 01:55:08 UTC (rev 30272)
+++ grass/branches/releasebranch_6_3/raster/r.describe/description.html	2008-02-21 02:02:34 UTC (rev 30273)
@@ -1,154 +1,104 @@
 <H2>DESCRIPTION</H2>
 
-
-<EM>r.describe</EM> prints a terse listing of category values found in
+<EM><B>r.describe</B></EM> prints a terse listing of category values found in
 a user-specified raster map layer.
 
-<H3>PROGRAM USE</H3>
-
-The user can select one of the following two output reports
-from <EM>r.describe</EM>:
-
-<DL COMPACT>
-
-<DT>(1) RANGE.
-
-<DD>A range of category values found in the raster map
-layer will be printed.  The range is divided into three
-groups:  negative, positive, and zero.  If negative values
-occur, the minimum and maximum negative values will be
-printed.  If positive values occur, the minimum and maximum
-positive values will be printed.  If zero occurs, this will
-be indicated.
-
-<DT>(2) FULL LIST.
-
-<DD>A list of all category values that were found in the
-raster map layer will be printed.
-
 <P>
 
-The following sample output from <EM>r.describe</EM>:
-
-<DL>
-<DD> 0 2-4 10-13
-</DL>
-
-means that category data values 0, 2 through 4, and 10
-through 13 occurred in the named map layer.
-
-</DL>
-
-The user must choose to read the map layer in one of two ways:
-
-<DL COMPACT>
-
-<DT>(1) DIRECTLY.
-
-<DD>The current geographic region and mask are ignored and the full 
-raster map layer is read.  This method is useful if the
-user intends to <EM>reclassify</EM> or
-<EM>rescale</EM> the data, since these functions 
-(<EM><A HREF="r.reclass.html">r.reclass</A></EM> and
+<EM><B>r.describe</B></EM> ignores the current geographic region and mask, and
+reads the full extent of the input raster map.  This functionality is useful if the
+user intends to <EM>reclassify</EM> or <EM>rescale</EM> the data, 
+since these functions (<EM><A HREF="r.reclass.html">r.reclass</A></EM> and
 <EM><A HREF="r.rescale.html">r.rescale</A></EM>) 
 also ignore the current <EM>geographic region</EM>
 and <EM>mask</EM>.
 
-<DT>(2) REGIONED and MASKED.
+<p>
+The <EM><B>nv</B></EM> parameter sets the string to be used to represent <tt>NULL</tt> 
+values in the module output; the default is '*'.
 
-<DD>The map layer is read within the current geographic region,
-masked by the current mask.
+<p>
+The <EM><B>nsteps</B></EM> parameter sets the number of quantisation steps to divide into 
+the input raster map.
 
-</DL>
+<H2>NOTES</H2>
 
-<H3>NON-INTERACTIVE PROGRAM USE</H3>
+<H3>FLAGS</H3>
 
-<EM>r.describe</EM> examines a user-chosen raster map
-layer.  If run non-interactively, the layer name must be
-supplied on the command line.
+If the user selects the <b>-r</b> flag, a range of category values found in 
+the raster map layer will be printed. The range is divided into three groups: 
+negative, positive, and zero. If negative values occur, the minimum and maximum 
+negative values will be printed. If positive values occur, the minimum and maximum 
+positive values will be printed. If zero occurs, this will be indicated. The range 
+report will generally run faster than the full list (the default output).
 
-<P>
+<p>
 
-A compact list of category values that were found in the
-data layer will be printed.
+The <B>-d</B> flag can be used to force <em>r.describe</em> to respect the current region
+extents when repoting raster map categories. The default behavior is to read the full 
+extent of the input raster map.
 
-<P>
+<p>
+If the <B>-1</B> flag is specified, the output appears with one category value/range per line.
 
-Following is a sample output:
+<p>
+The <B>-n</B> flag suppresses the reporting of <tt>NULL</tt> values.
 
-<DL>
-<DD>0 2-4 10-13
-</DL>
+<H2>EXAMPLES</H2>
 
+The following examples are from the Spearfish60 sample Location:
 
-<h3>FLAGS</h3>
+<p>
 
-<DT><B>-1</B>
+# Print the full list of raster map categories:
+<div class="code"><PRE>
+r.describe landcover.30m 
+* 11 21-23 31 32 41-43 51 71 81-83 85 91 92
+</PRE></div>
+<p>
 
-<DD>Print the output one value per line, instead of the
-default short form.  In the above example, the <B>-1</B>
-option would output:
+# Print the raster range only:
+<div class="code"><PRE>
+r.describe -r landcover.30m
+11 thru 92
+*
+</PRE></div>
 
-<PRE>
-0
+# Print raster map category range, suppressing nulls:
+<div class="code"><PRE>
+r.describe -n landcover.30m 
+11 21-23 31 32 41-43 51 71 81-83 85 91 92
+</PRE></div>
+<p>
+
+# Print raster map categories, one category per line:
+<div class="code"><PRE>
+r.describe -1 geology 
+
+*
+1
 2
 3
 4
-10
-11
-12
-13
-</PRE>
+5
+6
+7
+8
+9
+</PRE></div>
+<p>
 
-
-<DT><B>-r</B>
-
-<DD>Only print the range of the data.  The highest and
-lowest positive values, and the highest and lowest negative
-values, are output. In the above example, the <B>-r</B>
-option would output:
-
-<DL>
-<DD>0 2 13
-</DL>
-
-<P>
-
-If the <B>-1</B> option is also specified, the output
-appears with one category value per line.
-
-<DT><B>-q</B>
-
-<DD>Quiet. The <B>-q</B> option will tell r.describe to be
-silent while reading the raster map.  If not specified,
-program percentage-completed messages are printed.
-
-<DT><B>-d</B>
-
-<DD>Use the current geographic region settings.  Normally,
-<EM>r.describe</EM> will read the data layer directly,
-ignoring both the current region settings and mask.  The
-<B>-d</B> option tells <EM>r.describe</EM> to read the map
-layer in the current region masked by the current mask (if
-any).
-
-</DL>
-</DD>
-
-
-<H2>NOTES</H2>
-
-The range report will generally run faster than the full list.
-
 <H2>SEE ALSO</H2>
 
 <EM>
 <A HREF="g.region.html">g.region</A>,
+<A HREF="r.mask.html">r.mask</A>,
 <A HREF="r.reclass.html">r.reclass</A>,
 <A HREF="r.report.html">r.report</A>,
 <A HREF="r.rescale.html">r.rescale</A>,
 <A HREF="r.stats.html">r.stats</A>,
 <A HREF="r.univar.html">r.univar</A>
+
 </EM>
 
 <H2>AUTHOR</H2>

