浏览代码

Documentation update

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@52541 15284696-431f-4ddb-bdfa-cd5b030d7da7
Soeren Gebbert 13 年之前
父节点
当前提交
ca2a274194

+ 2 - 2
temporal/t.list/t.list.py

@@ -5,7 +5,7 @@
 # MODULE:	t.list
 # MODULE:	t.list
 # AUTHOR(S):	Soeren Gebbert
 # AUTHOR(S):	Soeren Gebbert
 #               
 #               
-# PURPOSE:	List space time and map datasets
+# PURPOSE:	List space time datasets and maps registered in the temporal database
 # COPYRIGHT:	(C) 2011 by the GRASS Development Team
 # COPYRIGHT:	(C) 2011 by the GRASS Development Team
 #
 #
 #		This program is free software under the GNU General Public
 #		This program is free software under the GNU General Public
@@ -15,7 +15,7 @@
 #############################################################################
 #############################################################################
 
 
 #%module
 #%module
-#% description: Lists space time datasets and maps.
+#% description: List space time datasets and maps registered in the temporal database
 #% keywords: temporal
 #% keywords: temporal
 #% keywords: list
 #% keywords: list
 #%end
 #%end

+ 10 - 5
temporal/t.rast.aggregate/t.rast.aggregate.html

@@ -1,12 +1,16 @@
 <h2>DESCRIPTION</h2>
 <h2>DESCRIPTION</h2>
 
 
 <em>t.rast.aggregate</em> temporally aggregates space time raster datasets by a specific temporal granularity.
 <em>t.rast.aggregate</em> temporally aggregates space time raster datasets by a specific temporal granularity.
-The granularity can be <em>seconds, minutes, hours, days, weeks, months</em> and <em>years</em>.
-Mixing of granularities is not supported.
+This module support <em>absolute</em> and <em>relative time</em>.
+The temporal granularity of absolute time can be 
+<em>seconds, minutes, hours, days, weeks, months</em> or <em>years</em>.
+Mixing of granularities is not supported. 
+In case of relative time the temporal unit of the input space time raster dataset is used. The granularity
+must be specified with an integer value. 
 <p>
 <p>
 This module is sensitive to the current region and mask settings, hence spatial extent and spatial resolution. 
 This module is sensitive to the current region and mask settings, hence spatial extent and spatial resolution. 
 In case the registered raster maps of the input space time raster dataset
 In case the registered raster maps of the input space time raster dataset
-have different spatial resolutions, the default nearest neighbour resampling method is used for
+have different spatial resolutions, the default nearest neighbor resampling method is used for
 runtime spatial aggregation.
 runtime spatial aggregation.
 
 
 <h2>NOTES</h2>
 <h2>NOTES</h2>
@@ -21,7 +25,7 @@ provided temporal granularity. The following shifts will performed:
 <ul>
 <ul>
     <li><em>granularity years</em>: will start at the first of January, hence 14-08-2012 00:01:30 will be shifted to 01-01-2012 00:00:00</li>
     <li><em>granularity years</em>: will start at the first of January, hence 14-08-2012 00:01:30 will be shifted to 01-01-2012 00:00:00</li>
     <li><em>granularity months</em>: will start at the first day of a month, hence 14-08-2012 will be shifted to 01-08-2012 00:00:00</li>
     <li><em>granularity months</em>: will start at the first day of a month, hence 14-08-2012 will be shifted to 01-08-2012 00:00:00</li>
-    <li><em>granularity weeks</em>: will start at the first day of a week (monday), hence 14-08-2012 01:30:30 will be shifted to 13-08-2012 01:00:00</li>
+    <li><em>granularity weeks</em>: will start at the first day of a week (Monday), hence 14-08-2012 01:30:30 will be shifted to 13-08-2012 01:00:00</li>
     <li><em>granularity days</em>: will start at the first hour of a day, hence 14-08-2012 00:01:30 will be shifted to 14-08-2012 00:00:00</li>
     <li><em>granularity days</em>: will start at the first hour of a day, hence 14-08-2012 00:01:30 will be shifted to 14-08-2012 00:00:00</li>
     <li><em>granularity hours</em>: will start at the first minute of a hour, hence 14-08-2012 01:30:30 will be shifted to 14-08-2012 01:00:00</li>
     <li><em>granularity hours</em>: will start at the first minute of a hour, hence 14-08-2012 01:30:30 will be shifted to 14-08-2012 01:00:00</li>
     <li><em>granularity minutes</em>: will start at the first second of a minute, hence 14-08-2012 01:30:30 will be shifted to 14-08-2012 01:30:00</li>
     <li><em>granularity minutes</em>: will start at the first second of a minute, hence 14-08-2012 01:30:30 will be shifted to 14-08-2012 01:30:00</li>
@@ -77,9 +81,10 @@ t.info type=strds input=precipitation_weekly
 <em>
 <em>
 <a href="t.rast.aggregate.ds.html">t.rast.aggregate.ds</a><br>
 <a href="t.rast.aggregate.ds.html">t.rast.aggregate.ds</a><br>
 <a href="t.rast.extract.html">t.rast.extract</a><br>
 <a href="t.rast.extract.html">t.rast.extract</a><br>
+<a href="t.info.html">t.info</a><br>
 <a href="r.series.html">r.series</a><br>
 <a href="r.series.html">r.series</a><br>
 <a href="g.region.html">g.region</a><br>
 <a href="g.region.html">g.region</a><br>
-<a href="t.info.html">t.info</a><br>
+<a href="r.mask.html">r.mask</a><br>
 </em>
 </em>
 
 
 
 

+ 5 - 4
temporal/t.rast.aggregate/t.rast.aggregate.py

@@ -5,7 +5,7 @@
 # MODULE:	tr.aggregate
 # MODULE:	tr.aggregate
 # AUTHOR(S):	Soeren Gebbert
 # AUTHOR(S):	Soeren Gebbert
 #
 #
-# PURPOSE:	Create a new space time raster dataset from the aggregated data of an existing space time raster dataset
+# PURPOSE:	Temporally aggregates the maps of a space time raster dataset by a user defined granularity.
 # COPYRIGHT:	(C) 2011 by the GRASS Development Team
 # COPYRIGHT:	(C) 2011 by the GRASS Development Team
 #
 #
 #		This program is free software under the GNU General Public
 #		This program is free software under the GNU General Public
@@ -15,7 +15,7 @@
 #############################################################################
 #############################################################################
 
 
 #%module
 #%module
-#% description: Creates a new space time raster dataset from the aggregated data of an existing space time raster dataset.
+#% description: Temporally aggregates the maps of a space time raster dataset by a user defined granularity.
 #% keywords: temporal
 #% keywords: temporal
 #% keywords: aggregation
 #% keywords: aggregation
 #%end
 #%end
@@ -29,7 +29,7 @@
 #%option
 #%option
 #% key: granularity
 #% key: granularity
 #% type: string
 #% type: string
-#% description: Aggregation granularity, format absolute time "x years, x months, x weeks, x days, x hours, x minutes, x seconds" or a double value for relative time
+#% description: Aggregation granularity, format absolute time "x years, x months, x weeks, x days, x hours, x minutes, x seconds" or an integer value for relative time
 #% required: yes
 #% required: yes
 #% multiple: no
 #% multiple: no
 #%end
 #%end
@@ -151,7 +151,8 @@ def main():
         input_map_names = tgis.collect_map_names(sp, dbif, start, end, sampling)
         input_map_names = tgis.collect_map_names(sp, dbif, start, end, sampling)
 
 
         if input_map_names:
         if input_map_names:
-            new_map = tgis.aggregate_raster_maps(input_map_names, base, start, end, count, method, register_null, dbif)
+            new_map = tgis.aggregate_raster_maps(input_map_names, base, start, end, 
+						count, method, register_null, dbif)
 
 
             if new_map:
             if new_map:
                 # Set the time stamp and write it to the raster map
                 # Set the time stamp and write it to the raster map