[GRASS-SVN] r36163 - grass/branches/develbranch_6/imagery/i.pca

[svn_grass at osgeo.org]

Author: hamish
Date: 2009-03-01 09:52:06 -0500 (Sun, 01 Mar 2009)
New Revision: 36163

Modified:
   grass/branches/develbranch_6/imagery/i.pca/description.html
   grass/branches/develbranch_6/imagery/i.pca/main.c
Log:
better opt descriptions

Modified: grass/branches/develbranch_6/imagery/i.pca/description.html
===================================================================
--- grass/branches/develbranch_6/imagery/i.pca/description.html	2009-03-01 12:31:15 UTC (rev 36162)
+++ grass/branches/develbranch_6/imagery/i.pca/description.html	2009-03-01 14:52:06 UTC (rev 36163)
@@ -8,7 +8,7 @@
 the input data in decreasing order of variance
 ("contrast").  The output raster map layers are assigned
 names with .1, .2, ... .n suffixes.  The current geographic
-region definition and mask settings are respected when
+region definition and MASK settings are respected when
 reading the input raster map layers. When the rescale
 option is used, the output files are rescaled to fit the
 min,max range.
@@ -16,36 +16,35 @@
 <H2>OPTIONS</H2>
 
 <H3>Parameters:</H3>
-
 <DL>
-
 <DT><B>input=</B><EM>name,name</EM>[<EM>,name,name</EM>,...] 
-
 <DD>Name of two or more input raster map layers.
 
 <DT><B>output=</B><EM>name</EM> 
-
 <DD>The output raster map layer name to which suffixes are
 added.  Each output raster map layer is assigned this
 user-specified <EM>name</EM> with a numerical (.1, .2, ...
 .n) suffix.
 
 <DT><B>rescale=</B><EM>min,max</EM> 
-
 <DD>The optional output category range. (Default: 0,255) If
 rescale=0,0,  no rescaling is performed on output files.
 
 <DD>If output is rescaled, the output raster will be of type CELL. If 
 the output is not rescaled, the output raster will be of type DCELL.
-
 </DL>
 
+
 <H2>NOTES</H2>
 
 Richards (1986) gives a good example of the application of principal
 components analysis (pca) to a time series of LANDSAT images of a burned
 region in Australia.
+<P>
+Eigenvalue and eigenvector information is stored in the output maps'
+history files. View with <em>r.info</em>.
 
+
 <H2>SEE ALSO</H2>
 
 Richards, John A.,
@@ -61,14 +60,17 @@
 
 <P>
 
-<EM><A HREF="i.cca.html">i.cca</A></EM><br>
-<EM><A HREF="i.class.html">i.class</A></EM><br>
-<EM><A HREF="i.fft.html">i.fft</A></EM><br>
-<EM><A HREF="i.ifft.html">i.ifft</A></EM><br>
-<EM><A HREF="m.eigensystem.html">m.eigensystem</A></EM><br>
-<EM><A HREF="r.covar.html">r.covar</A></EM><br>
-<EM><A HREF="r.mapcalc.html">r.mapcalc</A></EM>
+<EM>
+<A HREF="i.cca.html">i.cca</A><br>
+<A HREF="i.class.html">i.class</A><br>
+<A HREF="i.fft.html">i.fft</A><br>
+<A HREF="i.ifft.html">i.ifft</A><br>
+<A HREF="m.eigensystem.html">m.eigensystem</A><br>
+<A HREF="r.covar.html">r.covar</A><br>
+<A HREF="r.mapcalc.html">r.mapcalc</A>
+</EM>
 
+
 <H2>AUTHOR</H2>
 
 David Satnik, GIS Laboratory
@@ -82,4 +84,5 @@
 Rewritten for GRASS 6.x and major modifications by <br>
 Brad Douglas
 
-<p><i>Last changed: $Date$</i>
+<p>
+<i>Last changed: $Date$</i>

Modified: grass/branches/develbranch_6/imagery/i.pca/main.c
===================================================================
--- grass/branches/develbranch_6/imagery/i.pca/main.c	2009-03-01 12:31:15 UTC (rev 36162)
+++ grass/branches/develbranch_6/imagery/i.pca/main.c	2009-03-01 14:52:06 UTC (rev 36163)
@@ -66,7 +66,12 @@
 
     /* Define options */
     opt_in = G_define_standard_option(G_OPT_R_INPUTS);
+    opt_in->description = _("Name of two or more input raster maps");
+
     opt_out = G_define_standard_option(G_OPT_R_OUTPUT);
+    opt_out->label = _("Base name for output raster maps");
+    opt_out->description =
+	_("A numerical suffix will be added for each component map");
 
     opt_scale = G_define_option();
     opt_scale->key = "rescale";
@@ -75,7 +80,7 @@
     opt_scale->required = NO;
     opt_scale->answer = "0,255";
     opt_scale->description =
-	_("Rescaling range output (For no rescaling use 0,0)");
+	_("Rescaling range for output maps (for no rescaling use 0,0)");
 
     if (G_parser(argc, argv))
 	exit(EXIT_FAILURE);