Files
2025/share/doc/seiscomp/html/apps/scautoloc.html

1392 lines
101 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>scautoloc &#8212; SeisComP Release documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/seiscomp.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=823bb831"></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="scautopick" href="scautopick.html" />
<link rel="prev" title="scamp" href="scamp.html" />
</head>
<body>
<div class="header">
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">6.9.0</span>
</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="scautopick.html" title="scautopick"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scamp.html" title="scamp"
accesskey="P">
previous
</a>
</li>
<li class="nav-item nav-item-0">
<a href="../index.html">Home</a>
</li>
<li class="nav-item nav-item-1">
<a href="../modules.html" >Modules</a>
</li>
<li class="nav-item nav-item-2">
<a href="../toc/processing.html" accesskey="U">Processing</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<section id="scautoloc">
<span id="id1"></span><h1>scautoloc<a class="headerlink" href="#scautoloc" title="Permalink to this heading"></a></h1>
<p><strong>Locates seismic events.</strong></p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>scautoloc is the <cite>SeisComP</cite> program responsible for automatically locating
seismic events in near-real time from <a class="reference internal" href="../base/glossary.html#term-pick"><span class="xref std std-term">phase picks</span></a> considering
<a class="reference internal" href="../base/glossary.html#term-amplitude"><span class="xref std std-term">associated amplitudes</span></a>. It tries to identify combinations of
picks that correspond to a common seismic or non-seismic <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a>. The
picks are sent to <a class="reference internal" href="global_locsat.html#global-locsat"><span class="std std-ref">LOCSAT</span></a> for locating. If the
produced location meets configurable consistency criteria, it is reported as an
<a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a> object , i.e. passed on to other programs that take the origins
as input. Phase picks and amplitudes are usually created by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>
but can also be provided by other means.</p>
<p>scautoloc normally runs as a <a class="reference internal" href="#sec-scautoloc-daemon-mode"><span class="std std-ref">daemon</span></a>
continuously reading picks and amplitudes and processing them in real time. An
<a class="reference internal" href="#sec-scautoloc-offline-mode"><span class="std std-ref">offline mode</span></a> is available as well, e.g., for
playbacks on demand.</p>
</section>
<section id="location-procedure">
<h2>Location procedure<a class="headerlink" href="#location-procedure" title="Permalink to this heading"></a></h2>
<p>The procedure of scautoloc to identify and locate seismic events basically
consists of the following steps:</p>
<section id="pick-filtering">
<span id="sec-scautoloc-pick-filtering"></span><h3>Pick filtering<a class="headerlink" href="#pick-filtering" title="Permalink to this heading"></a></h3>
<p><strong class="program">scautoloc</strong> receives and filters <span class="xref std std-term">phase picks</span> to
generate <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origins</span></a>. These phase picks are used by default if</p>
<ul class="simple">
<li><p>The phase hint is “P”,</p></li>
<li><p><strong>And</strong> the evaluation mode is “automatic”. The use of manual picks is
controlled by <a class="reference internal" href="#confval-autoloc.useManualPicks"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.useManualPicks</span></code></a>.</p></li>
<li><p><strong>And</strong> the evaluation status is not “rejected”, can be overridden by
<code class="xref std std-option docutils literal notranslate"><span class="pre">--allow-rejected-picks</span></code>,</p></li>
<li><p><strong>And</strong> <a class="reference internal" href="#confval-autoloc.authors"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.authors</span></code></a> is empty or the author of the pick is
listed in <a class="reference internal" href="#confval-autoloc.authors"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.authors</span></code></a></p></li>
<li><p><strong>And</strong> the picks are <a class="reference internal" href="#sec-scautoloc-amplitudes"><span class="std std-ref">accompanied by amplitudes</span></a>
configured in <a class="reference internal" href="#confval-autoloc.amplTypeAbs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeAbs</span></code></a>, <a class="reference internal" href="#confval-autoloc.amplTypeSNR"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeSNR</span></code></a>.</p></li>
</ul>
<p>All other picks are ignored.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>The evaluation status of a picks can be set to rejected, e.g., by
<a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> along with the configuration of <a class="reference internal" href="scautopick.html#confval-sendDetections"><code class="xref std std-confval docutils literal notranslate"><span class="pre">sendDetections</span></code></a>,</p></li>
<li><p>The order of the author IDs in <a class="reference internal" href="#confval-autoloc.authors"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.authors</span></code></a> may determine
the pick priority. This feature may be implemented in the future.</p></li>
</ul>
</div>
<p>Each incoming pick is checked if it is outdated and if the complete set of
<a class="reference internal" href="#sec-scautoloc-amplitudes"><span class="std std-ref">associated amplitudes</span></a> is present already. If
a station produces picks extremely often, these are considered to be more
likely glitches resulting in an increased <a class="reference internal" href="../base/glossary.html#term-SNR"><span class="xref std std-term">SNR</span></a> threshold.</p>
<p>The filtered picks are passed on to <a class="reference internal" href="#sec-scautoloc-association"><span class="std std-ref">association</span></a>
and <a class="reference internal" href="#sec-scautoloc-nucleation"><span class="std std-ref">nucleation</span></a>.</p>
</section>
<section id="pick-association">
<span id="sec-scautoloc-association"></span><h3>Pick association<a class="headerlink" href="#pick-association" title="Permalink to this heading"></a></h3>
<p>It is first attempted to associate an incoming pick with a known origin.
The association is limited to epicentral distances given by
<span class="xref std std-ref">autoloc.maxStationDistance</span>.
Especially for large events with stable locations based on many picks already
associated, this is the preferred way to handle the pick. If the association
succeeds, the nucleation process can be bypassed. Under certain circumstances
picks are both associated and fed into the nucleator.</p>
</section>
<section id="origin-nucleation">
<span id="sec-scautoloc-nucleation"></span><h3>Origin nucleation<a class="headerlink" href="#origin-nucleation" title="Permalink to this heading"></a></h3>
<p>If direct association fails, scautoloc tries to make a new origin out of this
and other unassociated, previously received picks. This process is called
“nucleation”. scautoloc performs a grid search over space and time, which is
a rather expensive procedure as it requires lots of resources both in terms
of CPU and RAM. Additional nucleation algorithms may become available in
future. The <a class="reference internal" href="#sec-scautoloc-grid"><span class="std std-ref">spatial grid</span></a> is a discrete set of
generally arbitrary points that sample the area of interest sufficiently densely.
The usability of a pick from a station for a grid point is controlled by the
<a class="reference internal" href="#sec-scautoloc-grid"><span class="std std-ref">grid itself</span></a> and the
<a class="reference internal" href="#sec-scautoloc-stations"><span class="std std-ref">station configuration</span></a>.</p>
<p>In the grid search, each of the grid points is taken as a hypothetical
hypocenter for all incoming
picks. Each incoming pick is back projected in time for each of the grid
points, on the assumption that it is a first-arrival “P” onset. If the pick
indeed corresponds to a “P” arrival of a seismic event, and if this event was
recorded at a sufficient number of stations, the back projected new pick will
cluster with previous picks from the same event. The cluster will be densest
around the origin time at the grid point closest to the hypocenter. In
principle, the grid could be so dense that the location obtained from the
grid search can be used directly. However, as RAM memory as well as CPU speed
is limited, this is not possible. Therefore, if a cluster is identified as a
potential origin, it does not necessarily mean that all contributing picks
actually correspond to “P” arrivals. It may as well be a coincidental match
caused by the coarseness of the grid or possible contamination by picked noise.
Therefore, the location program <a class="reference internal" href="global_locsat.html#global-locsat"><span class="std std-ref">LOCSAT</span></a> is run in order to
try a location and test if the set of picks indeed forms a consistent hypocenter.
If the pick residual <a class="reference internal" href="../base/glossary.html#term-RMS"><span class="xref std std-term">RMS</span></a> is too large, an improvement is attempted by
excluding each of
the contributing picks once to test if a reduction in RMS can be achieved.
If the new origin meets all requirements, it is accepted as new seismic event
location.</p>
<p>The grid points are specified in a text file configured in <a class="reference internal" href="#confval-autoloc.grid"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.grid</span></code></a>.
The default file shipped with scautoloc defines a grid with global evenly
distributed points at the surface, and depth points confined to regions of
known deep seismicity. It may be modified, but should not comprise too many
grid points (&gt;3000, depending on CPU speed and RAM).
<a class="reference internal" href="#sec-scautoloc-grid"><span class="std std-ref">See below</span></a> for more details about the grid file.</p>
</section>
<section id="origin-refinement">
<h3>Origin refinement<a class="headerlink" href="#origin-refinement" title="Permalink to this heading"></a></h3>
<p>An origin produced or updated through association and/or nucleation may still
be contaminated by phases wrongly interpreted as “P” arrivals. scautoloc
tries to improve these origins based on e.g. pick SNR and amplitude. In this
processing step, it is also attempted to associate phases which slipped through
during the first association attempt, e.g. because the initial location was
incorrect. If the origin contains a sufficient number of arrivals to assume
a reasonably well location result, scautoloc additionally tries to associate
picks as secondary phases such as <a class="reference internal" href="../base/glossary.html#term-pP-phase"><span class="xref std std-term">pP</span></a>. Such secondary phases
are only “weakly
associated”, i.e. these phases are not used for the location. For the analyst,
however, it is useful to have possible “pP” phases predefined.</p>
</section>
<section id="origin-filtering">
<h3>Origin filtering<a class="headerlink" href="#origin-filtering" title="Permalink to this heading"></a></h3>
<p>This process involves final consistency checks of new/updated origins etc.
During this procedure, the origins are not modified any more.</p>
<p>In the course of nucleation and association, as well as in the origin
refinement and filtering, certain heuristic criteria are applied to compare
the “qualities” of concurring origins. These criteria are combined in an
internal origin score, which is based on properties of the picks themselves
in the context of the respective origin. The configurable criteria which origins
must meet to be reported are:</p>
<ul class="simple">
<li><p>Minimum number of phases per origins: <a class="reference internal" href="#confval-autoloc.minPhaseCount"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.minPhaseCount</span></code></a>,</p></li>
<li><p>Station residual residual: <a class="reference internal" href="#confval-autoloc.maxResidual"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.maxResidual</span></code></a>,</p></li>
<li><p>Origin RMS: <a class="reference internal" href="#confval-autoloc.maxRMS"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.maxRMS</span></code></a>,</p></li>
<li><p>Maximum depth: <a class="reference internal" href="#confval-autoloc.maxDepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.maxDepth</span></code></a>),</p></li>
<li><p>Azimuthal gap: <a class="reference internal" href="#confval-autoloc.maxSGAP"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.maxSGAP</span></code></a>).</p></li>
</ul>
<p>In addition, the amplitudes provide valuable means of comparing origin
qualities. Obviously, a pick with a high <a class="reference internal" href="../base/glossary.html#term-SNR"><span class="xref std std-term">SNR</span></a> will less likely be a transient
burst of noise than a pick merely exceeding the SNR threshold. A high-SNR
pick thus increases the origin score. Similarly, a pick associated to a large
absolute amplitude is more likely to correspond to a real seismic onset,
especially in case of simultaneous, large-amplitude observations at neighboring
stations. A special case arises, when several nearby stations report amplitudes
above a certain “XXL threshold”. For details see the section
<a class="reference internal" href="#sec-scautoloc-prelim-origins"><span class="std std-ref">Preliminary origins</span></a>.
The amplitudes used by scautoloc are of type “snr” and “mb”, corresponding
to the (relative, unit-less) SNR amplitude and the (absolute) “mb” amplitude,
respectively. These two amplitudes are provided by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>.
In case of a setup in which scautopick is replaced by a different automatic
picker, these two amplitudes must nevertheless be provided to scautoloc.
Otherwise, the picks are not used. At the moment this is a strict requirement,
in the future it may be changed.</p>
</section>
</section>
<section id="grid-file">
<span id="sec-scautoloc-grid"></span><h2>Grid file<a class="headerlink" href="#grid-file" title="Permalink to this heading"></a></h2>
<p>The grid configuration file consists of one line per grid point, each grid
point specified by 6 columns:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>-10.00 105.00 20.0 5.0 180.0 8
</pre></div>
</div>
<p>The columns are grid point coordinates (latitude, longitude, depth), radius,
maximum station distance and minimum pick count, respectively. The above line
sets a grid point centered at 10° S / 105° E at the depth of 20 km. It is
sensitive to events within 5° of the center. Stations in a distance of up
to 180° may be used to nucleate an event. At least 8 picks have to contribute
to an origin at this location. The radius should be chosen large enough to
allow grid cells to overlap, but not too large. The size also determines the
time windows for grouping the picks in the grid search. If the time windows
are too long the risk of contamination with wrong picks increases. The maximum
station distance allows to restrict to certain stations for the according grid
points. E.g. stations from Australia are normally not required to create an
event in Europe. If there is doubt, set the value to 180. The minimum pick
count specifies how many picks are required for a given grid point to allow
the creation of a new origin. The default grid file contains a global grid
with even spacing of ~5° with additional points at greater depths where
deep-focus events are known to occur.</p>
</section>
<section id="station-configuration-file">
<span id="sec-scautoloc-stations"></span><h2>Station Configuration File<a class="headerlink" href="#station-configuration-file" title="Permalink to this heading"></a></h2>
<p>The station configuration file contains lines consisting of network code,
station code, usage flag (0 or 1) and maximum nucleation distance. Using a
flag of 1 indicates the station shall be used by scautoloc. If it shall not
be used, 0 must be specified here. The maximum nucleation distance is the
distance (in degrees) from the station up to which this station may contribute
to a new origin. If this distance is 180°, this station may contribute to new
origins world-wide. However, if the distance is only 10°, the range of this
station is limited. This is a helpful setting in case of mediocre stations
in a region where there are numerous good and reliable stations nearby. The
station will then not pose a risk for locations generated outside the maximum
nucleation distance. Network and station code may be wildcards (*) for
convenience</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="m">*</span> * 1 90
GE * 1 180
GE HLG 1 10
TE RGN 0 10
</pre></div>
</div>
<p>The example above means that all stations from all networks by default can
create new events within 90°. The GE stations can create events at any distance,
except for the rather noisy station HLG in the network GE, which is restricted
to 10°. By setting the 3rd column to 0, TE RGN is ignored.</p>
</section>
<section id="preliminary-origins">
<span id="sec-scautoloc-prelim-origins"></span><h2>Preliminary Origins<a class="headerlink" href="#preliminary-origins" title="Permalink to this heading"></a></h2>
<p>Usually, scautoloc will not report origins with less than a certain
number of defining phases (specified by <a class="reference internal" href="#confval-autoloc.minPhaseCount"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.minPhaseCount</span></code></a>),
typically 6-8 phases, with 6 being the absolute minimum. However,
in case of potentially dangerous events, it may be desirable to
receive “heads up” alert prior to reaching the minimum phase count,
especially in a tsunami warning context. If very large amplitudes
are registered at a sufficient number of stations, it is possible to
produce preliminary origins (hereafter called <a class="reference internal" href="../base/glossary.html#term-XXL-event"><span class="xref std std-term">XXL events</span></a>)
based on less than 6 picks.</p>
<p>Prerequisite is that all these picks have extraordinary large amplitudes of type
<a class="reference internal" href="#confval-autoloc.amplTypeAbs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeAbs</span></code></a> and <a class="reference internal" href="../base/glossary.html#term-SNR"><span class="xref std std-term">SNR</span></a> and lie within a
relatively small region. Such picks are hereafter called <a class="reference internal" href="../base/glossary.html#term-XXL-pick"><span class="xref std std-term">XXL picks</span></a>.
A pick is internally tagged as “XXL pick” if its
amplitude exceeds a certain threshold (specified by
<a class="reference internal" href="#confval-autoloc.xxl.minAmplitude"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.xxl.minAmplitude</span></code></a>) and has a SNR &gt; <a class="reference internal" href="#confval-autoloc.xxl.minSNR"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.xxl.minSNR</span></code></a>.
For larger SNR picks with
smaller amplitude can reach the XXL tag, because it is justified to
treat a large-SNR pick as XXL pick even if its amplitude is somewhat
below the XXL amplitude threshold. The XXL criterion should be
judged as workaround to identify picks which justify the nucleation
of preliminary origins.</p>
</section>
<section id="logging">
<h2>Logging<a class="headerlink" href="#logging" title="Permalink to this heading"></a></h2>
<p>scautoloc produces two kinds of log files in <code class="file docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;:</span></code></p>
<ul class="simple">
<li><p>A normal application log file containing the processing and location history.</p></li>
<li><p>An optional pick log.</p></li>
</ul>
<p>The pick log contains all received picks with associated amplitudes in a
simple text file, one entry per line. This pick log should always be active
as it allows pick playback for trouble shooting and optimization of scautoloc.
If something did not work as expected, playing back the pick log will provide
a useful way to find the source of the problem without the need of processing
the raw waveforms again. The application log file contains miscellaneous
information in variable format. The format of the entries may change anytime,
so no downstream application should ever depend on it. There are some special
lines, however. These contain certain keywords that allow convenient filtering
of the most important information using grep. These keywords are NEW, UPD and
OUT, for a new, updated and output origin, respectively. They can be used like:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>grep &#39;\(NEW\---UPD\---OUT\)&#39; ~/.seiscomp/log/scautoloc.log
</pre></div>
</div>
<p>This will extract all lines containing the above keywords, providing a very
simple (and primitive) origin history.</p>
</section>
<section id="publication-interval">
<h2>Publication Interval<a class="headerlink" href="#publication-interval" title="Permalink to this heading"></a></h2>
<p>In principle, scautoloc produces a new solution (origin) after each processed
pick. This is desirable at an early stage of an event, when every additional
information may lead to significant improvements. A consolidated solution,
consisting of many (dozens) of picks, on the other hand may not always benefit
greatly from additional picks that usually originate from large distances.
Updates after each pick are therefore unnecessary. It is possible to control
the time interval between subsequent origins reported by scautoloc. The time
interval is a linear function of the number of picks:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>Δt = aN + b
</pre></div>
</div>
<p>Setting a = b = 0, then Δt is always zero, meaning there is never a delay in
sending new solutions. This is not desirable. Setting a = 0.5, each pick will
increase the time interval until the next solution will be sent by 0.5s. This
means that scautoloc will wait 10 seconds after an origin with 20 picks is sent.
The values for a and b can be configured by <a class="reference internal" href="#confval-autoloc.publicationIntervalTimeSlope"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.publicationIntervalTimeSlope</span></code></a>
and <a class="reference internal" href="#confval-autoloc.publicationIntervalTimeIntercept"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.publicationIntervalTimeIntercept</span></code></a>, respectively.</p>
</section>
<section id="housekeeping">
<h2>Housekeeping<a class="headerlink" href="#housekeeping" title="Permalink to this heading"></a></h2>
<p>scautoloc keeps pick objects in memory only for a certain amount of time. This time
span is with respect to pick time and specified in seconds in <a class="reference internal" href="#confval-buffer.pickKeep"><code class="xref std std-confval docutils literal notranslate"><span class="pre">buffer.pickKeep</span></code></a>.
The default value is 21600
seconds (6 hours). After this time, unassociated picks expire. Newly arriving
picks older than that (e.g. in the case of high data latencies) are ignored.
Origins will live slightly longer, including the picks associated to them. The time
to buffer origins is configured by <a class="reference internal" href="#confval-buffer.originKeep"><code class="xref std std-confval docutils literal notranslate"><span class="pre">buffer.originKeep</span></code></a>.</p>
<p>In a setup where many stations have considerable latencies, e.g. dialup
stations, the expiration times should be chosen long enough to accommodate
late picks. On the other hand, the memory usage for large networks may be a
concern as well. scautoloc periodically cleans up its memory from expired
objects. The time interval between subsequent housekeepings is specified in
<a class="reference internal" href="#confval-buffer.cleanupInterval"><code class="xref std std-confval docutils literal notranslate"><span class="pre">buffer.cleanupInterval</span></code></a> in seconds.</p>
</section>
<section id="test-mode">
<h2>Test Mode<a class="headerlink" href="#test-mode" title="Permalink to this heading"></a></h2>
<p>In the test mode, scautoloc connects to a messaging server as usual and
receives picks and amplitudes from there, but no results are sent back to
the server. Log files are written as usual. This mode can be used to test
new parameter settings before implementation in the real-time system. It also
provides a simple way to log picks from a real-time system to the pick log.</p>
</section>
<section id="daemon-mode">
<span id="sec-scautoloc-daemon-mode"></span><h2>Daemon Mode<a class="headerlink" href="#daemon-mode" title="Permalink to this heading"></a></h2>
<p>For running scautoloc continuously in the background as a daemon it must be
enabled and started:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>scautoloc
seiscomp<span class="w"> </span>start<span class="w"> </span>scautoloc
</pre></div>
</div>
</section>
<section id="offline-mode">
<span id="sec-scautoloc-offline-mode"></span><h2>Offline Mode<a class="headerlink" href="#offline-mode" title="Permalink to this heading"></a></h2>
<p>scautoloc normally runs as a daemon in the background, continuously reading
picks and amplitudes and processing them in real time. However, scautoloc
may also be operated in offline mode. This is useful for debugging. Offline
mode is activated by adding the command-line parameter <code class="xref std std-option docutils literal notranslate"><span class="pre">--ep</span></code> or
<code class="xref std std-option docutils literal notranslate"><span class="pre">--offline</span></code>. When operated in offline mode,
scautoloc will not connect to the messaging. Instead, it reads picks from a
<a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> file provided with <code class="xref std std-option docutils literal notranslate"><span class="pre">--ep</span></code> or from standard input in the pick file
format. The station coordinates are read from the inventory in the database or
from the file either defined in <a class="reference internal" href="#confval-autoloc.stationLocations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.stationLocations</span></code></a> or
-\-station-locations .</p>
<p>Example for entries in a pick file</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:20:16.6<span class="w"> </span>SK<span class="w"> </span>LIKS<span class="w"> </span>EH<span class="w"> </span>__<span class="w"> </span><span class="m">4</span>.6<span class="w"> </span><span class="m">196</span>.953<span class="w"> </span><span class="m">1</span>.1<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:20:33.5<span class="w"> </span>SJ<span class="w"> </span>BEO<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">3</span>.0<span class="w"> </span><span class="m">479</span>.042<span class="w"> </span><span class="m">0</span>.9<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:21:00.1<span class="w"> </span>CX<span class="w"> </span>MNMCX<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">21</span>.0<span class="w"> </span><span class="m">407</span>.358<span class="w"> </span><span class="m">0</span>.7<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:21:02.7<span class="w"> </span>CX<span class="w"> </span>HMBCX<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">14</span>.7<span class="w"> </span><span class="m">495</span>.533<span class="w"> </span><span class="m">0</span>.5<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-24<span class="w"> </span><span class="m">20</span>:53:59.9<span class="w"> </span>IA<span class="w"> </span>KLI<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">3</span>.2<span class="w"> </span><span class="m">143</span>.752<span class="w"> </span><span class="m">0</span>.6<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:21:04.5<span class="w"> </span>CX<span class="w"> </span>PSGCX<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">7</span>.1<span class="w"> </span><span class="m">258</span>.407<span class="w"> </span><span class="m">0</span>.6<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:21:09.5<span class="w"> </span>CX<span class="w"> </span>PB01<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">10</span>.1<span class="w"> </span><span class="m">139</span>.058<span class="w"> </span><span class="m">0</span>.6<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:21:24.0<span class="w"> </span>NU<span class="w"> </span>ACON<span class="w"> </span>SH<span class="w"> </span>__<span class="w"> </span><span class="m">4</span>.9<span class="w"> </span><span class="m">152</span>.910<span class="w"> </span><span class="m">0</span>.6<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:22:09.0<span class="w"> </span>CX<span class="w"> </span>PB04<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">9</span>.0<span class="w"> </span><span class="m">305</span>.960<span class="w"> </span><span class="m">0</span>.6<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:19:13.1<span class="w"> </span>GE<span class="w"> </span>BKNI<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">3</span>.3<span class="w"> </span><span class="m">100</span>.523<span class="w"> </span><span class="m">0</span>.5<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:23:47.6<span class="w"> </span>RO<span class="w"> </span>IAS<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">3</span>.1<span class="w"> </span><span class="m">206</span>.656<span class="w"> </span><span class="m">0</span>.3<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:09:12.8<span class="w"> </span>GE<span class="w"> </span>JAGI<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">31</span>.9<span class="w"> </span><span class="m">1015</span>.304<span class="w"> </span><span class="m">0</span>.8<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
<span class="m">2008</span>-09-25<span class="w"> </span><span class="m">00</span>:25:10.7<span class="w"> </span>SJ<span class="w"> </span>BEO<span class="w"> </span>BH<span class="w"> </span>__<span class="w"> </span><span class="m">3</span>.4<span class="w"> </span><span class="m">546</span>.364<span class="w"> </span><span class="m">1</span>.1<span class="w"> </span>A<span class="w"> </span><span class="o">[</span>id<span class="o">]</span>
</pre></div>
</div>
<p>where [id] is a placeholder for the real pick id which has been omitted in this
example.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In the above example some of the picks are not in right order of
time because of data latencies. In offline mode scautoloc will not connect to
the database, in consequence the station coordinates cannot be read from the
database and thus have to be supplied via a file. The station coordinates file
has a simple format with one line per entry, consisting of 5 columns: network
code, station code, latitude, longitude, elevation (in meters). Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>GE<span class="w"> </span>APE<span class="w"> </span><span class="m">37</span>.0689<span class="w"> </span><span class="m">25</span>.5306<span class="w"> </span><span class="m">620</span>.0
GE<span class="w"> </span>BANI<span class="w"> </span>-4.5330<span class="w"> </span><span class="m">129</span>.9000<span class="w"> </span><span class="m">0</span>.0
GE<span class="w"> </span>BKB<span class="w"> </span>-1.2558<span class="w"> </span><span class="m">116</span>.9155<span class="w"> </span><span class="m">0</span>.0
GE<span class="w"> </span>BKNI<span class="w"> </span><span class="m">0</span>.3500<span class="w"> </span><span class="m">101</span>.0333<span class="w"> </span><span class="m">0</span>.0
GE<span class="w"> </span>BOAB<span class="w"> </span><span class="m">12</span>.4493<span class="w"> </span>-85.6659<span class="w"> </span><span class="m">381</span>.0
GE<span class="w"> </span>CART<span class="w"> </span><span class="m">37</span>.5868<span class="w"> </span>-1.0012<span class="w"> </span><span class="m">65</span>.0
GE<span class="w"> </span>CEU<span class="w"> </span><span class="m">35</span>.8987<span class="w"> </span>-5.3731<span class="w"> </span><span class="m">320</span>.0
GE<span class="w"> </span>CISI<span class="w"> </span>-7.5557<span class="w"> </span><span class="m">107</span>.8153<span class="w"> </span><span class="m">0</span>.0
</pre></div>
</div>
</div>
<p>The location of this file is specified in <a class="reference internal" href="#confval-autoloc.stationLocations"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.stationLocations</span></code></a> or on the
command line using -\-station-locations</p>
</section>
<section id="scautopick-and-scautoloc-interaction">
<h2>scautopick and scautoloc Interaction<a class="headerlink" href="#scautopick-and-scautoloc-interaction" title="Permalink to this heading"></a></h2>
<p>The two main programs in the automatic event detection and location processing
chain, <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> and <strong class="program">scautoloc</strong>, only work together if the
information needed by scautoloc can be supplied by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> and received
by <strong class="program">scautoloc</strong> through the message group defined by
<code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.subscription</span></code> or through <a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> (<code class="xref std std-option docutils literal notranslate"><span class="pre">--ep</span></code>,
<code class="xref std std-option docutils literal notranslate"><span class="pre">-i</span></code>). This document explains current
implicit dependencies between these two utilities and is meant as a guide
especially for those who plan to modify or replace one or both of these
utilities by own developments.</p>
<p>Both scautopick and scautoloc are subject to ongoing developments.
The explanation given below can therefore only be considered a hint, but not
a standard.</p>
<section id="picks">
<h3>Picks<a class="headerlink" href="#picks" title="Permalink to this heading"></a></h3>
<p><strong class="program">scautoloc</strong> works with
<a class="reference internal" href="#sec-scautoloc-pick-filtering"><span class="std std-ref">seismic phase picks</span></a>.
In addition, certain amplitudes are used as a kind of quality criterion for the
pick, allowing picks with a higher absolute amplitude or signal-to-noise ratio
to be given priority in the processing over weak low-quality picks. Due to the
filtering of picks by phaseHint it is highly recommended to always set the
phaseHint attribute with the appropriate phase name in <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>. There
is no restriction regarding the choice of the publicID of the pick.</p>
</section>
<section id="amplitudes">
<span id="sec-scautoloc-amplitudes"></span><h3>Amplitudes<a class="headerlink" href="#amplitudes" title="Permalink to this heading"></a></h3>
<p>By configuration, the performance of <strong class="program">scautoloc</strong> is also controlled by
considering certain amplitudes accompanying the picks. Two kinds of amplitudes
may be used together</p>
<ul class="simple">
<li><p>An absolute amplitude like the one used for calculation of the magnitude “mb”.</p></li>
<li><p>Relative amplitude like the dimension-less signal-to-noise ratio amplitude “snr”.</p></li>
</ul>
<p>Neither amplitude is used for magnitude computation by scautoloc. The default
amplitude types used by scautoloc are of type “mb” and “snr”. These defaults
can be overridden in <code class="file docutils literal notranslate"><span class="pre">scautoloc.cfg</span></code>:</p>
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">autoloc.amplTypeSNR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">snr</span>
<span class="na">autoloc.amplTypeAbs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">mb</span>
</pre></div>
</div>
<p>If for instance an alternate picker implementation doesnt produce “mb”-type
absolute amplitude but e.g. “xy”, then <a class="reference internal" href="#confval-autoloc.amplTypeAbs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeAbs</span></code></a> needs to be set to
“xy” to have them recognized by scautoloc.</p>
<p>Currently there <strong>must</strong> be an absolute and a relative amplitude for every pick
as configured by <a class="reference internal" href="#confval-autoloc.amplTypeAbs"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeAbs</span></code></a> and <a class="reference internal" href="#confval-autoloc.amplTypeSNR"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.amplTypeSNR</span></code></a>.
These amplitudes must be computed by <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a>.
<strong class="program">scautoloc</strong> will always wait until both amplitudes have arrived, which
results in an overall processing delay, corresponding to the usually delayed availability
of amplitudes with respect to the corresponding pick. The default absolute
amplitude “mb”, for instance, takes a hard-coded 30-seconds time interval to
be computed. This length of data thus has to be waited for, plus a little
extra because of the size of the miniSEED records.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Consider <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> with <a class="reference internal" href="scautopick.html#confval-amplitudes.enableUpdate"><code class="xref std std-confval docutils literal notranslate"><span class="pre">amplitudes.enableUpdate</span></code></a> in order
to provide mb amplitudes with shorter delays.</p>
</div>
<p>An alternate picker
implementation could produce a different absolute-amplitude type than “mb”.
That amplitude might be based on a different filter pass band and much shorter
time window than the default “mb” amplitude, thus allowing a significantly
improved processing speed. The choice of amplitude type and time window greatly
depends on the network. For a regional or even global network the 30-seconds
processing delay wont play a role, and we need the mb amplitude anyway. Here
the delay of solutions produced by scautoloc is mostly controlled by the seismic
traveltimes. Not so in case of a local or small-regional network, where the
mb-type amplitude is of limited value and where a meaningful absolute amplitude
might well be produced with just a second of data and at higher frequencies.
Currently this isnt possible with scautopick but this issue will be addressed
in a future version.</p>
</section>
<section id="manual-origins">
<h3>Manual origins<a class="headerlink" href="#manual-origins" title="Permalink to this heading"></a></h3>
<p>Manual origins created, e.g., in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> may be considered for additional
association of picks as controlled by <a class="reference internal" href="#confval-autoloc.useManualOrigins"><code class="xref std std-confval docutils literal notranslate"><span class="pre">autoloc.useManualOrigins</span></code></a>.</p>
</section>
</section>
<section id="module-configuration">
<span id="scautoloc-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scautoloc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scautoloc.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scautoloc.cfg</span></code></div>
</div>
<p>scautoloc inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>locator.*</strong>
<em>Define parameters of the locator. Only LOCSAT is supported.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-locator.profile">
<span class="sig-name descname"><span class="pre">locator.profile</span></span><a class="headerlink" href="#confval-locator.profile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">iasp91</span></code></p>
<p>Type: <em>string</em></p>
<p>The locator profile to use.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-locator.defaultDepth">
<span class="sig-name descname"><span class="pre">locator.defaultDepth</span></span><a class="headerlink" href="#confval-locator.defaultDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>For each location, scautoloc performs checks to test if the
depth estimate is reliable. If the same location quality
(e.g. pick RMS) can be achieved while fixing the depth to
the default depth, the latter is used. This is most often
the case for shallow events with essentially no depth
resolution.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-locator.minimumDepth">
<span class="sig-name descname"><span class="pre">locator.minimumDepth</span></span><a class="headerlink" href="#confval-locator.minimumDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>The locator might converge at a depth of 0 or even negative
depths. This is usually not desired, as 0 km might be
interpreted as indicative of e.g. a quarry blast or another
explosive source. In the case of &quot;too shallow&quot; locations the
minimum depth will be used.</p>
<p>Note that the minimum depth can also be configured in scolv,
possibly to a different value.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>buffer.*</strong>
<em>Control the buffer of objects.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-buffer.pickKeep">
<span class="sig-name descname"><span class="pre">buffer.pickKeep</span></span><a class="headerlink" href="#confval-buffer.pickKeep" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">21600</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Time to keep picks in the buffer with respect to pick time, not creation time.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-buffer.originKeep">
<span class="sig-name descname"><span class="pre">buffer.originKeep</span></span><a class="headerlink" href="#confval-buffer.originKeep" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">86400</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>s</em></p>
<p>Time to keep origins in buffer.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-buffer.cleanupInterval">
<span class="sig-name descname"><span class="pre">buffer.cleanupInterval</span></span><a class="headerlink" href="#confval-buffer.cleanupInterval" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3600</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>s</em></p>
<p>Clean-up interval for removing old/unused objects.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>autoloc.*</strong>
<em>Define parameters for creating and reporting origins.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.maxRMS">
<span class="sig-name descname"><span class="pre">autoloc.maxRMS</span></span><a class="headerlink" href="#confval-autoloc.maxRMS" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3.5</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Maximum travel-time RMS for a location to be reported.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.maxResidual">
<span class="sig-name descname"><span class="pre">autoloc.maxResidual</span></span><a class="headerlink" href="#confval-autoloc.maxResidual" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">7.0</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Maximum travel-time residual (unweighted) for a pick at a station to be used.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.minPhaseCount">
<span class="sig-name descname"><span class="pre">autoloc.minPhaseCount</span></span><a class="headerlink" href="#confval-autoloc.minPhaseCount" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">6</span></code></p>
<p>Type: <em>integer</em></p>
<p>Minimum number of phases for reporting origins.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.maxDepth">
<span class="sig-name descname"><span class="pre">autoloc.maxDepth</span></span><a class="headerlink" href="#confval-autoloc.maxDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>Maximum permissible depth for reporting origins.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.maxSGAP">
<span class="sig-name descname"><span class="pre">autoloc.maxSGAP</span></span><a class="headerlink" href="#confval-autoloc.maxSGAP" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">360</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum secondary azimuthal gap for an origin to be reported by.
The secondary gap is the maximum of the sum of 2 station gaps.</p>
<p>Default: 360 degrees, i.e. no restriction based on this parameter.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.maxStationDistance">
<span class="sig-name descname"><span class="pre">autoloc.maxStationDistance</span></span><a class="headerlink" href="#confval-autoloc.maxStationDistance" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum epicntral distance to stations for accepting picks.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.minStaCountIgnorePKP">
<span class="sig-name descname"><span class="pre">autoloc.minStaCountIgnorePKP</span></span><a class="headerlink" href="#confval-autoloc.minStaCountIgnorePKP" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">15</span></code></p>
<p>Type: <em>integer</em></p>
<p>If the station count for stations at &lt; 105 degrees distance
exceeds this number, no picks at &gt; 105 degrees will be
used in location. They will be loosely associated, though.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.amplTypeAbs">
<span class="sig-name descname"><span class="pre">autoloc.amplTypeAbs</span></span><a class="headerlink" href="#confval-autoloc.amplTypeAbs" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">mb</span></code></p>
<p>Type: <em>string</em></p>
<p>If this string is non-empty, an amplitude obtained from an amplitude
object is used by … . If this string is &quot;mb&quot;, a period
obtained from the amplitude object is also used; if it has some other
value, then 1 [units?] is used. If this string is empty, then the amplitude
is set to 0.5 * thresholdXXL, and 1 [units?] is used for the period.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.amplTypeSNR">
<span class="sig-name descname"><span class="pre">autoloc.amplTypeSNR</span></span><a class="headerlink" href="#confval-autoloc.amplTypeSNR" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">snr</span></code></p>
<p>Type: <em>string</em></p>
<p>If this string is non-empty, it is used to obtain a pick SNR from an
amplitude object. If it is empty, the pick SNR is 10.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.grid">
<span class="sig-name descname"><span class="pre">autoloc.grid</span></span><a class="headerlink" href="#confval-autoloc.grid" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/scautoloc/grid.conf</span></code></p>
<p>Type: <em>path</em></p>
<p>Location of the grid file for nucleating origins.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.stationConfig">
<span class="sig-name descname"><span class="pre">autoloc.stationConfig</span></span><a class="headerlink" href="#confval-autoloc.stationConfig" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;DATADIR&#64;/scautoloc/station.conf</span></code></p>
<p>Type: <em>path</em></p>
<p>Location of the station configuration file for nucleating origins.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.stationLocations">
<span class="sig-name descname"><span class="pre">autoloc.stationLocations</span></span><a class="headerlink" href="#confval-autoloc.stationLocations" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>The station file to be used when in offline mode.
If no file is given the database is used. An example is given
in &quot;&#64;DATADIR&#64;/scautoloc/station-locations.conf&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.useManualPicks">
<span class="sig-name descname"><span class="pre">autoloc.useManualPicks</span></span><a class="headerlink" href="#confval-autoloc.useManualPicks" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Receive and process manual phase picks.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.useManualOrigins">
<span class="sig-name descname"><span class="pre">autoloc.useManualOrigins</span></span><a class="headerlink" href="#confval-autoloc.useManualOrigins" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Receive and process manual origins. Manual picks and arrival
weights will be adopted from the manual origin and the processing continues with these.
Origins produced this way by adding incoming automatic picks are nevertheless marked as
automatic origins. But they may contain manual picks (even pP and S picks).</p>
<p>Add the LOCATION group to connection.subscriptions for receiving manual origins!</p>
<p>This is an experimental feature relevant only for large regional and global networks,
where results by analysts can be expected before the end
of automatic event processing.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.adoptManualDepth">
<span class="sig-name descname"><span class="pre">autoloc.adoptManualDepth</span></span><a class="headerlink" href="#confval-autoloc.adoptManualDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Adopt the depth from manual origins. Otherwise the default depth
in locator.defaultDepth is considered.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.authors">
<span class="sig-name descname"><span class="pre">autoloc.authors</span></span><a class="headerlink" href="#confval-autoloc.authors" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>Restrict pick processing to the given author name(s). Apply
comma separation for a list of names. If any author name is
given, picks from other authors are ignored.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.tryDefaultDepth">
<span class="sig-name descname"><span class="pre">autoloc.tryDefaultDepth</span></span><a class="headerlink" href="#confval-autoloc.tryDefaultDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Compare located origin with the origin at the depth given by
locator.defaultDepth. The origin with lower RMS is reported.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.publicationIntervalTimeSlope">
<span class="sig-name descname"><span class="pre">autoloc.publicationIntervalTimeSlope</span></span><a class="headerlink" href="#confval-autoloc.publicationIntervalTimeSlope" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.5</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s/count</em></p>
<p>Parameter &quot;a&quot; in the equation t = aN + b.
t is the time interval between sending updates of an origin.
N is the arrival count of the origin.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.publicationIntervalTimeIntercept">
<span class="sig-name descname"><span class="pre">autoloc.publicationIntervalTimeIntercept</span></span><a class="headerlink" href="#confval-autoloc.publicationIntervalTimeIntercept" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Parameter &quot;b&quot; in the equation t = aN + b.
t is the time interval between sending updates of an origin.
N is the arrival count of the origin.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.pickLogEnable">
<span class="sig-name descname"><span class="pre">autoloc.pickLogEnable</span></span><a class="headerlink" href="#confval-autoloc.pickLogEnable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Activate for writing pick log files to &quot;pickLog&quot;.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.pickLog">
<span class="sig-name descname"><span class="pre">autoloc.pickLog</span></span><a class="headerlink" href="#confval-autoloc.pickLog" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;LOGDIR&#64;/autoloc-picklog</span></code></p>
<p>Type: <em>string</em></p>
<p>Location of pick log file containing information about received
picks. Activate &quot;pickLogEnable&quot; for writing the files.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>autoloc.xxl.*</strong>
<em>Create origins from XXL picks. These origins will receive the status “preliminary”.</em>
<em>Use with care! Enabling XXL picks may result in frequent fake solutions.</em></p>
</div>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.enable">
<span class="sig-name descname"><span class="pre">autoloc.xxl.enable</span></span><a class="headerlink" href="#confval-autoloc.xxl.enable" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
<p>Type: <em>boolean</em></p>
<p>Picks with exceptionally large amplitudes may be flagged as XXL,
allowing (in future) faster, preliminary &quot;heads-up&quot; alerts.</p>
<p>This option enables the feature.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.minAmplitude">
<span class="sig-name descname"><span class="pre">autoloc.xxl.minAmplitude</span></span><a class="headerlink" href="#confval-autoloc.xxl.minAmplitude" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10000</span></code></p>
<p>Type: <em>double</em></p>
<p>Minimum amplitude for a pick to be flagged as XXL. The
value corresponds to the amplitude type configured in
autoloc.amplTypeAbs. NOTE that
BOTH minAmplitude and minSNR need to be exceeded!</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.minSNR">
<span class="sig-name descname"><span class="pre">autoloc.xxl.minSNR</span></span><a class="headerlink" href="#confval-autoloc.xxl.minSNR" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">8</span></code></p>
<p>Type: <em>double</em></p>
<p>Minimum SNR for a pick to be flagged as XXL. NOTE that
BOTH minAmplitude and minSNR need to be exceeded!</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.minPhaseCount">
<span class="sig-name descname"><span class="pre">autoloc.xxl.minPhaseCount</span></span><a class="headerlink" href="#confval-autoloc.xxl.minPhaseCount" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">4</span></code></p>
<p>Type: <em>integer</em></p>
<p>Minimum number of XXL picks for forming an origin.
Must be &gt;= 4.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.maxStationDistance">
<span class="sig-name descname"><span class="pre">autoloc.xxl.maxStationDistance</span></span><a class="headerlink" href="#confval-autoloc.xxl.maxStationDistance" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">10</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>deg</em></p>
<p>Maximum epicentral distance for accepting XXL picks.</p>
</dd></dl>
<dl class="std confval">
<dt class="sig sig-object std" id="confval-autoloc.xxl.maxDepth">
<span class="sig-name descname"><span class="pre">autoloc.xxl.maxDepth</span></span><a class="headerlink" href="#confval-autoloc.xxl.maxDepth" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>km</em></p>
<p>Maximum depth for creating origins based on XXL arrivals.</p>
</dd></dl>
</section>
<section id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading"></a></h2>
<p><strong class="program">scautoloc [options]</strong></p>
<section id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-h">
<span id="cmdoption-scautoloc-help"></span><span class="sig-name descname"><span class="pre">-h</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">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-V">
<span id="cmdoption-scautoloc-version"></span><span class="sig-name descname"><span class="pre">-V</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">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-V" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-config-file">
<span class="sig-name descname"><span class="pre">--config-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-config-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-D">
<span id="cmdoption-scautoloc-daemon"></span><span class="sig-name descname"><span class="pre">-D</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">--daemon</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-D" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-auto-shutdown">
<span class="sig-name descname"><span class="pre">--auto-shutdown</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-auto-shutdown" title="Permalink to this definition"></a></dt>
<dd><p>Enable/disable self-shutdown because a master module shutdown.
This only works when messaging is enabled and the master
module sends a shutdown message (enabled with --start-stop-msg
for the master module).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-shutdown-master-module">
<span class="sig-name descname"><span class="pre">--shutdown-master-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-shutdown-master-module" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-module used for auto-shutdown.
This is the application name of the module actually
started. If symlinks are used, then it is the name of
the symlinked application.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-shutdown-master-username">
<span class="sig-name descname"><span class="pre">--shutdown-master-username</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-shutdown-master-username" title="Permalink to this definition"></a></dt>
<dd><p>Set the name of the master-username of the messaging
used for auto-shutdown. If &quot;shutdown-master-module&quot; is
given as well, this parameter is ignored.</p>
</dd></dl>
</section>
<section id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-verbosity" title="Permalink to this definition"></a></dt>
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-v">
<span id="cmdoption-scautoloc-v"></span><span class="sig-name descname"><span class="pre">-v</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">--v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-v" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-q">
<span id="cmdoption-scautoloc-quiet"></span><span class="sig-name descname"><span class="pre">-q</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">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-component">
<span class="sig-name descname"><span class="pre">--component</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-component" title="Permalink to this definition"></a></dt>
<dd><p>Limit the logging to a certain component. This option can
be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-s">
<span id="cmdoption-scautoloc-syslog"></span><span class="sig-name descname"><span class="pre">-s</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">--syslog</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-s" title="Permalink to this definition"></a></dt>
<dd><p>Use syslog logging backend. The output usually goes to
/var/lib/messages.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-l">
<span id="cmdoption-scautoloc-lockfile"></span><span class="sig-name descname"><span class="pre">-l</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">--lockfile</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-console">
<span class="sig-name descname"><span class="pre">--console</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-debug">
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-debug" title="Permalink to this definition"></a></dt>
<dd><p>Execute in debug mode.
Equivalent to --verbosity=4 --console=1 .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-log-file">
<span class="sig-name descname"><span class="pre">--log-file</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</section>
<section id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-u">
<span id="cmdoption-scautoloc-user"></span><span class="sig-name descname"><span class="pre">-u</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">--user</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-u" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-H">
<span id="cmdoption-scautoloc-host"></span><span class="sig-name descname"><span class="pre">-H</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">--host</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-H" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-t">
<span id="cmdoption-scautoloc-timeout"></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">--timeout</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-t" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-g">
<span id="cmdoption-scautoloc-primary-group"></span><span class="sig-name descname"><span class="pre">-g</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">--primary-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-g" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-S">
<span id="cmdoption-scautoloc-subscribe-group"></span><span class="sig-name descname"><span class="pre">-S</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">--subscribe-group</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-S" title="Permalink to this definition"></a></dt>
<dd><p>A group to subscribe to.
This option can be given more than once.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-content-type">
<span class="sig-name descname"><span class="pre">--content-type</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-start-stop-msg">
<span class="sig-name descname"><span class="pre">--start-stop-msg</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</section>
<section id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-db-driver-list">
<span class="sig-name descname"><span class="pre">--db-driver-list</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-d">
<span id="cmdoption-scautoloc-database"></span><span class="sig-name descname"><span class="pre">-d</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">--database</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-d" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
&quot;service&quot; is the name of the database driver which
can be queried with &quot;--db-driver-list&quot;.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-config-module">
<span class="sig-name descname"><span class="pre">--config-module</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-inventory-db">
<span class="sig-name descname"><span class="pre">--inventory-db</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-inventory-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the inventory from the given database or file, format:
[<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-db-disable">
<span class="sig-name descname"><span class="pre">--db-disable</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-db-disable" title="Permalink to this definition"></a></dt>
<dd><p>Do not use the database at all</p>
</dd></dl>
</section>
<section id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-test">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-test" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any object.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-offline">
<span class="sig-name descname"><span class="pre">--offline</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-offline" title="Permalink to this definition"></a></dt>
<dd><p>Do not connect to a messaging server. Instead a
station-locations.conf file can be provided. This implies
--test and --playback</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-playback">
<span class="sig-name descname"><span class="pre">--playback</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-playback" title="Permalink to this definition"></a></dt>
<dd><p>Flush origins immediately without delay.</p>
</dd></dl>
</section>
<section id="id2">
<h3>Mode<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-0">
<span class="sig-name descname"><span class="pre">--test</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-0" title="Permalink to this definition"></a></dt>
<dd><p>Do not send any object.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-1">
<span class="sig-name descname"><span class="pre">--offline</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-1" title="Permalink to this definition"></a></dt>
<dd><p>Flush origins immediately without delay.</p>
</dd></dl>
</section>
<section id="input">
<h3>Input<a class="headerlink" href="#input" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-ep">
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"> <span class="pre">file</span></span><a class="headerlink" href="#cmdoption-scautoloc-ep" title="Permalink to this definition"></a></dt>
<dd><p>Name of input XML file (SCML) with all picks and origins for
offline processing. The database connection is not received
from messaging and must be provided. Results are sent in XML
to stdout.</p>
</dd></dl>
</section>
<section id="settings">
<h3>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-allow-rejected-picks">
<span class="sig-name descname"><span class="pre">--allow-rejected-picks</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scautoloc-allow-rejected-picks" title="Permalink to this definition"></a></dt>
<dd><p>Allow picks with evaluation status rejected for nucleation
and association.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-station-locations">
<span class="sig-name descname"><span class="pre">--station-locations</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-station-locations" title="Permalink to this definition"></a></dt>
<dd><p>The station-locations.conf file to use when in
offline mode (started with --offline).
If no file is given the database is used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-station-config">
<span class="sig-name descname"><span class="pre">--station-config</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-station-config" title="Permalink to this definition"></a></dt>
<dd><p>The station configuration file. Examples are in &#64;DATADIR&#64;/scautoloc/</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-grid">
<span class="sig-name descname"><span class="pre">--grid</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-grid" title="Permalink to this definition"></a></dt>
<dd><p>The grid configuration file. Examples are in &#64;DATADIR&#64;/scautoloc/</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-pick-log">
<span class="sig-name descname"><span class="pre">--pick-log</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-pick-log" title="Permalink to this definition"></a></dt>
<dd><p>The pick log file. Providing a file name enables logging picks
even when disabled by configuration.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-default-depth">
<span class="sig-name descname"><span class="pre">--default-depth</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-default-depth" title="Permalink to this definition"></a></dt>
<dd><p>Default depth for comparison with the depth after locating.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-sgap">
<span class="sig-name descname"><span class="pre">--max-sgap</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-sgap" title="Permalink to this definition"></a></dt>
<dd><p>Maximum secondary azimuthal gap for an origin to be reported.
The secondary gap is the maximum of the sum of 2 station gaps.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-rms">
<span class="sig-name descname"><span class="pre">--max-rms</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-rms" title="Permalink to this definition"></a></dt>
<dd><p>Maximum travel-time RMS for a location to be reported.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-residual">
<span class="sig-name descname"><span class="pre">--max-residual</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-residual" title="Permalink to this definition"></a></dt>
<dd><p>Maximum travel-time residual (unweighted) for a pick at a
station to be used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-station-distance">
<span class="sig-name descname"><span class="pre">--max-station-distance</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-station-distance" title="Permalink to this definition"></a></dt>
<dd><p>Maximum distance of stations to be used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-nucleation-distance-default">
<span class="sig-name descname"><span class="pre">--max-nucleation-distance-default</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-nucleation-distance-default" title="Permalink to this definition"></a></dt>
<dd><p>Default maximum distance of stations to be used for nucleating new origins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-pick-affinity">
<span class="sig-name descname"><span class="pre">--min-pick-affinity</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-pick-affinity" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-phase-count">
<span class="sig-name descname"><span class="pre">--min-phase-count</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-phase-count" title="Permalink to this definition"></a></dt>
<dd><p>Minimum number of picks for an origin to be reported.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-score">
<span class="sig-name descname"><span class="pre">--min-score</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-score" title="Permalink to this definition"></a></dt>
<dd><p>Minimum score for an origin to be reported.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-pick-snr">
<span class="sig-name descname"><span class="pre">--min-pick-snr</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-pick-snr" title="Permalink to this definition"></a></dt>
<dd><p>Minimum SNR for a pick to be processed.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-threshold-xxl">
<span class="sig-name descname"><span class="pre">--threshold-xxl</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-threshold-xxl" title="Permalink to this definition"></a></dt>
<dd><p>An amplitude exceeding this threshold will flag the pick as XXL.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-phase-count-xxl">
<span class="sig-name descname"><span class="pre">--min-phase-count-xxl</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-phase-count-xxl" title="Permalink to this definition"></a></dt>
<dd><p>Minimum number of picks for an XXL origin to be reported.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-distance-xxl">
<span class="sig-name descname"><span class="pre">--max-distance-xxl</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-distance-xxl" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-sta-count-ignore-pkp">
<span class="sig-name descname"><span class="pre">--min-sta-count-ignore-pkp</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-sta-count-ignore-pkp" title="Permalink to this definition"></a></dt>
<dd><p>Minimum station count for which we ignore PKP phases.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-min-score-bypass-nucleator">
<span class="sig-name descname"><span class="pre">--min-score-bypass-nucleator</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-min-score-bypass-nucleator" title="Permalink to this definition"></a></dt>
<dd><p>Minimum score at which the nucleator is bypassed.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-keep-events-timespan">
<span class="sig-name descname"><span class="pre">--keep-events-timespan</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-keep-events-timespan" title="Permalink to this definition"></a></dt>
<dd><p>The timespan to keep historical events.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-cleanup-interval">
<span class="sig-name descname"><span class="pre">--cleanup-interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-cleanup-interval" title="Permalink to this definition"></a></dt>
<dd><p>The object cleanup interval in seconds.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-max-age">
<span class="sig-name descname"><span class="pre">--max-age</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-max-age" title="Permalink to this definition"></a></dt>
<dd><p>During cleanup all pick objects older than maxAge (in seconds)
are removed (maxAge == 0 disables cleanup).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-wakeup-interval">
<span class="sig-name descname"><span class="pre">--wakeup-interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-wakeup-interval" title="Permalink to this definition"></a></dt>
<dd><p>The interval in seconds to check pending operations.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-scautoloc-dynamic-pick-threshold-interval">
<span class="sig-name descname"><span class="pre">--dynamic-pick-threshold-interval</span></span><span class="sig-prename descclassname"> <span class="pre">arg</span></span><a class="headerlink" href="#cmdoption-scautoloc-dynamic-pick-threshold-interval" title="Permalink to this definition"></a></dt>
<dd><p>The interval in seconds in which to check for extraordinarily
high pick activity, resulting in a dynamically increased
pick threshold.</p>
</dd></dl>
</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="#">scautoloc</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#location-procedure">Location procedure</a><ul>
<li><a class="reference internal" href="#pick-filtering">Pick filtering</a></li>
<li><a class="reference internal" href="#pick-association">Pick association</a></li>
<li><a class="reference internal" href="#origin-nucleation">Origin nucleation</a></li>
<li><a class="reference internal" href="#origin-refinement">Origin refinement</a></li>
<li><a class="reference internal" href="#origin-filtering">Origin filtering</a></li>
</ul>
</li>
<li><a class="reference internal" href="#grid-file">Grid file</a></li>
<li><a class="reference internal" href="#station-configuration-file">Station Configuration File</a></li>
<li><a class="reference internal" href="#preliminary-origins">Preliminary Origins</a></li>
<li><a class="reference internal" href="#logging">Logging</a></li>
<li><a class="reference internal" href="#publication-interval">Publication Interval</a></li>
<li><a class="reference internal" href="#housekeeping">Housekeeping</a></li>
<li><a class="reference internal" href="#test-mode">Test Mode</a></li>
<li><a class="reference internal" href="#daemon-mode">Daemon Mode</a></li>
<li><a class="reference internal" href="#offline-mode">Offline Mode</a></li>
<li><a class="reference internal" href="#scautopick-and-scautoloc-interaction">scautopick and scautoloc Interaction</a><ul>
<li><a class="reference internal" href="#picks">Picks</a></li>
<li><a class="reference internal" href="#amplitudes">Amplitudes</a></li>
<li><a class="reference internal" href="#manual-origins">Manual origins</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#id2">Mode</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#settings">Settings</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="scamp.html"
title="previous chapter">scamp</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="scautopick.html"
title="next chapter">scautopick</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scautoloc.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="container">
<div class="horizontal layout content">
<a class="fade-in" href="https://www.gempa.de" target="_blank">
<img class="brand" src="../_static/brands/gempa.svg"/>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>6.9.0</b> Release
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.
</div>
</div>
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
<img class="brand" src="../_static/brands/gfz.svg"/>
</a>
</div>
</div>
</div>
</body>
</html>