[GRASS-SVN] r69988 - grass-addons/grass7/imagery/i.segment.stats

Sat Dec 3 13:53:04 PST 2016

Author: martinl
Date: 2016-12-03 13:53:04 -0800 (Sat, 03 Dec 2016)
New Revision: 69988

Modified:
   grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.html
   grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.py
Log:
i.segment.stats: manual syntax + ui description cosmetics

Modified: grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.html
===================================================================

--- grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.html	2016-12-03 21:38:19 UTC (rev 69987)
+++ grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.html	2016-12-03 21:53:04 UTC (rev 69988)
@@ -3,48 +3,47 @@
 <p>
 <em>i.segment.stats</em> calculates statistics for areas in a raster
 map. Areas are defined by adjacent pixels with the same value. Such
-areas can be the output of <a href="i.segment.html">i.segment</a> or
-<a href="r.clump.html">r.clump</a>.
+areas can be the output of <em><a href="i.segment.html">i.segment</a></em> or
+<em><a href="r.clump.html">r.clump</a></em>.
 
 <p>
 Available statistics are those related to the shape and size of the areas
-(see the 
-<a href="<a href="https://grass.osgeo.org/grass70/manuals/addons/r.object.geometry.html">r.object.geometry</a>
+(see the <em><a href="r.object.geometry.html">r.object.geometry</a></em>
 addon man page for more information
 on the statistics) and aggregated statistics of pixel values of other
-raster maps (see <a href="v.univar.html">v.univar</a> for details).
+raster maps (see <em><a href="v.univar.html">v.univar</a></em> for details).
 
 <p>
-The user can chose between output in the form of a vector map of the areas
-with the statistics in the attribute table and/or in the form of a CSV
-text file.
+The user can chose between output in the form of a vector map of the
+areas with the statistics in the attribute table (<b>vectormap</b>)
+and/or in the form of a CSV text file (<b>csvfile</b>).
 
 <h2>NOTES</h2>
 
 <p>
-The module respects the current region settings. The <em>-r</em> flag allows
+The module respects the current region settings. The <b>-r</b> flag allows
 to force the module to adjust the region to the input raster map before
 calculating the statistics.
 
 <p>
-This module is a simple front-end to <a href="v.univar.html">v.univar</a>
+This module is a simple front-end to <em><a href="v.univar.html">v.univar</a></em>
 and the 
-<a href="<a href="https://grass.osgeo.org/grass70/manuals/addons/r.object.geometry.html">r.object.geometry</a>
+<em><a href="r.object.geometry.html">r.object.geometry</a></em>
 add-on. It is the user's responsibility to install the
-latter using <a href="g.extension.html">g.extension</a>. If other statistics 
+latter using <em><a href="g.extension.html">g.extension</a></em>. If other statistics 
 are desired, these should probably be implemented in those (or other) modules
 which can then be called from this module.
 
 <p>
 Problems can arise in the calculation of some form statistics for certain
 segment forms. If errors arise, the user might want to try to run 
-<a href="r.clump.html">r.clump</a> on the input raster file before running
+<em><a href="r.clump.html">r.clump</a></em> on the input raster file before running
 <em>i.segment.stats</em>.
 
 <p>
 When treating files with a large number objects, creating the vector map
 can be very time-consuming. In that case, it might be easier to only work
-with the csv-format output.
+with the <b>csvfile</b> output.
 
 
 <h2>EXAMPLE</h2>
@@ -66,11 +65,13 @@
 </em>
 <p>
 <em>
-<a href="https://grass.osgeo.org/grass70/manuals/addons/r.object.geometry.html">r.object.geometry (Addon)</a>
-<a href="https://grass.osgeo.org/grass70/manuals/addons/v.class.mlR.html">v.class.mlR (Addon)</a>
+<a href="r.object.geometry.html">r.object.geometry (Addon)</a>
+<a href="v.class.mlR.html">v.class.mlR (Addon)</a>
 </em>
 
 <h2>AUTHOR</h2>
+
 Moritz Lennert
 
-<p><i>Last changed: $Date$</i>
+<p>
+<i>Last changed: $Date$</i>

Modified: grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.py
===================================================================
--- grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.py	2016-12-03 21:38:19 UTC (rev 69987)
+++ grass-addons/grass7/imagery/i.segment.stats/i.segment.stats.py	2016-12-03 21:53:04 UTC (rev 69988)
@@ -14,13 +14,13 @@
 #############################################################################
 
 #%module
-#% description: Calculates statistics describing raster areas
+#% description: Calculates statistics describing raster areas.
 #% keyword: imagery
 #% keyword: segmentation
 #% keyword: statistics
 #%end
 #%option G_OPT_R_MAP
-#% label: Raster map with areas (all pixels of an area have same id)
+#% label: Name for input raster map with areas (all pixels of an area have same id)
 #% description: Raster map with areas, such as the output of i.segment
 #% required: yes
 #%end
@@ -29,17 +29,17 @@
 #% description: Name of input raster maps for statistics
 #% multiple: yes
 #% required: no
-#% guisection: raster_statistics
+#% guisection: Raster statistics
 #%end
 #%option
 #% key: raster_statistics
 #% type: string
-#% label: Statistics to calulate for each input raster map
+#% label: Statistics to calculate for each input raster map
 #% required: no
 #% multiple: yes
 #% options: min,max,range,mean,mean_of_abs,stddev,variance,coeff_var,sum,sum_abs,first_quart,median,third_quart,perc_90
 #% answer: mean,stddev,sum
-#% guisection: raster_statistics
+#% guisection: Raster statistics
 #%end
 #%rules
 #% requires: raster_statistics,rasters
@@ -52,22 +52,22 @@
 #% multiple: yes
 #% options: area,perimeter,compact_circle,compact_square,fd
 #% answer: area,perimeter,compact_circle,fd
-#% guisection: shape_statistics
+#% guisection: Shape statistics
 #%end
 #%option G_OPT_F_OUTPUT
 #% key: csvfile
-#% label: CSV output file containing statistics
+#% description: Name for output CSV file containing statistics
 #% required: no
-#% guisection: output
+#% guisection: Output
 #%end
 #%option G_OPT_F_SEP
-#% guisection: output
+#% guisection: Output
 #%end
 #% option G_OPT_V_OUTPUT
 #% key: vectormap
-#% label: Optional vector output map with statistics as attributes
+#% description: Name for optional vector output map with statistics as attributes
 #% required: no
-#% guisection: output
+#% guisection: Output
 #%end
 #%rules
 #% required: csvfile,vectormap

