[GRASS-CVS] [addons] r1238 - in trunk/grassaddons/i.pr: i.pr_features i.pr_training

Tue Dec 4 09:33:11 EST 2007

Author: neteler
Date: 2007-12-04 15:33:10 +0100 (Tue, 04 Dec 2007)
New Revision: 1238

Added:
   trunk/grassaddons/i.pr/i.pr_features/description.html
   trunk/grassaddons/i.pr/i.pr_training/description.html
Log:
Daniel McInerney: documentation started

Added: trunk/grassaddons/i.pr/i.pr_features/description.html
===================================================================

--- trunk/grassaddons/i.pr/i.pr_features/description.html	                        (rev 0)
+++ trunk/grassaddons/i.pr/i.pr_features/description.html	2007-12-04 14:33:10 UTC (rev 1238)
@@ -0,0 +1,20 @@
+<H2>DESCRIPTION</H2>
+
+<EM>i.pr.features</EM> This module is used to preprocess and extract the training features. It is necessary to specify the training file, which contains the names of the raster maps (explanatory variables) to be used in subsequent modules. The training file can either be the output from from <em><a href="i.pr.training.html">i.pr.training</a></em> (Recommended) or an ascii file containing the names of rasters.  
+<p>
+This module allows for the calculation of a range of statistics pertaining to the explanatory variables, which include the mean and variance. In addition the features can be normalized to a similar scale. In each case, it is possible to specify the numbers of features for which these statistics should be computed (i.e. number in list). There is also the possibility to compute principal components for the explanatory variables. The default calculates them for all layers, or else only on selected classes specified by 'class_pc'. Variables can be standardised using parameter 'standardize', this is linked to the features previously calculated and not layers in the training file. 
+
+<H2>NOTES</H2>
+
+
+<H2>SEE ALSO</H2>
+
+<EM><A HREF="i.pr.training.html">i.pr.training</A></EM><br>
+<EM><A HREF="i.pca.html">i.pca</A></EM><br>
+
+<H2>AUTHORS</H2>
+
+Stefano Merler, FBK, Trento, Italy<br>
+Documentation: Daniel McInerney (daniel.mcinerney ucd.ie)
+<p>
+<p><i>Last changed: $Date: 2007/12/04 09:50:03 $</i>

Added: trunk/grassaddons/i.pr/i.pr_training/description.html
===================================================================
--- trunk/grassaddons/i.pr/i.pr_training/description.html	                        (rev 0)
+++ trunk/grassaddons/i.pr/i.pr_training/description.html	2007-12-04 14:33:10 UTC (rev 1238)
@@ -0,0 +1,88 @@
+<h2>NAME</h2>
+<em><b>i.pr.training</b></em>  - Module to generate the training samples for use in i.pr.* modules. i.pr: Pattern Recognition environment for image processing. Includes <i>k</i>NN, Decision Tree and SVM classification techniques. Also includes cross-validation and bagging methods for model validation. 
+<h2>SYNOPSIS</h2>
+<b>i.pr.training</b>
+<b>i.pr.training</b> <b>map</b>=<em>string</em>[,<i>string</i>,...] [<b>vis_map</b>=<em>string</em>]  <b>training</b>=<em>string</em> [<b>site_file</b>=<em>string</em>] <b>rows</b>=<em>value</em> <b>cols</b>=<em>value</em> [<b>class</b>=<em>value</em>] [<b>--verbose</b>] [<b>--quiet</b>]  
+
+
+<h3>Flags:</h3>
+<DL>
+<DD><b>Flags:</b></DD>
+<DD>--v	Verbose module output</DD>
+<DD>--q Quiet module output</DD>
+</DL>
+
+<h3>Parameters:</h3>
+<DL>
+<DT><b>input</b>=<em>string[,<i>string</i>,...]</em>
+<DD>Input raster maps (max 25) for extracting the training examples. The first one will be used for graphical output, where 'vis_map' is specified</DD>
+
+<DT><b>vis_map</b>=<em>string</em>
+<DD>Raster Map for visualisation</DD>
+
+<DT><b>training</b>=<em>string</em>
+<DD>Name of the output file containing the training raster maps. If this file already exists, the new data will be appended to the end of the file.<DD>
+
+<DT><b>site_file</b>=<em>string</em>
+<DD>Name of the site file containing the labelled location. Typically a point vector layer or polygon centroids</DD>
+
+<DT><b>rows</b>=<em>value</em>
+<DD>Number of rows (required odd) of the training samples</DD>
+
+<DT><b>cols</b>=<em>value</em>
+<DD>Number of columns (required odd) of the training samples</DD>
+
+<DT><b>class</b>=<em>value</em>
+<DD>Numerical label to be attached to the training examples. Option not required with the site_file option.</DD>
+</DL>
+<H2>DESCRIPTION</H2>
+
+
+<EM>i.pr.training</EM> This module is the first to be run when using i.pr.* modules. It is necessary to list all maps that will be used as explanatory variables and whose values will be assigned to the training samples. Two options for extracting data for the training samples are available. The first can be done interactively using the graphical interface. In this instance, the first GRASS raster map specified in the list is visualised in the GRASS monitor, however, this can be altered by specifying the 'vis_map' option. In this case, the user must digitise locations training samples in the GRASS monitor. A Class parameter will be assigned to each training sample, the class labels must be positive integers and must progressively increase. 
+<pr>
+The second option for generating the training sample file can be done non-interactively. This is done by specifying a GRASS sites file. This file should represent the locations of training samples and ought to have been previously generated either by digitising (<em><a href="v.digit">v.digit</a></em>) or else by <em><a href="v.in.ascii">v.in.ascii</a></em>. Features will be extracted for these locations in a similar fashion as previously described. The class will be assigned to the examples based on the information stored in the sites file. 
+<p>
+The output of this module will be an ascii file of type xy.z. The number of columns will relate to the number of rasters specified on the command line. If the output file already exists, the new data values will be appended to it. 
+
+<H3>Flags:</H3>
+<DL>
+<DD><b>--v</b>	Verbose module output. Print information pertaining to module progress and completion.</DD>
+<DD><b>--p</b>	Run Quietly. Suppress program output that would include program percent complete messages and time elapsed.</DD>
+<H3>Parameters:</H3>
+
+
+<DT><B>input=</B><EM>name,name</EM>[<EM>,name,name</EM>,...]</DT> 
+<DD>Name of raster maps (maximum 25) for extracting the training examples. The first will be used for graphical output. The extent of all raster maps should be the same. CELL, DCELL and FCELL raster maps can be used. </DD>
+
+
+<DT><B>vis_map</B><EM>name</EM> 
+<DD>This parameter is optional. If used, the raster that is specified will be displayed in the GRASS monitor and used as a background raster file. It should be used to identify the location of training samples.</DD> 
+
+<DT><B>training=</B><EM>name</EM> 
+<DD>This parameter is required. It creates the training file, which is an ascii file containing all of the x,y locations of the traning samples and their associated class labels and values from the explanatory variables (GRASS raster maps). If the name specified on the command line refers to a training file that already exists in the working directory, the new data are appended to it. </DD> 
+
+<DT><B>site_file=</B><EM>name</EM> 
+<DD>This parameter is required if the non-interactive mode is required. It should relate to a GRASS Vector map (Version 6 vector data) and there should be a class label (numeric value) for each site. This file should be created prior to running i.pr.training either using v.digit or v.in.ascii. The latter is more straightforward provided the input ascii file contains data in the following format: x,y,z(class label). 
+</DD>
+
+<DT><B>rows=</B><EM>value</EM> 
+<DD>The number of rows in the training samples, this must be odd.</DD>
+<DT><B>cols=</B><EM>value</EM> 
+<DD>The number of colums in the training samples, this must be odd.</DD>
+
+<DT><B>class=</B><EM>value</EM> 
+<DD>The numerical label to be attached to the training examples. This is only required when the interactive mode of i.pr.training is used. </DD>
+
+<H2>NOTES</H2>
+
+
+<H2>SEE ALSO</H2>
+
+<EM><A HREF="i.features.html">i.cca</A></EM><br>
+
+<H2>AUTHORS</H2>
+
+Stefano Merler, FBK, Trento, Italy<br>
+Documentation: Daniel McInerney (daniel.mcinerney ucd.ie)
+
+<p><i>Last changed: $Date: 2007/12/04 10:04:03 $</i>

