[GRASS-SVN] r34237 - grass/trunk/vector/v.reclass

[svn_grass at osgeo.org]

Author: hamish
Date: 2008-11-10 23:24:08 -0500 (Mon, 10 Nov 2008)
New Revision: 34237

Modified:
   grass/trunk/vector/v.reclass/main.c
   grass/trunk/vector/v.reclass/v.reclass.html
Log:
describe column opt a bit better and add example (merge from devbr6)

Modified: grass/trunk/vector/v.reclass/main.c
===================================================================
--- grass/trunk/vector/v.reclass/main.c	2008-11-11 04:16:34 UTC (rev 34236)
+++ grass/trunk/vector/v.reclass/main.c	2008-11-11 04:24:08 UTC (rev 34237)
@@ -78,7 +78,7 @@
     col_opt = G_define_standard_option(G_OPT_DB_COLUMN);
     col_opt->label =
 	_("The name of the column whose values are to be used as new categories");
-    col_opt->description = _("The column must be type integer or string");
+    col_opt->description = _("The source for the new key column must be type integer or string");
 
     type_opt = G_define_standard_option(G_OPT_V_TYPE);
     type_opt->description = _("Select type");

Modified: grass/trunk/vector/v.reclass/v.reclass.html
===================================================================
--- grass/trunk/vector/v.reclass/v.reclass.html	2008-11-11 04:16:34 UTC (rev 34236)
+++ grass/trunk/vector/v.reclass/v.reclass.html	2008-11-11 04:24:08 UTC (rev 34237)
@@ -1,19 +1,43 @@
 <H2>DESCRIPTION</H2>
 
-<EM>v.reclass</EM> allows user to create a new vector map based on the reclassification 
-of an existing vector map.  
+<EM>v.reclass</EM> allows user to create a new vector map based on
+the reclassification of an existing vector map. It also allows the user
+to change the <i>key column</i> away from the default of "<b>cat</b>" with
+the <b>column</b> option.
 
 <p>
 Rules file may contain on each row either pair:
 <div class="code"><pre>
 keyword&nbsp;value
 </pre></div>
-(separated by space) or comment beginning by #(hash). 
-Definition of new category begins with keyword <I>cat</I> followed by new category value.
+(separated by space) or comment beginning with '#' (hash). 
+Definition of new category begins with keyword <I>cat</I> followed
+by the new category value.
 Keyword <I>where</I> specifies SQL where condition.
 
-<H2>EXAMPLE</H2>
 
+
+<H2>NOTES</H2>
+
+No table is created for the reclassed map if the <B>column</B> option is
+used and the column type is integer (as the result could contain ambiguities).
+
+If the <B>column</B> option is used and the column type is string, a new
+table is created containing the newly generated cat numbers and a single
+column containing the unique string column values, sorted in alphabetical
+order.
+
+<P>
+For dissolving common boundaries, see 
+<em><a href="v.dissolve.html">v.dissolve</a></em>.
+
+
+
+<H2>EXAMPLES</H2>
+
+
+<H4>Example 1: Reclass by rules</H4>
+
 <div class="code"><pre>
 v.reclass input=land output=land_u type=boundary rules=land.rcl
 </pre></div>
@@ -28,23 +52,37 @@
 where use = 'E14'
 </pre></div>
 
-Produces a new vector area map <EM>land_u</EM> containing boundaries from <EM>land</EM> with area category values selected 
-from database by SQL select statement: <br>
-<I>select id from tland where use = 'E13' and owner = 'Jara Cimrman' </I> changed to category 1;
+Produces a new vector area map <EM>land_u</EM> containing boundaries from
+<EM>land</EM> with area category values selected from database by SQL
+select statement:
 <br>
-values selected from database by SQL select statement: <br>
-<I>select id from tland where use = 'E14' </I> changed to category 2.
+<tt>select id from tland where use = 'E13' and owner = 'Jara Cimrman'</tt>
+changed to category 1;
+<br>
+values selected from database by SQL select statement: 
+<br>
+<tt>select id from tland where use = 'E14'</tt> changed to category 2.
 
-<H2>NOTES</H2>
-No table is created for reclassed layer if <B>column</B> option is used and column type is
-integer (there is nothing which could be written to the table).
-<P>
-For dissolving common boundaries, see <em><a href="v.dissolve.html">v.dissolve</a></em>.
 
+<H4>Example 2: Reclass by attribute column</H4>
+
+(North Carolina sample dataset)<br>
+
+<div class="code"><pre>
+v.reclass in=streams out=streams_by_type column=I_vs_P
+
+v.db.select streams_by_type
+cat|I_vs_P
+1|intermittent
+2|perennial
+</pre></div>
+
+
 <H2>BUGS</H2>
 
 No table is created for reclassed layer if <B>rules</B> option is used.
 
+
 <H2>SEE ALSO</H2>
 
 <em>
@@ -54,10 +92,12 @@
 <p>
 <em><a HREF="sql.html">GRASS SQL interface</a></em>
 
+
 <H2>AUTHOR</H2>
 
 R.L. Glenn, USDA, SCS, NHQ-CGIS<BR>
-from v.reclass to v.db.reclass and later to v.reclass in 5.7 rewritten by Radim Blazek
+from v.reclass to v.db.reclass and later to v.reclass in 5.7 rewritten
+by Radim Blazek
 
 <p>
 <i>Last changed: $Date$</i>