Changeset 3214


Ignore:
Timestamp:
12/27/07 13:55:30 (11 years ago)
Author:
paulf
Message:

added new tank player tools stuff

Location:
trunk/ewdoc/WEB_DOC/ovr
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/ewdoc/WEB_DOC/ovr/tankplayer_ovr.html

    r2493 r3214  
    1  
    2 <HTML> 
    3 <HEAD> 
    4 <TITLE>Earthworm Modules: Tankplayer overview</TITLE> 
    5 </HEAD> 
    6 <CENTER><H1>Tankplayer Overview</H1> 
    7 <I>(last revised 19 May 2006)</I></CENTER> 
    8  
    9 <P> 
    10 "tankplayer" is part of the four-program set for recording and playing back the trace data for selected time intervals. See also <A HREF="trig2disk_ovr.html">trig2disk</A>, <A HREF="waveman2disk_ovr.html">waveman2disk</A>, and <A HREF="wave_serverV_ovr.html">wave_serverV</A>.  
    11 <P> 
    12 Tankplayer has two common uses: 
    13 <P> 
    14 Tuning Operating Earthworms: 
    15 <P> 
    16 For example, an Earthworm system fails to locate a significant earthquake.  The waveform data for the earthquake is requested from the wave_server and saved in tankplayer format.  Using an experimental Earthworm, the event is played back with tankplayer, tuning the operational parameters until Earthworm performs satisfactorally.  The operational parameters are then changed to those used in the test. 
    17 <P> 
    18 Quality Assurance: 
    19 <P> 
    20 One is to perform quality assurance tests. For such tests, an experimental Earthworm system would be set up, and one or more tankplayers would be connected as the data source. Each tankplayer would be given a lengthy list of data files, and "tankplayer" would play (broadcast into the earthworm) the trace data from these files, one after another, generally overnight. The earthworm system under test would then process the incoming data. In the morning, we would come in and examine the rubble.  
    21 <P>  
    22 Menlo Park has created a collection of over 50 historic trace data files, representing the trace data traffic during various 'moments of horror' at CalNet. These include the Loma Prieta mainshock, swarms during wind storms, concurrent events in different parts of the net, events during telemetry malfunctions, etc. These files were painfully created by reformatting CUSP data archive files. The format of these files is simple: it is a series of messages of TYPE_ADBUF, written with a binary write. 
    23 <P> 
    24 How Tankplayer Works: 
    25 <P> 
    26 On startup, tankplayer reads its configuration file. This specifies the message ring into which to inject the data, and the module name to use. Tankplayer is generally told to imitate a real data source, such as an A/D module, or a digital acquisition module. The parameter file also lists the data files to be played back. It also specifies a pause period. This was implemented to prevent the earthworm associator (binder) from becoming confused by rapid jumps in time between data files. This time period should be set to be larger than binder's association memory, to prevent it from trying to associate phase arrivals from different data files. 
    27 <P> 
    28 In operation, tankplayer places the waveform messages from its input file(S) into shared memory in simulated real time, using the delta-t between time-stamps in successive message headers to determine its timing. When the end of file is reached, it waits "Pause" number of seconds, and goes on to the next file, as specified in the parameter file. 
    29 </P> 
    30 <P> 
    31 Tankplayer is location code compliant and backward compatible.  It accepts 
    32 messages of either tracebuf or tracebuf2 as configured using the PlayMsgType 
     1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
     2<html> 
     3<head> 
     4  <title>Earthworm Modules: Tankplayer overview</title> 
     5</head> 
     6<body> 
     7<center> 
     8<h1>Tankplayer Overview</h1> 
     9<i>(last revised December 27, 2007)</i></center> 
     10<p> 
     11"tankplayer" is part of the four-program set for recording and playing 
     12back the trace data for selected time intervals. See also <a 
     13 href="trig2disk_ovr.html">trig2disk</a>, <a 
     14 href="waveman2disk_ovr.html">waveman2disk</a>, and <a 
     15 href="wave_serverV_ovr.html">wave_serverV</a>. </p> 
     16<p>Tankplayer has two common uses: 
     17</p> 
     18<p>Tuning Operating Earthworms: 
     19</p> 
     20<p>For example, an Earthworm system fails to locate a significant 
     21earthquake. The waveform data for the earthquake is requested from the 
     22wave_server and saved in tankplayer format. Using an experimental 
     23Earthworm, the event is played back with tankplayer, tuning the 
     24operational parameters until Earthworm performs satisfactorally. The 
     25operational parameters are then changed to those used in the test. 
     26</p> 
     27<p>Quality Assurance: 
     28</p> 
     29<p>One is to perform quality assurance tests. For such tests, an 
     30experimental Earthworm system would be set up, and one or more 
     31tankplayers would be connected as the data source. Each tankplayer 
     32would be given a lengthy list of data files, and "tankplayer" would 
     33play (broadcast into the earthworm) the trace data from these files, 
     34one after another, generally overnight. The earthworm system under test 
     35would then process the incoming data. In the morning, we would come in 
     36and examine the rubble. </p> 
     37<p> Menlo Park has created a collection of over 50 historic trace data 
     38files, representing the trace data traffic during various 'moments of 
     39horror' at CalNet. These include the Loma Prieta mainshock, swarms 
     40during wind storms, concurrent events in different parts of the net, 
     41events during telemetry malfunctions, etc. These files were painfully 
     42created by reformatting CUSP data archive files. The format of these 
     43files is simple: it is a series of messages of TYPE_ADBUF, written with 
     44a binary write. 
     45</p> 
     46<p>How Tankplayer Works: 
     47</p> 
     48<p>On startup, tankplayer reads its configuration file. This specifies 
     49the message ring into which to inject the data, and the module name to 
     50use. Tankplayer is generally told to imitate a real data source, such 
     51as an A/D module, or a digital acquisition module. The parameter file 
     52also lists the data files to be played back. It also specifies a pause 
     53period. This was implemented to prevent the earthworm associator 
     54(binder) from becoming confused by rapid jumps in time between data 
     55files. This time period should be set to be larger than binder's 
     56association memory, to prevent it from trying to associate phase 
     57arrivals from different data files. 
     58</p> 
     59<p>In operation, tankplayer places the waveform messages from its input 
     60file(S) into shared memory in simulated real time, using the delta-t 
     61between time-stamps in successive message headers to determine its 
     62timing. When the end of file is reached, it waits "Pause" number of 
     63seconds, and goes on to the next file, as specified in the parameter 
     64file. 
     65</p> 
     66<p> 
     67Tankplayer is location code compliant and backward compatible. It 
     68accepts 
     69messages of either tracebuf or tracebuf2 as configured using the 
     70PlayMsgType 
    3371parameter. 
    34 </P> 
    35  
     72</p> 
    3673<hr> 
    37 <p> 
    38 Tankplayer Tools: 
    39 <p> 
    40 Separate from tankplayer are tools to help create tankfiles from sac format 
    41 files.  One can also 
     74<p><span style="font-weight: bold;"><a name="tankplayer_tools"></a>Tankplayer 
     75Tools:</span> 
     76</p> 
     77<p>Separate from tankplayer are tools to help create tankfiles from sac 
     78format 
     79files. One can also 
    4280archive tank files using <a href="waveman2disk_ovr.html">waveman2disk</a> 
    43 and configuring appropriate output format.  The two tools are <i>sac2tb</i> 
    44 and <i>remux_tbuf</i>.  The notes from Pete Lombard about these tools: 
    45 <p> 
    46 <blockquote> 
    47 This is sac2tb, a utility for turning SAC data files into tracebuf files. 
    48 Usage: sac2tb [-n samples] sacfile > tbuf-file 
    49  
    50 <p> 
    51 Without the -n option, sac2tb defaults to 100 samples per packet. 
    52  
    53 <p> 
    54 The intended use is that you run sac2tb on a bunch of SAC files for a given 
    55 event or time period, "cat" all the files together, and then run remux_tbuf 
    56 to make a tankplayer file. For example, in a directory of SAC files: 
    57  
    58 <p> 
    59 <pre> 
    60   foreach m (*) 
    61   sac2tb $m >> tbuf 
    62   end 
    63  
    64   remux_tbuf tbuf test.tnk 
    65 </pre> 
    66 <p> 
    67 SAC doesn't have a provision for byte-swapping, so to my knowledge, SAC files 
    68 are only in SPARC byte-order. At least that's the assumption here. If sac2tb 
    69 is run on an intel machine, the SAC file will be swapped into intel byte-order 
    70 and the resulting tracebuf messages will be marked accordingly. 
    71  
    72 <p> 
    73 Pete Lombard, 19 May 2001 
     81and configuring appropriate output format. The two tools are <i>sac2tb</i> 
     82and <i>remux_tbuf</i>. The notes from Pete Lombard about these tools: 
     83</p> 
     84<blockquote>This is sac2tb, a utility for turning SAC data files into 
     85tracebuf files. 
     86Usage: sac2tb [-n samples] sacfile &gt; tbuf-file 
     87  <p>Without the -n option, sac2tb defaults to 100 samples per packet. </p> 
     88  <p>The intended use is that you run sac2tb on a bunch of SAC files 
     89for a given 
     90event or time period, "cat" all the files together, and then run 
     91remux_tbuf 
     92to make a tankplayer file. For example, in a directory of SAC files: </p> 
     93  <pre>  foreach m (*)<br>  sac2tb $m &gt;&gt; tbuf<br>  end<br><br>  remux_tbuf tbuf test.tnk<br></pre> 
     94  <p>SAC doesn't have a provision for byte-swapping, so to my 
     95knowledge, SAC 
     96files 
     97are only in SPARC byte-order. At least that's the assumption here. If 
     98sac2tb 
     99is run on an intel machine, the SAC file will be swapped into intel 
     100byte-order 
     101and the resulting tracebuf messages will be marked accordingly. </p> 
     102  <p>Pete Lombard, 19 May 2001</p> 
    74103</blockquote> 
     104<p>Five New Tankplayer tools for EW v7.2:</p> 
     105<ul> 
     106  <li>ms2tank - convert miniseed files into a tank player buffer. This 
     107version uses Chad Trabant's libmseed which is now a part of the stock 
     108earthworm distribution. The previous version, ms2tb, used the UCB qlib2 
     109and was restricted to Solaris and Linux. This version works on Solaris, 
     110Windows, Linux, and Mac OS X.<br> 
     111  </li> 
     112  <li>tanksniff - this module outputs a sniffwave like output when you 
     113pass it a tank. It allows you to look at the contents of your tanks 
     114without having to play them back in tankplayer. It takes one argument, 
     115a tank.<br> 
     116  </li> 
     117  <li>tankcut - this module will extract out a specified time slice 
     118from a tank. It requires a starting time and duration for extraction. 
     119If you run the module without any arguments, it spits back the version 
     120number and the argument options/args:</li> 
     121</ul> 
     122<div style="margin-left: 80px;"> 
     123<pre>$ tankcut</pre> 
     124<pre>Error, an input and output tank name must be provided<br>tankcut version v0.0.1 2007-08-27<br>usage: tankcut -s StartTime [-e EndTime|-d Duration] intank outtank<br>              all times for -s and -e options must be in YYYYMMDDHHMMSS format</pre> 
     125<pre>        -s StartTime - when to start including tracebufs from intank<br>   -e EndTime - when to end including tracebufs from intank<br>        -d Duration - Duration in seconds from start time when to end including tracebufs from intank<br>           Default Duration is 600 seconds from start time</pre> 
     126</div> 
     127<pre><br></pre> 
     128<ul> 
     129  <li>ring2tank - have you ever wanted to suck the data out of your 
     130ring and play it back to simulate a few hours of running of your 
     131system....well now you can. This module does just what it says, it 
     132takes 2 arguments, the name of a RING to read from, and the name of a 
     133tankfile to write to. Be warned that this module has no real smarts and 
     134will just keep on filling a file till it grows infinitely. You must 
     135CAREFULLY run this module from the command line and kill it when you 
     136are done with your data gathering...or it may kill your system when the 
     137disk fills. On SOLARIS systems the disk size limit for a file is 2 
     138gigabytes unless you compile the program with the LARGEFILE flag 
     139options. See tankcut above when you want to trim the tank generated 
     140from this module.<br> 
     141  </li> 
     142  <li>dc2tank - Data Center to tank. This is a complex module that 
     143allows a user to gather some data from the IRIS DMC using the 
     144DHI2mseed.jar java program. It extracts the desired stations and builds 
     145a tank based on an event start time and duration. There is a <a 
     146 href="README.dc2tank">README.dc2tank</a> provided with the code. This 
     147module requires that you have java installed on your system and in your 
     148path.<br> 
     149  </li> 
     150</ul> 
     151<p>Paul Friberg - December 27, 2007<br> 
    75152</p> 
    76  
    77153<hr> 
    78  
    79  
    80 <CENTER>  
    81 <A HREF="../modules.html">Module Index</A> |  
    82 <A HREF="../cmd/tankplayer_cmd.html">Tankplayer Commands</A> 
    83 </CENTER> 
    84  
    85 <HR> 
    86 <ADDRESS> 
    87 Contact: <B><address> Questions? Issues? <a href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" target="_blank">Subscribe to the Earthworm List (earthw). </a></address></B><BR> 
    88 </ADDRESS> 
    89 </BODY> 
    90 </HTML> 
    91  
     154<center> <a href="../modules.html">Module Index</a> | <a 
     155 href="../cmd/tankplayer_cmd.html">Tankplayer Commands</a> 
     156</center> 
     157<hr> 
     158<address>Contact: <b> 
     159<address> Questions? Issues? <a 
     160 href="http://lyris.nmt.edu/read/all_forums/subscribe?name=earthw" 
     161 target="_blank">Subscribe to the Earthworm List (earthw). </a></address> 
     162</b><br> 
     163</address> 
     164</body> 
     165</html> 
Note: See TracChangeset for help on using the changeset viewer.