524 lines
37 KiB
HTML
524 lines
37 KiB
HTML
<!doctype html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Auxiliary Scripts — scanloc: Phase Associator documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||
<script type="text/javascript" src="../_static/gempa.js"></script>
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
|
||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Dense Travel-Time Tables" href="locsat-tables.html" />
|
||
<link rel="prev" title="Change Log" href="changelog.html" />
|
||
</head>
|
||
<body>
|
||
<div class="header">
|
||
<div class="container">
|
||
<img class="background" src="../_static/icon.png"/>
|
||
<div class="content">
|
||
<span class="title">scanloc: Phase Associator </span>
|
||
<span class="version">2025.281#4efc2c878</span></h1>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="nav">
|
||
<div class="container">
|
||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<ul>
|
||
<li class="right">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">
|
||
index
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="locsat-tables.html" title="Dense Travel-Time Tables"
|
||
accesskey="N">
|
||
next
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="changelog.html" title="Change Log"
|
||
accesskey="P">
|
||
previous
|
||
</a>
|
||
</li>
|
||
<li class="nav-item nav-item-0">
|
||
<a href="../index.html">Home</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="container">
|
||
<div class="fitted content" id="anchors-container">
|
||
<div class="body" role="main">
|
||
|
||
<section id="auxiliary-scripts">
|
||
<span id="sec-scanloc-aux-tools"></span><h1>Auxiliary Scripts<a class="headerlink" href="#auxiliary-scripts" title="Permalink to this heading">¶</a></h1>
|
||
<p>The scanloc package also ships with auxiliary scripts for real-time or non-real-time
|
||
playbacks and tuning. For these tools, the usual options (<a class="reference internal" href="../apps/global.html#cmdoption-h"><code class="xref std std-option docutils literal notranslate"><span class="pre">-h</span></code></a>,
|
||
<a class="reference internal" href="../apps/global.html#cmdoption-debug"><code class="xref std std-option docutils literal notranslate"><span class="pre">--debug</span></code></a>, etc.) apply. Read the <a class="reference internal" href="../apps/scanloc.html#scanloc-example"><span class="std std-ref">Real-Time Applications</span></a> section for
|
||
example applications.</p>
|
||
<section id="dump-picks">
|
||
<span id="sec-scanloc-dump-picks"></span><h2>dump_picks<a class="headerlink" href="#dump-picks" title="Permalink to this heading">¶</a></h2>
|
||
<p><strong class="program">dump_picks</strong> reads picks and amplitudes from a database and writes them
|
||
to file or the command line in the given format, by default XML (<a class="reference internal" href="glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a>).
|
||
Control the database request to filter by</p>
|
||
<ul class="simple">
|
||
<li><p>Author (<a class="reference internal" href="#cmdoption-author"><code class="xref std std-option docutils literal notranslate"><span class="pre">--author</span></code></a>) contributing the object,</p></li>
|
||
<li><p>Comparison with inventory (<a class="reference internal" href="#cmdoption-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--check-inventory</span></code></a>),</p></li>
|
||
<li><p>Object evaluation mode (<a class="reference internal" href="#cmdoption-m"><code class="xref std std-option docutils literal notranslate"><span class="pre">--manual</span></code></a>, <a class="reference internal" href="#cmdoption-a"><code class="xref std std-option docutils literal notranslate"><span class="pre">--automatic</span></code></a>),</p></li>
|
||
<li><p>Region of contributing station (<a class="reference internal" href="#cmdoption-r"><code class="xref std std-option docutils literal notranslate"><span class="pre">--region</span></code></a>),</p></li>
|
||
<li><p>Time (<a class="reference internal" href="#cmdoption-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--time-window</span></code></a>, <a class="reference internal" href="#cmdoption-hours"><code class="xref std std-option docutils literal notranslate"><span class="pre">--hours</span></code></a>, <a class="reference internal" href="#cmdoption-start"><code class="xref std std-option docutils literal notranslate"><span class="pre">--start</span></code></a>).</p></li>
|
||
</ul>
|
||
<section id="applications">
|
||
<h3>Applications<a class="headerlink" href="#applications" title="Permalink to this heading">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>Dump picks and amplitudes in XML for further analysis or feeding into another
|
||
module such as <a class="reference internal" href="../apps/scanloc.html#scanloc"><span class="std std-ref">scanloc</span></a>.</p></li>
|
||
<li><p>Printing statistics and useful information of the retrieved pick and amplitude
|
||
set with <a class="reference internal" href="#cmdoption-print"><code class="xref std std-option docutils literal notranslate"><span class="pre">--print</span></code></a>.</p></li>
|
||
<li><p>Fetch waveforms for picks from SDS archive, a CAPS or FDSN server by
|
||
generating stream lists from picks with time windows like with
|
||
<span id="id1"><em>scevtstreams</em> [<a class="reference internal" href="references.html#id256" title="scevtstreams. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scevtstreams.html.">20</a>]</span> but for picks independent of events and origins.
|
||
Consider the option <a class="reference internal" href="#cmdoption-type"><code class="xref std std-option docutils literal notranslate"><span class="pre">--type</span></code></a> for choosing the type and
|
||
<a class="reference internal" href="#cmdoption-margin"><code class="xref std std-option docutils literal notranslate"><span class="pre">--margin</span></code></a> for the time margin.</p></li>
|
||
</ul>
|
||
<div class="admonition hint">
|
||
<p class="admonition-title">Hint</p>
|
||
<ul class="simple">
|
||
<li><p>For retrieving events or origins with picks, amplitudes, etc. from a
|
||
database use <span id="id2"><em>scxmldump</em> [<a class="reference internal" href="references.html#id284" title="scxmldump. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scxmldump.html.">26</a>]</span>.</p></li>
|
||
<li><p>Multiple <a class="reference internal" href="glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> files can be merged into one using
|
||
<span id="id3"><em>scxmlmerge</em> [<a class="reference internal" href="references.html#id285" title="scxmlmerge. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scxmlmerge.html.">27</a>]</span>.</p></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="examples">
|
||
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h3>
|
||
<ul>
|
||
<li><p>Print command-line help:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dump_picks<span class="w"> </span>-h
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Extract all picks and amplitudes for the given time span made by author
|
||
‘l1autopick’:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dump_picks<span class="w"> </span>-t<span class="w"> </span><span class="m">2022</span>-01-20T13:52:00~2022-01-20T13:57:00<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--author<span class="w"> </span>l1autopick
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Dump the streams of picks with time windows fetching the corresponding data
|
||
from a local CAPS server <span id="id4">[<a class="reference internal" href="references.html#id116" title="CAPS. gempa module. URL: https://docs.gempa.de/caps/current/index.html.">1</a>]</span>.</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dump_picks<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--type<span class="w"> </span><span class="m">2</span><span class="w"> </span>--margin<span class="w"> </span><span class="m">60</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>capstool<span class="w"> </span>-H<span class="w"> </span>localhost<span class="w"> </span>-o<span class="w"> </span>data.mseed
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Dump the streams of picks with time windows fetching the corresponding data
|
||
from a local SDS archive</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dump_picks<span class="w"> </span>-d<span class="w"> </span>localhost<span class="w"> </span>--type<span class="w"> </span><span class="m">1</span><span class="w"> </span>--margin<span class="w"> </span><span class="m">60</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>scart<span class="w"> </span>-dsE<span class="w"> </span>-l<span class="w"> </span>-<span class="w"> </span>/archive<span class="w"> </span>-o<span class="w"> </span>data.mseed
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section id="command-line-options">
|
||
<h3>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h3>
|
||
<p><strong class="program">dump_picks [options]</strong></p>
|
||
<section id="dump">
|
||
<h4>Dump<a class="headerlink" href="#dump" title="Permalink to this heading">¶</a></h4>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-hours">
|
||
<span class="sig-name descname"><span class="pre">--hours</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-hours" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>double</em></p>
|
||
<p>Start search hours before now considering object time, not creation time.
|
||
If set, <a class="reference internal" href="#cmdoption-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--time-window</span></code></a>, <a class="reference internal" href="#cmdoption-start"><code class="xref std std-option docutils literal notranslate"><span class="pre">--start</span></code></a>, <a class="reference internal" href="#cmdoption-end"><code class="xref std std-option docutils literal notranslate"><span class="pre">--end</span></code></a> are ignored.
|
||
The hours are added to the minutes if set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-minutes">
|
||
<span class="sig-name descname"><span class="pre">--minutes</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-minutes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>double</em></p>
|
||
<p>Start search minutes before now considering object time, not creation time.
|
||
The minutes are added to the hours if set.
|
||
If set, <a class="reference internal" href="#cmdoption-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--time-window</span></code></a>, <a class="reference internal" href="#cmdoption-start"><code class="xref std std-option docutils literal notranslate"><span class="pre">--start</span></code></a>, <a class="reference internal" href="#cmdoption-end"><code class="xref std std-option docutils literal notranslate"><span class="pre">--end</span></code></a> are ignored.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-start">
|
||
<span class="sig-name descname"><span class="pre">--start</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">1970-01-01</span> <span class="pre">00:00:00.000</span></code></p>
|
||
<p>Start time of search until now considering object time, not creation time.
|
||
If set, <a class="reference internal" href="#cmdoption-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--time-window</span></code></a> is ignored.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-end">
|
||
<span class="sig-name descname"><span class="pre">--end</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-end" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">now</span></code></p>
|
||
<p>End time of search considering object time, not creation time. If set,
|
||
<a class="reference internal" href="#cmdoption-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--time-window</span></code></a> is ignored.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-t">
|
||
<span id="cmdoption-time-window"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--time-window</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-t" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">1970-01-01T00:00:00~now</span></code></p>
|
||
<p>Specify time window to search picks and amplitudes by their time. Use one
|
||
single string which must be enclosed by quotes in case of spaces in the time
|
||
string. Times are of course in UTC and separated by a tilde ‘~’.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-maximum-delay">
|
||
<span class="sig-name descname"><span class="pre">--maximum-delay</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-maximum-delay" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>double</em></p>
|
||
<p>Unit: <code class="docutils literal notranslate"><span class="pre">s</span></code></p>
|
||
<p>Maximum allowed delay of picks or amplitudes, hence the difference between
|
||
creation time and actual time value. Allows identification of picks found in
|
||
real time.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-r">
|
||
<span id="cmdoption-region"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-r" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Unit: <code class="docutils literal notranslate"><span class="pre">deg</span></code></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">-90,-180,90,180</span></code></p>
|
||
<p>Dump picks only from sensors in given region. Implies loading an inventory.</p>
|
||
<p>Format: minLat,minLon,maxLat,maxLon</p>
|
||
<p>Default: -90,-180,90,180 if not set.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-c">
|
||
<span id="cmdoption-check-inventory"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--check-inventory</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dump picks only when corresponding streams are found in inventory.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-O">
|
||
<span id="cmdoption-origin"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-O" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Origin ID. Dump all picks associated with the origin that has the given
|
||
origin ID.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-m">
|
||
<span id="cmdoption-manual"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--manual</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-m" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>boolean</em></p>
|
||
<p>Dump only manual picks.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-a">
|
||
<span id="cmdoption-automatic"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--automatic</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-a" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>boolean</em></p>
|
||
<p>Dump only automatic picks.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-n">
|
||
<span id="cmdoption-no-amp"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-amp</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-n" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>boolean</em></p>
|
||
<p>Do not dump amplitudes from picks. Amplitudes are not required by scanloc.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-author">
|
||
<span class="sig-name descname"><span class="pre">--author</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-author" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Filter picks by author. Author information can be extracted from
|
||
XML files using the <strong class="program">playback_picks</strong> option <a class="reference internal" href="#cmdoption-print"><code class="xref std std-option docutils literal notranslate"><span class="pre">--print</span></code></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-net-sta">
|
||
<span class="sig-name descname"><span class="pre">--net-sta</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-net-sta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Filter picks and amplitudes by network code or network and station code.
|
||
Format: NET or NET.STA. Network and station information can be extracted from
|
||
XML files using the <strong class="program">playback_picks</strong> along with <a class="reference internal" href="#cmdoption-print"><code class="xref std std-option docutils literal notranslate"><span class="pre">--print</span></code></a>,
|
||
or inventory (<span id="id5"><em>scinv</em> [<a class="reference internal" href="references.html#id260" title="scinv. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scinv.html.">21</a>]</span>), waveforms (<span id="id6"><em>scart</em> [<a class="reference internal" href="references.html#id241" title="scart. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scart.html.">13</a>]</span>) or
|
||
bindings configuration (<span id="id7"><em>scdumpcfg</em> [<a class="reference internal" href="references.html#id249" title="scdumpcfg. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scdumpcfg.html.">18</a>]</span>).</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="output">
|
||
<h4>Output<a class="headerlink" href="#output" title="Permalink to this heading">¶</a></h4>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-o">
|
||
<span id="cmdoption-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-o" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Name of output file. If not given, all data is written to stdout.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-type">
|
||
<span class="sig-name descname"><span class="pre">--type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||
<p>Type of output format.
|
||
0 / scml: SCML containing all objects (default if option is not used)</p>
|
||
<p>1 / streams: Time windows and streams for all picks like in scevtstreams</p>
|
||
<p>2 / caps: Time windows and streams in capstool format</p>
|
||
<p>3 / fdsnws: Time windows and streams in FDSN dataselect webservice POST format</p>
|
||
<p>Except for type 0, only picks are considered ignoring all other objects.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-f">
|
||
<span id="cmdoption-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>boolean</em></p>
|
||
<p>Output formatted XML. Default is unformatted. Applies only for type 0.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-margin">
|
||
<span class="sig-name descname"><span class="pre">--margin</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-margin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>string</em></p>
|
||
<p>Unit: <code class="docutils literal notranslate"><span class="pre">s</span></code></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
|
||
<p>Time margin applied around pick times along with –type = [1:]. Use 2
|
||
comma-separted values (before,after) for asymmetric margins, e.g.
|
||
–margin 120,300.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
</section>
|
||
<section id="playback-picks">
|
||
<span id="sec-scanloc-playback-picks"></span><h2>playback_picks<a class="headerlink" href="#playback-picks" title="Permalink to this heading">¶</a></h2>
|
||
<p><strong class="program">playback_picks</strong> plays back picks, amplitudes and origins from XML files
|
||
at normal or different speed and sends them to the messaging system. It can also
|
||
be used to print statistics and information extracted from the read XML file.
|
||
<strong class="program">playback_picks</strong> supports multiple pipelines by defining the message
|
||
groups into which objects are injected. The script allows controlling:</p>
|
||
<ul class="simple">
|
||
<li><p>Message groups: Append the message groups for sending picks and amplitudes.</p></li>
|
||
<li><p>Mode (<a class="reference internal" href="#cmdoption-mode"><code class="xref std std-option docutils literal notranslate"><span class="pre">--mode</span></code></a>): In real-time mode a constant number of seconds is added
|
||
to the creation and reference times before sending an object to the messaging
|
||
for mimicking real-time situations at current time. The seconds to add is
|
||
derived from the time of the first object. Default mode is <em>historic</em>.</p></li>
|
||
<li><p>Speed (<a class="reference internal" href="#cmdoption-speed"><code class="xref std std-option docutils literal notranslate"><span class="pre">--speed</span></code></a>): The speed factor to use.</p></li>
|
||
<li><p>Start (<a class="reference internal" href="#cmdoption-j"><code class="xref std std-option docutils literal notranslate"><span class="pre">--jump</span></code></a>): Ignore the first objects within the given number of
|
||
seconds.</p></li>
|
||
<li><p>Timing (<a class="reference internal" href="../apps/scanloc.html#cmdoption-timing"><code class="xref std std-option docutils literal notranslate"><span class="pre">--timing</span></code></a>): Define the sorting of the objects. Default is
|
||
<em>creationTime</em>. Consider the comments on timing in section
|
||
<a class="reference internal" href="../apps/scanloc.html#scanloc-example"><span class="std std-ref">Real-Time Applications</span></a>.</p></li>
|
||
</ul>
|
||
<div class="admonition important">
|
||
<p class="admonition-title">Important</p>
|
||
<p>‘creationTime’ should be considered for playing back origins since their
|
||
actual origin time values are always before picks and amplitudes.</p>
|
||
</div>
|
||
<section id="id8">
|
||
<h3>Examples<a class="headerlink" href="#id8" title="Permalink to this heading">¶</a></h3>
|
||
<ul>
|
||
<li><p>Print the command-line help:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>playback_picks<span class="w"> </span>-h
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Just print statistics of the read XML including author information and stream
|
||
codes on which picks and amplitudes were measured. The NSLC information can be
|
||
used to extract waveforms or to set up corresponding bindings:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>playback_picks<span class="w"> </span>--print<span class="w"> </span>picks.xml
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Make a playback injecting picks and origins into different message groups but
|
||
amplitudes into the same default group, e.g., of different pipelines.
|
||
‘creationTime’ is used as a time reference since origin times are before times
|
||
of picks and amplitudes and considering ‘pickTime’ would distort the order of
|
||
the objects unrealistically:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>playback_picks<span class="w"> </span>origins.xml<span class="w"> </span>l1picks.xml:L1PICK:AMPLITUDE:L1LOCATION<span class="w"> </span>--timing<span class="w"> </span>creationTime
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section id="id9">
|
||
<h3>Command-Line Options<a class="headerlink" href="#id9" title="Permalink to this heading">¶</a></h3>
|
||
<p><strong class="program">playback_picks [options]</strong></p>
|
||
<section id="playback">
|
||
<h4>Playback<a class="headerlink" href="#playback" title="Permalink to this heading">¶</a></h4>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-authors">
|
||
<span class="sig-name descname"><span class="pre">--authors</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-authors" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||
<p>Author of objects to filter before playing back. Objects from all other
|
||
authors are ignored. Separate multiple authors by comma.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-j">
|
||
<span id="cmdoption-jump"></span><span class="sig-name descname"><span class="pre">-j</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--jump</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-j" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>double</em></p>
|
||
<p>Unit: <code class="docutils literal notranslate"><span class="pre">minute</span></code></p>
|
||
<p>Jump in time by given value ignoring the corresponding objects.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-list">
|
||
<span class="sig-name descname"><span class="pre">--list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Just list important pick information from the read XML file and then exit
|
||
without playing back. The sorting of the list depends on ‘–timing’.
|
||
Information include: phase hint, pick time, stream ID, author, time to
|
||
previous pick, delay.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-mode">
|
||
<span class="sig-name descname"><span class="pre">--mode</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-mode" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">historic</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Values: <code class="docutils literal notranslate"><span class="pre">historic,</span> <span class="pre">realTime</span></code></p>
|
||
<p>Playback mode. ‘realTime’ mimics current situation, ‘historic’ preserves all
|
||
times.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-0">
|
||
<span id="cmdoption-object"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--object</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-0" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>Default: <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
|
||
<p>Values: <code class="docutils literal notranslate"><span class="pre">pick,amplitude,origin</span></code></p>
|
||
<p>Limit the playback to the given list of objects.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-print">
|
||
<span class="sig-name descname"><span class="pre">--print</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-print" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Just print some statistics of the read XML file and then exit without playing
|
||
back. The list of stream codes (NSLC) is printed to stdout. All other
|
||
information is printed to stderr. The NSLC information can be used, e.g., for
|
||
filtering waveforms (<span id="id10"><em>scart</em> [<a class="reference internal" href="references.html#id241" title="scart. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/scart.html.">13</a>]</span>) or inventory (<span id="id11"><em>invextr</em> [<a class="reference internal" href="references.html#id166" title="invextr. SeisComP module. URL: https://docs.gempa.de/seiscomp/current/apps/invextr.html.">9</a>]</span>), for
|
||
creating global bindings or applying author filtering, e.g., in
|
||
<a class="reference internal" href="#sec-scanloc-dump-picks"><span class="std std-ref">dump_picks</span></a>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-speed">
|
||
<span class="sig-name descname"><span class="pre">--speed</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-speed" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||
<p>Type: <em>double</em></p>
|
||
<p>Speed of playback.</p>
|
||
<p>1: true speed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-timing">
|
||
<span class="sig-name descname"><span class="pre">--timing</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-timing" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">creationTime</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Values: <code class="docutils literal notranslate"><span class="pre">pickTime,creationTime</span></code></p>
|
||
<p>Timing reference: ‘pickTime’ plays back in order of actual times of picks,
|
||
amplitudes and origins, ‘creationTime’ considers their creation times instead.
|
||
Use ‘pickTime’ if creation times are not representative of the order of
|
||
objects, e.g., when created in playbacks. ‘creationTime’ should be considered
|
||
for playing back origins since their actual origin time values are always
|
||
before picks and amplitudes.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div id="anchors-bottom"></div>
|
||
</div>
|
||
|
||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||
<div id="anchors-top"></div>
|
||
<div id="anchors" class="content">
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<div>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Auxiliary Scripts</a><ul>
|
||
<li><a class="reference internal" href="#dump-picks">dump_picks</a><ul>
|
||
<li><a class="reference internal" href="#applications">Applications</a></li>
|
||
<li><a class="reference internal" href="#examples">Examples</a></li>
|
||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
||
<li><a class="reference internal" href="#dump">Dump</a></li>
|
||
<li><a class="reference internal" href="#output">Output</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#playback-picks">playback_picks</a><ul>
|
||
<li><a class="reference internal" href="#id8">Examples</a></li>
|
||
<li><a class="reference internal" href="#id9">Command-Line Options</a><ul>
|
||
<li><a class="reference internal" href="#playback">Playback</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="changelog.html"
|
||
title="previous chapter">Change Log</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="locsat-tables.html"
|
||
title="next chapter">Dense Travel-Time Tables</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/base/auxiliary.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<div class="container">
|
||
<div class="content">
|
||
Release <b></b> version <b>2025.281#4efc2c878</b>
|
||
<div class="copyright">
|
||
© Copyright <a href="https://www.gempa.de">2014, gempa GmbH.</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |