[GRASS-SVN] r70728 - grass/trunk/temporal/t.register
svn_grass at osgeo.org
svn_grass at osgeo.org
Sat Mar 4 23:53:59 PST 2017
Author: huhabla
Date: 2017-03-04 23:53:59 -0800 (Sat, 04 Mar 2017)
New Revision: 70728
Modified:
grass/trunk/temporal/t.register/t.register.html
grass/trunk/temporal/t.register/t.register.py
Log:
temporal modules t.register: Applied patch from Veronica Andreo for better documentation and spelling
Modified: grass/trunk/temporal/t.register/t.register.html
===================================================================
--- grass/trunk/temporal/t.register/t.register.html 2017-03-05 07:35:58 UTC (rev 70727)
+++ grass/trunk/temporal/t.register/t.register.html 2017-03-05 07:53:59 UTC (rev 70728)
@@ -2,7 +2,7 @@
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>,
<a href="r3.timestamp.html">r3.timestamp</a> and
@@ -12,29 +12,38 @@
works only for maps that are not already registered in the temporal
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
+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.
<p>
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>
@@ -48,13 +57,17 @@
<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.
+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>
-There are several options to register maps, <em>increment</em> option and
-the <b>-i</b> flag are supported:
+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:
+Specification of map names only (<em>increment</em> option and <b>-i</b> flag
+supported):
<div class="code"><pre>
terra_lst_day20020113
terra_lst_day20020114
@@ -64,8 +77,8 @@
</pre></div>
<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
terra_lst_day20020114|2002-01-14
@@ -75,8 +88,8 @@
</pre></div>
<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
terra_lst_day20020114|2002-01-14 10:30
@@ -86,9 +99,8 @@
</pre></div>
<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
prec_2|2001-04-01|2001-07-01
@@ -103,7 +115,7 @@
<h3>North Carolina dataset</h3>
<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>
# first: prepare a text file with a list of input maps (see above)
@@ -116,7 +128,7 @@
<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>
t.register -i type=raster input=precipitation_monthly \
@@ -128,10 +140,10 @@
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>
r.mapcalc expression="prec_1 = 100"
@@ -189,7 +201,7 @@
dataset for precipitation, temperature and sea level pressure in
Europe based on ECA&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
<a href="http://eca.knmi.nl/download/ensembles/ensembles.php">Terms of use</a>.
@@ -213,7 +225,7 @@
# 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 >> map_list.txt
done
Modified: grass/trunk/temporal/t.register/t.register.py
===================================================================
--- grass/trunk/temporal/t.register/t.register.py 2017-03-05 07:35:58 UTC (rev 70727)
+++ grass/trunk/temporal/t.register/t.register.py 2017-03-05 07:53:59 UTC (rev 70728)
@@ -5,7 +5,7 @@
# MODULE: t.register
# 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
#
# This program is free software under the GNU General Public
@@ -15,7 +15,7 @@
#############################################################################
#%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
#% keyword: register
@@ -50,7 +50,7 @@
#% key: start
#% 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
#% guisection: Time & Date
@@ -60,7 +60,7 @@
#% key: end
#% 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
#% guisection: Time & Date
@@ -70,7 +70,7 @@
#% key: unit
#% 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
#% options: years,months,days,hours,minutes,seconds
@@ -81,7 +81,7 @@
#% key: increment
#% 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
#% guisection: Time & Date
More information about the grass-commit
mailing list