[GRASS-SVN] r55500 - grass/trunk/temporal/t.register

[svn_grass at osgeo.org]

Author: huhabla
Date: 2013-03-22 11:54:56 -0700 (Fri, 22 Mar 2013)
New Revision: 55500

Modified:
   grass/trunk/temporal/t.register/t.register.html
Log:
Manual page update


Modified: grass/trunk/temporal/t.register/t.register.html
===================================================================
--- grass/trunk/temporal/t.register/t.register.html	2013-03-22 18:54:43 UTC (rev 55499)
+++ grass/trunk/temporal/t.register/t.register.html	2013-03-22 18:54:56 UTC (rev 55500)
@@ -1,11 +1,85 @@
 <h2>DESCRIPTION</h2>
 
-TBD.
+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 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 <a href="v.timestamp.html">v.timestamp</a> 
+should not be used, since they do not register the maps in the temporal database of GRASS.
+<p>
+This module supports absolute and relative time. Maps can be registered by command line argument 
+(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 list of maps at once. Maps can be registered in several 
+space time datasets using the same time stamp.
+<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 unit (years, months, days, hours, minutes or seconds) must be provided.
+The relative start time, end time and the increment are integers.
 
+<p>
+
+
+<h2>INPUT FILE FOTMAT</h2>
+
+Specification of map names:
+<div class="code"><pre>
+prec_1
+prec_2
+prec_3
+prec_4
+prec_5
+prec_6
+</pre></div>
+Specification of map names and the absolut start time of the time instances:
+<div class="code"><pre>
+prec_1|2001-01-01
+prec_2|2001-02-01
+prec_3|2001-03-01
+prec_4|2001-04-01
+prec_5|2001-05-01
+prec_6|2001-06-01
+</pre></div>
+Specification of the map name and the absolute time interval with start and end time:
+<div class="code"><pre>
+prec_1|2001-01-01|2001-04-01
+prec_2|2001-04-01|2001-07-01
+prec_3|2001-07-01|2001-10-01
+prec_4|2001-10-01|2002-01-01
+prec_5|2002-01-01|2002-04-01
+prec_6|2002-04-01|2002-07-01
+</pre></div>
+
+<h2>EXAMPLE</h2>
+
+In this example we create 6 raster maps that will be registered in a single space time
+raster dataset named <em>precip_abs</em> using a monthly temporal granularity. The -i flag generates interval time.
+
+<div class="code"><pre>
+r.mapcalc --o expr="prec_1 = 100"
+r.mapcalc --o expr="prec_2 = 200"
+r.mapcalc --o expr="prec_3 = 300"
+r.mapcalc --o expr="prec_4 = 400"
+r.mapcalc --o expr="prec_5 = 500"
+r.mapcalc --o expr="prec_6 = 600"
+
+t.create --o type=strds temporaltype=absolute \
+    output=precip_abs title="Eexample" \
+    descr="Example"
+
+t.register -i type=rast input=precip_abs \
+    maps=prec_1,prec_2,prec_3,prec_4,prec_5,prec_6 \
+    start="2001-01-01" increment="1 months"
+</pre></div>
+
+
 <h2>SEE ALSO</h2>
 
 <em>
-<a href="t.create.html">t.create</a>,
+<a href="t.create.html">t.create</a><br>
 <a href="t.info.html">t.info</a>
 </em>