[seiscomp, scanloc] Install, add .gitignore
This commit is contained in:
799
share/doc/seiscomp/html/apps/scmag.html
Normal file
799
share/doc/seiscomp/html/apps/scmag.html
Normal file
@ -0,0 +1,799 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scmag — 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="scqc" href="scqc.html" />
|
||||
<link rel="prev" title="scevent" href="scevent.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="scqc.html" title="scqc"
|
||||
accesskey="N">
|
||||
next
|
||||
</a>
|
||||
</li>
|
||||
<li class="right">
|
||||
<a href="scevent.html" title="scevent"
|
||||
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="scmag">
|
||||
<span id="id1"></span><h1>scmag<a class="headerlink" href="#scmag" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Calculates magnitudes of different types.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The purpose of scmag is to compute magnitudes from pre-computed amplitudes.
|
||||
Instead it takes amplitudes and origins as input and produces StationMagnitudes
|
||||
and (network) Magnitudes as output. It does not access waveforms.
|
||||
The resulting magnitudes are sent to the “MAGNITUDE” group. scmag doesn’t access
|
||||
any waveforms. It only uses amplitudes previously calculated.</p>
|
||||
<p>The purpose of scmag is the decoupling of magnitude computation from amplitude
|
||||
measurements. This allows several modules to generate amplitudes concurrently,
|
||||
like <a class="reference internal" href="scautopick.html#scautopick"><span class="std std-ref">scautopick</span></a> or <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a>. As soon as an origin comes in, the amplitudes related
|
||||
to the picks are taken either from the memory buffer or the database to compute
|
||||
the magnitudes.</p>
|
||||
<section id="relationship-between-amplitudes-and-origins">
|
||||
<h3>Relationship between amplitudes and origins<a class="headerlink" href="#relationship-between-amplitudes-and-origins" title="Permalink to this heading">¶</a></h3>
|
||||
<p>scmag makes use of the fact that origins sent by <a class="reference internal" href="scautoloc.html#scautoloc"><span class="std std-ref">scautoloc</span></a>, <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>
|
||||
or other modules include
|
||||
the complete set of arrivals, which reference picks used for origin computation.
|
||||
The picks in turn are referenced by a number of amplitudes, some of which are
|
||||
relevant for magnitude computation.</p>
|
||||
<p>Read the <a class="reference internal" href="scamp.html#scamp"><span class="std std-ref">scamp</span></a> documentation for more details on amplitude measurements.</p>
|
||||
</section>
|
||||
<section id="primary-magnitudes">
|
||||
<span id="scmag-primarym"></span><h3>Primary magnitudes<a class="headerlink" href="#primary-magnitudes" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Primary magnitudes are computed from amplitudes and station-event distances.
|
||||
Currently the following primary magnitude types are implemented.</p>
|
||||
</section>
|
||||
<section id="local-distances">
|
||||
<h3>Local distances<a class="headerlink" href="#local-distances" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="simple">
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-duration-Md"><span class="xref std std-term">Md</span></a></dt><dd><p>Duration magnitude as described in HYPOINVERSE (<span id="id2">Klein [<a class="reference internal" href="../base/references.html#id47" title="F.W. Klein. User’s guide to HYPOINVERSE-2000, a Fortran program to solve for earthquake locations and magnitudes. US Geological Survey, 2002-171:, 2002. URL: https://www.usgs.gov/node/279394, doi:10.3133/ofr02171.">50</a>]</span>).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-JMA-M_JMA"><span class="xref std std-term">Mjma</span></a></dt><dd><p>Mjma is computed on displacement data using body waves of period < 30s.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-ML"><span class="xref std std-term">ML</span></a></dt><dd><p>Local (Richter) magnitude calculated on the horizontal components using a
|
||||
correction term to fit with the standard ML (<span id="id3">Richter [<a class="reference internal" href="../base/references.html#id62" title="C.F. Richter. An instrumental earthquake magnitude scale. Bull. Seismol. Soc. Am., 1:1 - 32, 1935. URL: https://resolver.caltech.edu/CaltechAUTHORS:20140804-143558638, doi:10.1785/BSSA0250010001.">57</a>]</span>).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-custom-MLc"><span class="xref std std-term">MLc</span></a></dt><dd><p>Local custom magnitude calculated on the horizontal components according to
|
||||
Hessian Earthquake Service and <span id="id4">Stange [<a class="reference internal" href="../base/references.html#id78" title="S. Stange. ML determination for local and regional events using a sparse network in Southwestern Germany. J. Seismol., 10:247 – 257, 2006. doi:10.1007/s10950-006-9010-6.">62</a>]</span></p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-horizontal-MLh"><span class="xref std std-term">MLh</span></a></dt><dd><p>Local magnitude calculated on the horizontal components according to SED
|
||||
specifications.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-vertical-MLv"><span class="xref std std-term">MLv</span></a></dt><dd><p>Local magnitude calculated on the vertical component using a correction term
|
||||
to fit with the standard ML.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-local-GNS-GEONET-MLr"><span class="xref std std-term">MLr</span></a></dt><dd><p>Local magnitude calculated from MLv amplitudes based on GNS/GEONET specifications
|
||||
for New Zealand (<span id="id5">Ristau <em>et al.</em> [<a class="reference internal" href="../base/references.html#id64" title="J. Ristau, D. Harte, and J. Salichon. A Revised Local Magnitude (ML) Scale for New Zealand Earthquakes. Bull. Seismol. Soc. Am., 106(2):, 2016. doi:10.1785/0120150293.">58</a>]</span>).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-Nuttli-MN"><span class="xref std std-term">MN</span></a></dt><dd><p>Nuttli magnitude for Canada and other Cratonic regions (<span id="id6">Nuttli [<a class="reference internal" href="../base/references.html#id58" title="O.W. Nuttli. Seismic wave attenuation and magnitude relations for eastern north america. J. Geophys. Res., 5:876 - 885, 1973. doi:10.1029/JB078i005p00876.">53</a>]</span>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="teleseismic-distances">
|
||||
<h3>Teleseismic distances<a class="headerlink" href="#teleseismic-distances" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="simple">
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-body-wave-mb"><span class="xref std std-term">mb</span></a></dt><dd><p>Narrow band body wave magnitude measured on a WWSSN-SP filtered trace</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-cumulative-body-wave-mBc"><span class="xref std std-term">mBc</span></a></dt><dd><p>Cumulative body wave magnitude</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-body-wave-mB"><span class="xref std std-term">mB</span></a></dt><dd><p>Broad band body wave magnitude after <span id="id7">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span></p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-P-wave-moment-Mwp"><span class="xref std std-term">Mwp</span></a></dt><dd><p>The body wave magnitude of <span id="id8">Tsuboi <em>et al.</em> [<a class="reference internal" href="../base/references.html#id79" title="S. Tsuboi, K. Abe, K. Takano, and Y. Yamanaka. Rapid determination of Mw from broadband P waveforms. Bull. Seismol. Soc. Am., 1995. doi:10.1785/BSSA0850020606.">63</a>]</span></p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-surface-wave-Ms_20"><span class="xref std std-term">Ms_20</span></a></dt><dd><p>Surface-wave magnitude at 20 s period</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-broadband-surface-wave-Ms-BB"><span class="xref std std-term">Ms(BB)</span></a></dt><dd><p>Broad band surface-wave magnitude</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="derived-magnitudes">
|
||||
<h3>Derived magnitudes<a class="headerlink" href="#derived-magnitudes" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Additionally, scmag derives the following magnitudes from primary magnitudes:</p>
|
||||
<dl>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-derived-mB-Mw-mB"><span class="xref std std-term">Mw(mB)</span></a></dt><dd><p>Estimation of the moment magnitude Mw based on mB using the Mw vs. mB
|
||||
regression of <span id="id9">Bormann and Saul [<a class="reference internal" href="../base/references.html#id18" title="P. Bormann and J. Saul. The new iaspei standard broadband magnitude mb. Seismol. Res. Lett., 5:698 - 705, 2008. doi:10.1785/gssrl.79.5.698.">38</a>]</span></p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-derived-Mwp-Mw-Mwp"><span class="xref std std-term">Mw(Mwp)</span></a></dt><dd><p>Estimation of the moment magnitude Mw based on Mwp using the Mw vs. Mwp
|
||||
regression of <span id="id10">Whitmore <em>et al.</em> [<a class="reference internal" href="../base/references.html#id85" title="P.M. Whitmore, S. Tsuboi, B. Hirshorn, and T.J. Sokolowski. Magnitude dependent correction for Mwp. Science of Tsunami Hazards, 20(4):, 2002.">65</a>]</span></p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="../base/glossary.html#term-magnitude-summary-M"><span class="xref std std-term">M</span></a></dt><dd><p>Summary magnitude, which consists of a weighted average of the individual
|
||||
magnitudes and attempts to be a best possible compromise between all magnitudes.
|
||||
See below for configuration and also scevent for how to add the summary magnitude
|
||||
to the list of possible preferred magnitudes or how to make it always preferred.</p>
|
||||
<p>More details are given in the <a class="reference internal" href="#scmag-summarym"><span class="std std-ref">section Summary magnitude</span></a>.</p>
|
||||
</dd>
|
||||
<dt>Mw(avg)</dt><dd><p>Estimation of the moment magnitude Mw based on a weighted average of other
|
||||
magnitudes, currently MLv, mb and Mw(mB), in future possibly other magnitudes as
|
||||
well, especially those suitable for very large events. The purpose of Mw(avg) is
|
||||
to have, at any stage during the processing, a “best possible” estimation of the
|
||||
magnitude by combining all available magnitudes into a single, weighted average.
|
||||
Initially the average will consist of only MLv and/or mb measurements, but as soon
|
||||
as Mw(mB) measurements become available, these (and in future other large-event
|
||||
magnitudes) become progressively more weight in the average.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>If an amplitude is updated, the corresponding magnitude is updated as well.
|
||||
This allows the computation of preliminary, real-time magnitudes even before
|
||||
the full length of the P coda is available.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="station-magnitudes">
|
||||
<span id="scmag-stationm"></span><h2>Station magnitudes<a class="headerlink" href="#station-magnitudes" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Station magnitudes of a <a class="reference internal" href="#scmag-primarym"><span class="std std-ref">particular magnitude type</span></a> are
|
||||
calculated based on measured amplitudes considered by this magnitude type and
|
||||
the distance between the <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a> and the station at which the amplitude
|
||||
was measured. Typically, epicentral distance is used for distance. Magnitudes
|
||||
may support configurable distance measures, e.g.,
|
||||
<a class="reference internal" href="../base/glossary.html#term-magnitude-local-custom-MLc"><span class="xref std std-term">MLc</span></a>. The relation between measured
|
||||
amplitudes, distance and station magnitude is given by a calibration function
|
||||
which is specific to a magnitude type and configurable for some magnitudes.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Usually station magnitudes use amplitudes of the same type. However, some magnitude
|
||||
consider amplitudes of another type. E.g. <a class="reference internal" href="../base/glossary.html#term-magnitude-local-GNS-GEONET-MLr"><span class="xref std std-term">MLr</span></a>
|
||||
uses amplitudes computed for <a class="reference internal" href="../base/glossary.html#term-magnitude-local-vertical-MLv"><span class="xref std std-term">MLv</span></a>.</p>
|
||||
</div>
|
||||
<section id="regionalization">
|
||||
<h3>Regionalization<a class="headerlink" href="#regionalization" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Depending on the geographic region in which events, stations or entire ray paths
|
||||
are located, different calibration functions and constraints may apply. This is
|
||||
called “magnitude regionalization”. The region is defined by a polygon stored in
|
||||
a region file. For a particular magnitude, regionalization can be configured by
|
||||
global parameters, e.g., in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/global.cfg</span></code>.</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Add magnitude type profile to the magnitudes parameters. The name of the
|
||||
profile must be the name of the magnitude type.</p></li>
|
||||
<li><p>Add the profile-specific parameters.</p></li>
|
||||
</ol>
|
||||
<p>Example for MLc in <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/etc/global.cfg</span></code> the polygon with name
|
||||
<em>test</em> defined in a <a class="reference internal" href="global_gui.html#sec-gui-layers-vector"><span class="std std-ref">BNA file</span></a>:</p>
|
||||
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">magnitudes.MLc.regionFile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">@DATADIR@/spatial/vector/magnitudes/regions.bna</span>
|
||||
<span class="na">magnitudes.MLc.region.test.enable</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span>
|
||||
<span class="na">magnitudes.MLc.region.test.A0.logA0</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0:-1.3, 60:-2.8, 100:-3.0, 400:-4.5, 1000:-5.85</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="network-magnitudes">
|
||||
<span id="scmag-networkm"></span><h2>Network magnitudes<a class="headerlink" href="#network-magnitudes" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The network magnitude is a magnitude value summarizing several
|
||||
<a class="reference internal" href="#scmag-stationm"><span class="std std-ref">station magnitudes</span></a> values of one <a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origin</span></a>.
|
||||
Different methods are available for forming network magnitudes from station
|
||||
magnitudes:</p>
|
||||
<table class="docutils align-left">
|
||||
<colgroup>
|
||||
<col style="width: 20.0%" />
|
||||
<col style="width: 80.0%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Method</p></th>
|
||||
<th class="head"><p>Description</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>mean</p></td>
|
||||
<td><p>The usual mean value.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>trimmed mean value</p></td>
|
||||
<td><p>To stabilize the network magnitudes the smallest and the largest 12.5% of the <a class="reference internal" href="../base/glossary.html#term-station-magnitude"><span class="xref std std-term">station magnitude</span></a> values are removed before computing the mean.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>median</p></td>
|
||||
<td><p>The usual median value.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>median trimmed mean</p></td>
|
||||
<td><p>Removing all station magnitudes with a distance greater than 0.5 (default) from the median of all station magnitudes and computing the mean of all remaining station magnitudes.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Configure the method per magnitude type by <a class="reference internal" href="#confval-magnitudes.average"><code class="xref std std-confval docutils literal notranslate"><span class="pre">magnitudes.average</span></code></a>.
|
||||
Default values apply for each magnitude type which are defined by the magnitude
|
||||
itself.
|
||||
In the <a class="reference internal" href="scolv.html#scolv-sec-magnitude-tab"><span class="std std-ref">scolv Magnitudes tab</span></a> the methods, the
|
||||
stations magnitudes and other parameters can be selected interactively.</p>
|
||||
</section>
|
||||
<section id="summary-magnitude">
|
||||
<span id="scmag-summarym"></span><h2>Summary magnitude<a class="headerlink" href="#summary-magnitude" title="Permalink to this heading">¶</a></h2>
|
||||
<p>scmag can compute a summary magnitude as a weighted sum from all available
|
||||
<a class="reference internal" href="#scmag-networkm"><span class="std std-ref">network magnitudes</span></a>.
|
||||
This magnitude is typically called <strong>M</strong> as configured in
|
||||
<a class="reference internal" href="#confval-summaryMagnitude.type"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.type</span></code></a>.</p>
|
||||
<p>It is computed as a weighted average over the available magnitudes:</p>
|
||||
<div class="math">
|
||||
<p><img src="../_images/math/9af9964f1e826eea97592ba3eb00a1c8b0e42b05.png" alt="M &= \frac{\sum w_{i} * M_{i}}{\sum w_i} \\
|
||||
w_{i} &= a_i * stationCount(M_{i}) + b_i"/></p>
|
||||
</div><p>The coefficients a and b can be configured per magnitude type by
|
||||
<a class="reference internal" href="#confval-summaryMagnitude.coefficients.a"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.coefficients.a</span></code></a>
|
||||
and <a class="reference internal" href="#confval-summaryMagnitude.coefficients.b"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.coefficients.b</span></code></a>, respectively.
|
||||
Furthermore each magnitude type can be specifically added to or excluded from the
|
||||
summary magnitude calculation
|
||||
as defined in <a class="reference internal" href="#confval-summaryMagnitude.whitelist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.whitelist</span></code></a> or
|
||||
<a class="reference internal" href="#confval-summaryMagnitude.blacklist"><code class="xref std std-confval docutils literal notranslate"><span class="pre">summaryMagnitude.blacklist</span></code></a>, respectively.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>While the magnitudes are computed by scmag the decision about the preferred
|
||||
magnitude of an <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a> is made by <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="preferred-magnitude">
|
||||
<h2>Preferred Magnitude<a class="headerlink" href="#preferred-magnitude" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The preferred magnitude of an <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">event</span></a> is set automatically by <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a>
|
||||
or interactively in <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a>. It can be any network magnitude or the summary
|
||||
magnitude.</p>
|
||||
</section>
|
||||
<section id="module-configuration">
|
||||
<span id="scmag-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/scmag.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/scmag.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/scmag.cfg</span></code></div>
|
||||
</div>
|
||||
<p>scmag inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-magnitudes">
|
||||
<span class="sig-name descname"><span class="pre">magnitudes</span></span><a class="headerlink" href="#confval-magnitudes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">MLv,mb,mB,Mwp</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>The magnitude types to be calculated. Station magnitudes are
|
||||
computed from their amplitudes, network magnitudes from their
|
||||
station magnitudes.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-minimumArrivalWeight">
|
||||
<span class="sig-name descname"><span class="pre">minimumArrivalWeight</span></span><a class="headerlink" href="#confval-minimumArrivalWeight" 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>The minimum weight of an arrival for an associated amplitude
|
||||
to be used for calculating a magnitude.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>magnitudes.*</strong>
|
||||
<em>General parameters for computing magnitudes. Others are configured</em>
|
||||
<em>by global binding parameters for specific magnitude types.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-magnitudes.average">
|
||||
<span class="sig-name descname"><span class="pre">magnitudes.average</span></span><a class="headerlink" href="#confval-magnitudes.average" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">default</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>The methods for computing the network magnitude
|
||||
from station magnitudes. Exactly one method per
|
||||
magnitude can be configured.
|
||||
To define the averaging method per magnitude type append
|
||||
the type after colon, e.g.:
|
||||
"magnitudes.average = default, MLv:median"</p>
|
||||
<p>default: Compute the mean if less than 4 contributed
|
||||
station magnitudes exist. Otherwise apply trimmedMean(25),
|
||||
trimmed mean with 25%.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-connection.sendInterval">
|
||||
<span class="sig-name descname"><span class="pre">connection.sendInterval</span></span><a class="headerlink" href="#confval-connection.sendInterval" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Interval between 2 sending processes. The interval controls
|
||||
how often information is updated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>summaryMagnitude.*</strong>
|
||||
<em>The summary magnitude is the weighted average from all</em>
|
||||
<em>defined network magnitude types: Single network magnitude values</em>
|
||||
<em>are multiplied with their magnitude-type specific weight and</em>
|
||||
<em>summed up. The resulting sum is divided by the sum of all weights.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.enabled">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.enabled</span></span><a class="headerlink" href="#confval-summaryMagnitude.enabled" 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>Enables summary magnitude calculation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.type">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.type</span></span><a class="headerlink" href="#confval-summaryMagnitude.type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">M</span></code></p>
|
||||
<p>Type: <em>string</em></p>
|
||||
<p>Define the type/name of the summary magnitude.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.minStationCount">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.minStationCount</span></span><a class="headerlink" href="#confval-summaryMagnitude.minStationCount" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>This is the minimum station magnitude required for any
|
||||
magnitude to contribute to the summary magnitude at all. If
|
||||
this is set to 4, then no magnitude with less than 4 station
|
||||
magnitudes is taken into consideration even if this results
|
||||
in no summary magnitude at all. For this reason, the default
|
||||
here is 1 but in a purely automatic system it should be
|
||||
higher, at least 4 is recommended.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.singleton">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.singleton</span></span><a class="headerlink" href="#confval-summaryMagnitude.singleton" 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>Allow computing the summary magnitude even if only one single
|
||||
network magnitude meeting the other criteria is available.
|
||||
Unselecting this parameter will suppress computing summary
|
||||
magnitudes if only one network magnitude is available.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.blacklist">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.blacklist</span></span><a class="headerlink" href="#confval-summaryMagnitude.blacklist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>Define the magnitude types to be excluded from the summary
|
||||
magnitude calculation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.whitelist">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.whitelist</span></span><a class="headerlink" href="#confval-summaryMagnitude.whitelist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>Define the magnitude types to be included in the summary
|
||||
magnitude calculation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>summaryMagnitude.coefficients.*</strong>
|
||||
<em>The coefficients defining the weight of network magnitudes</em>
|
||||
<em>for calculating the summary magnitude.</em>
|
||||
<em>Weight = a * magnitudeStationCount + b.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.coefficients.a">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.coefficients.a</span></span><a class="headerlink" href="#confval-summaryMagnitude.coefficients.a" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0,</span> <span class="pre">Mw(mB):0.4,</span> <span class="pre">Mw(Mwp):0.4</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>Define the coefficients a. To define the value per magnitude
|
||||
type append the type after colon. A value without a
|
||||
type defines the default value.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-summaryMagnitude.coefficients.b">
|
||||
<span class="sig-name descname"><span class="pre">summaryMagnitude.coefficients.b</span></span><a class="headerlink" href="#confval-summaryMagnitude.coefficients.b" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1,</span> <span class="pre">MLv:2,</span> <span class="pre">Mw(mB):-1,</span> <span class="pre">Mw(Mwp):-1</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>Define the coefficients b. To define the value per magnitude
|
||||
type append the type after colon. A value without a
|
||||
type defines the default value.</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>
|
||||
<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-scmag-h">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-V">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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 -> scautopick2.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-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-scmag-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-scmag-D">
|
||||
<span id="cmdoption-scmag-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-scmag-D" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Run as daemon. This means the application will fork itself
|
||||
and doesn’t need to be started with &.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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 "shutdown-master-module" is
|
||||
given as well, this parameter is ignored.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-x">
|
||||
<span id="cmdoption-scmag-expiry"></span><span class="sig-name descname"><span class="pre">-x</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">--expiry</span></span><span class="sig-prename descclassname"> <span class="pre">time</span></span><a class="headerlink" href="#cmdoption-scmag-x" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Time span in hours after which objects expire.</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-scmag-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-scmag-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-scmag-v">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-q">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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-scmag-s">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-l">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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-scmag-debug">
|
||||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-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-scmag-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-scmag-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-scmag-u">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-H">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-t">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-g">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-S">
|
||||
<span id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-d">
|
||||
<span id="cmdoption-scmag-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-scmag-d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The database connection string, format:
|
||||
<a class="reference external" href="service://user:pwd@host/database">service://user:pwd@host/database</a>.
|
||||
"service" is the name of the database driver which
|
||||
can be queried with "--db-driver-list".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-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-scmag-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-scmag-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-scmag-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-scmag-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-scmag-db-disable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not use the database at all</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-scmag-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-scmag-ep" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Defines an event parameters XML file to be read and processed. This
|
||||
implies offline mode and only processes all origins contained
|
||||
in that file. It computes station magnitudes for all picks associated
|
||||
with an origin where amplitudes are available and the corresponding
|
||||
network magnitudes. Station and network magnitudes having the
|
||||
evaluation status set are ignored. Use --reprocess to include those
|
||||
magnitudes. It outputs an XML text adding the station-
|
||||
and network magnitudes to the input XML file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-reprocess">
|
||||
<span class="sig-name descname"><span class="pre">--reprocess</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-reprocess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reprocess also station and network magnitudes with an evaluation
|
||||
status set but do not change original weights. New
|
||||
contributions are added with weight 0.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="reprocess">
|
||||
<h3>Reprocess<a class="headerlink" href="#reprocess" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-static">
|
||||
<span class="sig-name descname"><span class="pre">--static</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-static" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>With that flag all existing station magnitudes are recomputed
|
||||
based on their associated amplitudes. If an amplitude cannot
|
||||
be accessed, no station magnitude is updated.
|
||||
Network magnitudes are recomputed based on their station
|
||||
magnitude contributions. No new objects will
|
||||
be created in this mode, it only updates values and weights.
|
||||
The method to accumulate the station magnitudes to form the network
|
||||
magnitude will be read from the existing object and replicated.
|
||||
If it cannot be interpreted, then the configured default for this
|
||||
magnitude type will be used instead. Weights of station magnitudes
|
||||
will be changed according to the accumulation method of the
|
||||
network magnitude.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scmag-keep-weights">
|
||||
<span class="sig-name descname"><span class="pre">--keep-weights</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scmag-keep-weights" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Keep the original weights in combination with --static.</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="#">scmag</a><ul>
|
||||
<li><a class="reference internal" href="#description">Description</a><ul>
|
||||
<li><a class="reference internal" href="#relationship-between-amplitudes-and-origins">Relationship between amplitudes and origins</a></li>
|
||||
<li><a class="reference internal" href="#primary-magnitudes">Primary magnitudes</a></li>
|
||||
<li><a class="reference internal" href="#local-distances">Local distances</a></li>
|
||||
<li><a class="reference internal" href="#teleseismic-distances">Teleseismic distances</a></li>
|
||||
<li><a class="reference internal" href="#derived-magnitudes">Derived magnitudes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#station-magnitudes">Station magnitudes</a><ul>
|
||||
<li><a class="reference internal" href="#regionalization">Regionalization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#network-magnitudes">Network magnitudes</a></li>
|
||||
<li><a class="reference internal" href="#summary-magnitude">Summary magnitude</a></li>
|
||||
<li><a class="reference internal" href="#preferred-magnitude">Preferred Magnitude</a></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="#input">Input</a></li>
|
||||
<li><a class="reference internal" href="#reprocess">Reprocess</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="scevent.html"
|
||||
title="previous chapter">scevent</a></p>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="scqc.html"
|
||||
title="next chapter">scqc</a></p>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/scmag.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 © 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>
|
||||
Reference in New Issue
Block a user