Browse Source

v.rast.stats: manual updated by Stefan Blumentrath; msg cosmetics

git-svn-id: https://svn.osgeo.org/grass/grass/branches/releasebranch_7_0@61963 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 10 years ago
parent
commit
20332272fb
2 changed files with 13 additions and 15 deletions
  1. 12 14
      scripts/v.rast.stats/v.rast.stats.html
  2. 1 1
      scripts/v.rast.stats/v.rast.stats.py

+ 12 - 14
scripts/v.rast.stats/v.rast.stats.html

@@ -5,15 +5,12 @@ a raster map only for the parts covered by the specified vector map.
 The vector map will be rasterized according to the raster map resolution.
 Then univariate statistics are calculated per vector category (cat) from
 the raster map and the results uploaded to the vector map attribute table.
-New columns are generated in the attribute table if not already present.
-<p>Nine columns are generated (n, min, max, range, mean, stddev, variance, 
-coeff_var, sum) according to the output of <em>r.univar</em>.
-If the <b>-e</b> extended statistics flag is given the 1st quartile,
-median, 3rd quartile, and given percentile are also calculated.
-
+A new column is generated in the attribute table for each statistic requested 
+in <b>method</b> (if not already present).
 
 <h2>NOTES</h2>
-
+<em>v.rast.stats</em> is only meaningful for lines or polygons.
+<p> 
 The module may take a long time to run if the raster region contains a large
 number of cells. In this case the <b>--verbose</b> flag may be used to track
 progress.
@@ -29,11 +26,11 @@ will be chopped off.
 <p>If a MASK is present, it will be restored after the script finished.
 The script changes temporarily to the resolution of the given raster map.
 <p><!-- r.univar limitation -->
-Large amounts of system memory can be used when the <b>-e</b> extended
-statistics flag is used with a very large region setting. If the region
-is too large the module should display memory allocation errors.
-Basic statistics can be calculated using any size input region.
-
+Large amounts of system memory can be used when extended statistics 
+(<em>first_quartile,median,third_quartile,percentile </em>) are being requested 
+with a very large region setting. If the region is too large the module 
+should display memory allocation errors. Basic statistics can be calculated 
+using any size input region.
 
 <h2>EXAMPLES</h2>
 
@@ -45,14 +42,15 @@ g.copy vect=zipcodes_wake,myzipcodes_wake
 # set computational region to DEM:
 g.region rast=elevation -p
 # calculate DEM statistics, upload to vector map table:
-v.rast.stats myzipcodes_wake raster=elevation colprefix=elev
+v.rast.stats myzipcodes_wake raster=elevation \
+  column_prefix=elev method=minimum,maximum,average,stddev,percentile \
+  percentile=95
 # verify results:
 v.info -c myzipcodes_wake
 v.db.select myzipcodes_wake
 v.univar myzipcodes_wake column=elev_range type=centroid
 </pre></div>
 
-
 <h2>SEE ALSO</h2>
 
 <em>

+ 1 - 1
scripts/v.rast.stats/v.rast.stats.py

@@ -18,7 +18,7 @@
 #############################################################################
 
 #%module
-#% description: Calculates univariate statistics from a raster map based on vector polygon map and uploads statistics to new attribute columns.
+#% description: Calculates univariate statistics from a raster map based on a vector map and uploads statistics to new attribute columns.
 #% keywords: vector
 #% keywords: statistics
 #% keywords: raster