Changeset 70728

Timestamp:

Mar 4, 2017, 11:53:59 PM (7 years ago)

Author:

huhabla

Message:

temporal modules t.register: Applied patch from Veronica Andreo for better documentation and spelling

Location:

grass/trunk/temporal/t.register

Files:

• t.register.html (modified) (12 diffs)
• t.register.py (modified) (6 diffs)

grass/trunk/temporal/t.register/t.register.html

@@ -3 +3 @@
 The module <em>t.register</em> is designed to register raster, 3D
 raster and vector maps in the temporal database and in specific space
-time datasets. This module must be used to assign time stamps to
+time datasets (stds). This module must be used to assign timestamps to
 raster, 3D raster and vector maps. The existing timestamp modules
 <a href="r.timestamp.html">r.timestamp</a>,
@@ -13 +13 @@
 database.
 <p>
+If the <em>input</em> option is not used (i.e.: no stds is provided), maps
+will be only registered in the temporal database with assigned
+timestamps. If, however, the <em>input</em> option
+is used and a stds is provided, maps will be first registered in the temporal
+database (if not registered before) and then, in the stds specified. If the
+user wants to register maps that are already registered in the temporal
+database in a different stds, there is no need to pass information regarding
+start and end time, <em>t.register</em> will read timestamps from the temporal
+database.
+<p>
 This module supports absolute and relative time. The absolute temporal type
 refers to a fixed date while the relative temporal type refers to data
-without fixed time stamps (e.g., sequential maps used to calculate
+without fixed timestamps (e.g., sequential maps used to calculate
 multi-decadal averages).
-
-<p>
-Maps can be registered by command line argument (a list of comma separated map
+<p>
+Maps can be registered by command line argument (i.e.: a list of comma separated map
 names) or using an input file. The start time, the end time and a temporal
 increment can be provided by command line or in the input file. End time and
-increment are mutual exclusive. The user can register single maps or a
+increment are mutually exclusive. The user can register single maps or a
 list of maps at once. Maps can be registered in several space time
 datasets using the same timestamp.
@@ -28 +37 @@
 The <em>increment</em> option and the <b>-i</b> flag (to create time intervals)
 work only in conjunction with the <b>start</b> option.
-If an input file with time stamps is used, then the <em>increment</em> option
-and the <b>-i</b> flag are not supported.
+If an input file with timestamps (either start time or start time and end time)
+is used, then the <em>increment</em> option and the <b>-i</b> flag are not supported.
 <p>
 Start time and end time with absolute time must be provided using the
-format <b>yyyy-mm-dd HH:MM:SS +HHMM</b>. It is supported to specify
-only the date <b>yyyy-mm-dd</b>. In case of relative time the temporal
+format <b>yyyy-mm-dd HH:MM:SS +HHMM</b>. It is also supported to specify
+only the date <b>yyyy-mm-dd</b>. In case of relative time, the temporal
 unit (years, months, days, hours, minutes or seconds) must be provided.
-The relative start time, end time and the increment are integers.
+In this case, the relative start time, end time and increment are integers.
 
 <h2>NOTES</h2>
@@ -49 +58 @@
 <h2>INPUT FILE FORMAT</h2>
 
-The input file consists of a list of map names, optionally along with time stamps.
-Each map name is to be stored in a row in this file.
-<p>
-There are several options to register maps, <em>increment</em> option and
-the <b>-i</b> flag are supported:
-<p>
-Specification of map names:
+There are several options to register maps by means of a file. The input file
+consists of a list of map names, optionally along with timestamps. Each map
+name (and timestaps if provided) should be stored in a new line in this file.
+<p>
+When only map names are provided, the <em>increment</em> option and the <b>-i</b>
+flag are supported. However, when along with map names any kind of timestamp is
+provided, as well, the <em>increment</em> option and the <b>-i</b> are no longer
+supported.
+<p>
+Specification of map names only (<em>increment</em> option and <b>-i</b> flag
+supported):
 <div class="code"><pre>
 terra_lst_day20020113
@@ -65 +78 @@
 
 <p>
-Specification of map names and the absolute start time (date) of the time
-instances, not support for <em>increment</em> option and the <b>-i</b> flag:
+Specification of map names and absolute start time (date) of the time
+instances (no support for <em>increment</em> option nor <b>-i</b> flag):
 <div class="code"><pre>
 terra_lst_day20020113|2002-01-13
@@ -76 +89 @@
 
 <p>
-Specification of map names and the absolute time stamp (datetime),
-not support for <em>increment</em> option and the <b>-i</b> flag:
+Specification of map names and absolute start time (datetime) of the time
+instances (no support for <em>increment</em> option nor <b>-i</b> flag):
 <div class="code"><pre>
 terra_lst_day20020113|2002-01-13 10:30
@@ -87 +100 @@
 
 <p>
-Specification of the map name and the absolute time interval with start,
-not support for <em>increment</em> option and the <b>-i</b> flag:
-and end time:
+Specification of map names and absolute time interval with start and end time
+(no support for <em>increment</em> option nor <b>-i</b> flag):
 <div class="code"><pre>
 prec_1|2001-01-01|2001-04-01
@@ -104 +116 @@
 
 <h4>Using a text file</h4>
-Register maps in a absolute space time dataset, creating a time interval
+Register maps in an absolute space time dataset, creating a time interval
 
 <div class="code"><pre>
@@ -117 +129 @@
 <h4>Using <em>g.list</em> to generate the input</h4>
 
-Register maps in a absolute space time dataset, creating a time interval
+Register maps in an absolute space time dataset, creating a time interval
 
 <div class="code"><pre>
@@ -129 +141 @@
 In this example we create 6 raster maps that will be registered in a
 single space time raster dataset named precip_abs using a monthly
-temporal granularity. The <b>-i</b> flag generates interval time. The
-generated timestamps will be inspected using <em>r.timestamp</em> and
-<em>t.rast.list</em>. We will register an additional map with a timestamp
-that was set with <em>r.timestamp</em>.
+temporal granularity. The <b>-i</b> flag generates time intervals of the
+provided <em>increment</em>. The generated timestamps will be inspected
+using <em>r.timestamp</em> and <em>t.rast.list</em>. We will register an
+additional map with a timestamp that was set with <em>r.timestamp</em>.
 
 <div class="code"><pre>
@@ -190 +202 @@
 Europe based on ECA&amp;D information.
 
-Download and decompress mean temperature data from: 
+Download and decompress mean temperature data from:
 <a href="http://eca.knmi.nl/download/ensembles/data/Grid_0.25deg_reg/">here</a>
 by accepting their
@@ -214 +226 @@
 # create text file with all temperature_mean rasters, one per line,
 # a) using a shell script
-for i in `seq 1 23922` ; do 
+for i in `seq 1 23922` ; do
     echo temperature_mean.$i &gt;&gt; map_list.txt
 done

grass/trunk/temporal/t.register/t.register.py

@@ -6 +6 @@
 # AUTHOR(S):    Soeren Gebbert
 #
-# PURPOSE:      Register raster, vector and raster3d maps in a space time datasets
+# PURPOSE:      Registers raster, vector and raster3d maps in a space time dataset
 # COPYRIGHT:    (C) 2011-2014, Soeren Gebbert and the GRASS Development Team
 #
@@ -16 +16 @@
 
 #%module
-#% description: Registers raster, vector and raster3d maps in a space time datasets.
+#% description: Registers raster, vector and raster3d maps in a space time dataset.
 #% keyword: temporal
 #% keyword: map management
@@ -51 +51 @@
 #% type: string
 #% label: Valid start date and time of the first map
-#% description: Format absolute time: "yyyy-mm-dd HH:MM:SS +HHMM", relative time is of type integer).
+#% description: Format for absolute time: "yyyy-mm-dd HH:MM:SS +HHMM", relative time is of type integer.
 #% required: no
 #% multiple: no
@@ -61 +61 @@
 #% type: string
 #% label: Valid end date and time of all map
-#% description: Format absolute time: "yyyy-mm-dd HH:MM:SS +HHMM", relative time is of type integer).
+#% description: Format for absolute time: "yyyy-mm-dd HH:MM:SS +HHMM", relative time is of type integer.
 #% required: no
 #% multiple: no
@@ -71 +71 @@
 #% type: string
 #% label: Time stamp unit
-#% description: Unit must be set in case of relative time stamps
+#% description: Unit must be set in case of relative timestamps
 #% required: no
 #% multiple: no
@@ -82 +82 @@
 #% type: string
 #% label: Time increment, works only in conjunction with start option
-#% description: Time increment between maps for valid time interval creation (format absolute: NNN seconds, minutes, hours, days, weeks, months, years; format relative is integer: 5)
+#% description: Time increment between maps for creation of valid time intervals (format for absolute time: NNN seconds, minutes, hours, days, weeks, months, years; format for relative time is of type integer: 5)
 #% required: no
 #% multiple: no