[installation] Change to nightly
This commit is contained in:
@ -4,7 +4,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>scevent — SeisComP Release documentation</title>
|
||||
<title>scevent — SeisComP Development 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" />
|
||||
@ -12,7 +12,7 @@
|
||||
<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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=744d344a"></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" />
|
||||
@ -25,8 +25,8 @@
|
||||
<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>
|
||||
<!-- span class="title">SeisComP Development</span -->
|
||||
<span class="version">7.0.0</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@ -74,8 +74,8 @@
|
||||
|
||||
<section id="scevent">
|
||||
<span id="id1"></span><h1>scevent<a class="headerlink" href="#scevent" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>Associates an Origin to an Event or forms a new Event if no match is found.
|
||||
Selects the preferred origin, magnitude and focal mechanism.</strong></p>
|
||||
<p><strong>Associate an Origin to an Event or form a new Event if no match is found.
|
||||
Select the preferred origin, magnitude and focal mechanism.</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p>As a consequence of a real-time system the <cite>SeisComP</cite> modules creates several
|
||||
@ -440,6 +440,46 @@ given origin ID.</p></li>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="rest-api">
|
||||
<span id="scevent-restapi"></span><h2>REST API<a class="headerlink" href="#rest-api" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">scevent</strong> provides a HTTP REST API which may be enabled by defining a
|
||||
bind address under <a class="reference internal" href="#confval-restAPI"><code class="xref std std-confval docutils literal notranslate"><span class="pre">restAPI</span></code></a>. The following enpoints are available</p>
|
||||
<section id="try-to-associate">
|
||||
<span id="scevent-restapi-associate"></span><h3>try-to-associate<a class="headerlink" href="#try-to-associate" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Allows to query for possible event associations of origin candidates. An event
|
||||
ID is returned if a matching event is found. No event is ever created.</p>
|
||||
<table class="docutils align-default">
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><strong>Location</strong></p></td>
|
||||
<td><p><cite>/api/1/try-to-associate</cite></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><strong>HTTP Methods</strong></p></td>
|
||||
<td><p>POST</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><strong>Request data</strong></p></td>
|
||||
<td><p><a class="reference internal" href="../base/glossary.html#term-SCML"><span class="xref std std-term">SCML</span></a> containing an <a class="reference internal" href="../base/api-python.html#api-python-datamodel-eventparameters"><span class="std std-ref">EventParameters</span></a> element with one and only one <a class="reference internal" href="../base/api-python.html#api-python-datamodel-origin"><span class="std std-ref">Origin</span></a></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><strong>Request header</strong></p></td>
|
||||
<td><p><cite>ContentType: text/xml</cite> (no subtype allowed)</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><strong>Response data</strong></p></td>
|
||||
<td><p>EventID string</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><strong>Response code</strong></p></td>
|
||||
<td><p><strong>200</strong> (matching event found), <strong>204</strong> (no matching event found), <strong>400</strong> (invalid input)</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The following example demonstrates how to query the event id for an origin
|
||||
defined in <code class="file docutils literal notranslate"><span class="pre">origin.xml</span></code> using the command line programm <strong class="program">curl</strong>.
|
||||
The request header <cite>Content-Type</cite> must be specified and must have a value of
|
||||
<cite>text/xml</cite>. No subtype is allowed. It is assumed that <strong class="program">scevent</strong> is
|
||||
configured with <cite>restAPI = 18182</cite>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-v<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:18182/api/1/try-to-associate<span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: text/xml"</span><span class="w"> </span>-d<span class="w"> </span>@origin.xml
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="plugins">
|
||||
<h2>Plugins<a class="headerlink" href="#plugins" title="Permalink to this heading">¶</a></h2>
|
||||
@ -490,12 +530,13 @@ given origin ID.</p></li>
|
||||
<dt class="sig sig-object std" id="confval-eventIDLookupMargin">
|
||||
<span class="sig-name descname"><span class="pre">eventIDLookupMargin</span></span><a class="headerlink" href="#confval-eventIDLookupMargin" 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>integer</em></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Configures the number of event ID slots to look back and
|
||||
forth when an event ID is already taken. The default in
|
||||
previous versions was 5. Now -1 means that the margin is
|
||||
determined automatically based on "eventAssociation.eventTimeBefore"
|
||||
and "eventAssociation.eventTimeAfter". According to the
|
||||
determined automatically based on
|
||||
"eventAssociation.eventTimeBefore" and
|
||||
"eventAssociation.eventTimeAfter". According to the
|
||||
configured "eventIDPattern" a fixed time range per slot
|
||||
can be computed and with that width the number of look
|
||||
ahead slots and look back slots can be computed based on
|
||||
@ -516,8 +557,9 @@ Flinn-Engdahl region name.</p>
|
||||
<dt class="sig sig-object std" id="confval-restAPI">
|
||||
<span class="sig-name descname"><span class="pre">restAPI</span></span><a class="headerlink" href="#confval-restAPI" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Defines the bind adress of the REST API endpoint. This API
|
||||
allows to query for possible event associations of origin
|
||||
<p>Defines the bind address of the REST API of form [address:]port.
|
||||
This API currently provides one endpoint, /api/1/try-to-associate,
|
||||
which allows to query for possible event associations of origin
|
||||
candidates.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -544,8 +586,9 @@ combination with %c. If %C is used, ‘ABCD’ is matched.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.minimumDefiningPhases</span></span><a class="headerlink" href="#confval-eventAssociation.minimumDefiningPhases" 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>int</em></p>
|
||||
<p>Minimum number of Picks for an Origin that is automatic and cannot be
|
||||
associated with an Event to be allowed to form an new Event.</p>
|
||||
<p>Minimum number of Picks for an Origin that is automatic
|
||||
and cannot be associated with an Event to be allowed to
|
||||
form an new Event.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -577,8 +620,8 @@ from CMT/MT inversions.</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1800</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Time range before the Origin time of an incoming Origin to search for
|
||||
matching events.</p>
|
||||
<p>Time range before the Origin time of an incoming Origin to
|
||||
search for matching events.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -587,8 +630,8 @@ matching events.</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1800</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Time range after the Origin time of an incoming Origin to search for
|
||||
matching events.</p>
|
||||
<p>Time range after the Origin time of an incoming Origin to
|
||||
search for matching events.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -596,8 +639,8 @@ matching events.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.minimumMatchingArrivals</span></span><a class="headerlink" href="#confval-eventAssociation.minimumMatchingArrivals" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">3</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Minimum number of matching picks between two Origins to be associated
|
||||
to the same event.</p>
|
||||
<p>Minimum number of matching picks between two Origins to be
|
||||
associated to the same event.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -618,11 +661,11 @@ of the pickID. Pass: |pick1.time - pick2.time| <= threshold</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p>Type: <em>boolean</em></p>
|
||||
<p>This parameter is only used in conjunction with
|
||||
eventAssociation.maximumMatchingArrivalTimeDiff.
|
||||
"eventAssociation.maximumMatchingArrivalTimeDiff".
|
||||
If a station has multiple associated arrivals for a
|
||||
particular event, this flag defines if the time distance
|
||||
of a new pick to all arrivals must be within
|
||||
eventAssociation.maximumMatchingArrivalTimeDiff
|
||||
"eventAssociation.maximumMatchingArrivalTimeDiff"
|
||||
or if one matching arrival is enough.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -640,9 +683,9 @@ or if one matching arrival is enough.</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">60</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Associates an Origin with an existing event if the Origin
|
||||
time differs not more than 60 seconds unless the
|
||||
minimumMatchingArrivals criteria matches.</p>
|
||||
<p>Associates an Origin with an existing event if the Origin
|
||||
time differs not more than 60 seconds unless
|
||||
"eventAssociation.minimumMatchingArrivals" matches.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -651,8 +694,8 @@ minimumMatchingArrivals criteria matches.</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
|
||||
<p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>degrees</em></p>
|
||||
<p>Allowed location difference between an incoming Origin compared with
|
||||
preferred Origins to get associated.</p>
|
||||
<p>Allowed location difference between an incoming Origin
|
||||
compared with preferred Origins to get associated.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -660,19 +703,25 @@ preferred Origins to get associated.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.magTypes</span></span><a class="headerlink" href="#confval-eventAssociation.magTypes" 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>list:string</em></p>
|
||||
<p>Magnitude type priority list for becoming a preferred magnitude for an
|
||||
event.</p>
|
||||
<p>List of magnitude types considered for computing priorities
|
||||
in order to declare the preferred magnitude of an event.
|
||||
Magnitudes not listed have a priority of 0 and are ranked
|
||||
by station count only.</p>
|
||||
<p>Magnitudes must meet
|
||||
"eventAssociation.minimumMagnitudes" and
|
||||
"eventAssociation.minMwCount" unless
|
||||
"eventAssociation.enableFallbackMagnitude" is true.
|
||||
If listed, Mw-/Mw()-type magnitudes are preferred over all
|
||||
others. Next, the magnitude type with the largest station
|
||||
count wins (default) unless
|
||||
"eventAssociation.magPriorityOverStationCount" is
|
||||
true. If the station count is equal, priority is highest
|
||||
for the magnitude earliest in the list.</p>
|
||||
<p>If "eventAssociation.magPriorityOverStationCount" is
|
||||
true, highest priority is first given to magnitude types
|
||||
earliest in the list before testing the station count.</p>
|
||||
<p>Example:</p>
|
||||
<p>M, mBc, Mw(mB), Mwp, ML, MLh, MLv, mb</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.enableFallbackMagnitude">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.enableFallbackMagnitude</span></span><a class="headerlink" href="#confval-eventAssociation.enableFallbackMagnitude" 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>If true, one magnitude will be preferred even if magnitude criteria are
|
||||
not fullfilled.</p>
|
||||
<p>M, mBc, Mw(mB), Mwp, ML, MLv, mb</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -680,8 +729,11 @@ not fullfilled.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.minimumMagnitudes</span></span><a class="headerlink" href="#confval-eventAssociation.minimumMagnitudes" 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>int</em></p>
|
||||
<p>Minimum number of station magnitudes referenced to a network magnitude
|
||||
to become a preferred magnitude.</p>
|
||||
<p>Minimum number of station magnitudes required for
|
||||
considering non-Mw or non-Mw() magnitudes, as
|
||||
preferred magnitude.</p>
|
||||
<p>Also consider
|
||||
"eventAssociation.enableFallbackMagnitude".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -689,8 +741,23 @@ to become a preferred magnitude.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.minMwCount</span></span><a class="headerlink" href="#confval-eventAssociation.minMwCount" 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>int</em></p>
|
||||
<p>Minimum number of station magnitudes required for Mw(mB) to be considered as
|
||||
preferred magnitude.</p>
|
||||
<p>Minimum number of station magnitudes required for
|
||||
considering Mw or any derived moment magnitude, Mw(), as
|
||||
preferred magnitude. The moment magnitudes must also meet
|
||||
"eventAssociation.minimumMagnitudes".</p>
|
||||
<p>Also consider
|
||||
"eventAssociation.enableFallbackMagnitude".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.enableFallbackMagnitude">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.enableFallbackMagnitude</span></span><a class="headerlink" href="#confval-eventAssociation.enableFallbackMagnitude" 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>If true, one magnitude will be preferred even if magnitude
|
||||
criteria ("eventAssociation.minimumMagnitudes",
|
||||
"eventAssociation.minMwCount") are not fulfilled
|
||||
by any magnitude.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -698,8 +765,8 @@ preferred magnitude.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.mbOverMwCount</span></span><a class="headerlink" href="#confval-eventAssociation.mbOverMwCount" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Minimum number of station magnitudes which ensures that Mw(mB) will be
|
||||
preferred and not mb.</p>
|
||||
<p>Minimum number of station magnitudes which ensures that
|
||||
Mw(mB) will be preferred and not mb.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -707,8 +774,8 @@ preferred and not mb.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.mbOverMwValue</span></span><a class="headerlink" href="#confval-eventAssociation.mbOverMwValue" 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>double</em></p>
|
||||
<p>Average between mb and Mw(mB) which must be exceeded to become Mw(mB)
|
||||
preferred.</p>
|
||||
<p>Average between mb and Mw(mB) which must be exceeded to
|
||||
become Mw(mB) preferred.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -716,10 +783,10 @@ preferred.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.magPriorityOverStationCount</span></span><a class="headerlink" href="#confval-eventAssociation.magPriorityOverStationCount" 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>If false then the station count rules out the magnitude priority
|
||||
<p>If false, then the station count rules out the magnitude priority
|
||||
which is only taken into account if two magnitudes have the
|
||||
same station count.</p>
|
||||
<p>If true then the priority rules out the station count
|
||||
<p>If true, then the priority rules out the station count
|
||||
which is only taken into account if two magnitudes have the
|
||||
same priority.</p>
|
||||
</dd></dl>
|
||||
@ -727,74 +794,89 @@ same priority.</p>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.priorities">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.priorities</span></span><a class="headerlink" href="#confval-eventAssociation.priorities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">AGENCY,</span> <span class="pre">STATUS,</span> <span class="pre">PHASES_AUTOMATIC,</span> <span class="pre">TIME_AUTOMATIC</span></code></p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">AGENCY,STATUS,PHASES_AUTOMATIC,TIME_AUTOMATIC</span></code></p>
|
||||
<p>Type: <em>list:string</em></p>
|
||||
<p>The general priority list to decide if an Origin becomes preferred.
|
||||
The priority decreases in the order of the parameters.
|
||||
This list is not used unless this parameter is activated.</p>
|
||||
<p>Empty priority list: scevent replicates the default hard wired behaviour:
|
||||
AGENCY, STATUS, PHASES_AUTOMATIC, TIME_AUTOMATIC</p>
|
||||
<p>Each item in the list corresponds to a check that is performed.
|
||||
Each check computes a score of the incoming Origin (s1) and the
|
||||
current preferred Origin (s2). If the s1 is lower than s2,
|
||||
the incoming Origin is rejected and does not become preferred.
|
||||
All subsequent checks are ignored.
|
||||
If s1 is equal to s2, the next check in the list is performed.
|
||||
If s1 is larger than s2, the Origin becomes preferred and
|
||||
all subsequent checks are ignored.</p>
|
||||
<p>Available tokens:</p>
|
||||
<p>AGENCY: check based on agency priorities</p>
|
||||
<p>AUTHOR: check based on author priorities</p>
|
||||
<p>MODE: evaluation mode priority: 0 = unset, 1 = automatic, 2 = manual, manual over-rules automatic</p>
|
||||
<p>STATUS: priority combined from evaluation status and evaluation mode:
|
||||
-100 = status is rejected, -1 = status is reported,
|
||||
0 = status is preliminary or status is unset and mode is automatic,
|
||||
1 = status is confirmed or status is unset and mode is manual,
|
||||
2 = status is reviewed, 3 = status is final,</p>
|
||||
<p>METHOD: check based on the method priorities</p>
|
||||
<p>PHASES: higher phase count = higher priority</p>
|
||||
<p>PHASES_AUTOMATIC: only checks phase priorities for incoming automatic Origins</p>
|
||||
<p>RMS: lower rms = higher priority</p>
|
||||
<p>RMS_AUTOMATIC: only check RMS on incoming automatic Origins</p>
|
||||
<p>TIME: more recent Origins (creationTime) have higher priorities</p>
|
||||
<p>TIME_AUTOMATIC: only check creationTime priority on incoming automatic Origins</p>
|
||||
<p>SCORE: evaluates the score according to a configured ScoreProcessor and
|
||||
prefers the Origin/Focalmechanism with the highest score.</p>
|
||||
<p>Values: <code class="docutils literal notranslate"><span class="pre">'',AGENCY,AUTHOR,MODE,PHASES,PHASES_AUTOMATIC,RMS,RMS_AUTOMATIC,SCORE,STATUS,TIME,TIME_AUTOMATIC</span></code></p>
|
||||
<p>The general priority list to decide if new Origins become
|
||||
preferred.</p>
|
||||
<p>Tokens are processed in the given order. Each token in the
|
||||
list corresponds to a check that is performed. Each check
|
||||
computes a score of the incoming Origin (s1) and the
|
||||
currently preferred Origin (s2). The origin with the higher
|
||||
score becomes preferred for the event. If s1 equals s2, the
|
||||
next check in the list is performed. Once a check prefers an
|
||||
origin, all subsequent checks are ignored.</p>
|
||||
<p>Available tokens (checks):</p>
|
||||
<p>* AGENCY: check based on agency priorities</p>
|
||||
<p>* AUTHOR: check based on author priorities</p>
|
||||
<p>* MODE: priority from evaluation mode. Priority values are</p>
|
||||
<p>0 : unset</p>
|
||||
<p>1 : automatic</p>
|
||||
<p>2 : manual, manual over-rules automatic</p>
|
||||
<p>* STATUS: priority combined from evaluation status and
|
||||
evaluation mode. Priority values are</p>
|
||||
<p>-100 : status is rejected</p>
|
||||
<p>-1 : status is reported</p>
|
||||
<p>0 : status is preliminary or status is unset and mode is automatic</p>
|
||||
<p>1 : status is confirmed or status is unset and mode is manual</p>
|
||||
<p>2 : status is reviewed</p>
|
||||
<p>3 : status is final</p>
|
||||
<p>* METHOD: priority based on the methods defined in "eventAssociation.methods"</p>
|
||||
<p>* PHASES: higher phase count = higher priority</p>
|
||||
<p>* PHASES_AUTOMATIC: only checks phase priorities for incoming
|
||||
automatic Origins. Higher phase count = higher priority.</p>
|
||||
<p>* RMS: lower RMS = higher priority.</p>
|
||||
<p>* RMS_AUTOMATIC: only check RMS on incoming automatic Origins.
|
||||
Lower RMS = higher priority.</p>
|
||||
<p>* TIME: more recent Origins (creationTime) have higher priorities.</p>
|
||||
<p>* TIME_AUTOMATIC: only check creationTime of incoming
|
||||
automatic Origins. More recent Origins (creationTime) have higher priorities.</p>
|
||||
<p>* SCORE: priority based on the score according to a configured
|
||||
ScoreProcessor and prefers the Origin/Focalmechanism with
|
||||
the highest score.</p>
|
||||
<p>Empty priority list replicates the hard-wired default
|
||||
behaviour: AGENCY,STATUS,PHASES_AUTOMATIC,TIME_AUTOMATIC</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.agencies">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.agencies</span></span><a class="headerlink" href="#confval-eventAssociation.agencies" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>The agencyID priority list. When the eventtool comes to the point to
|
||||
select a preferred Origin based on AGENCY it orders all Origins by its agency priority and
|
||||
selects then the best one among the highest priority agency. It also defines the
|
||||
agency priority for custom priority checks
|
||||
(eventAssociation.priorities).</p>
|
||||
<p>The parameter is only considered when defined in "priorities".</p>
|
||||
<p>The priority list of agency IDs. When scevent comes to the
|
||||
point to select a preferred Origin based on AGENCY it orders
|
||||
all Origins by its agency priority selecting the best one
|
||||
among the highest priority agency. It also defines the
|
||||
agency priority for custom priority checks.</p>
|
||||
<p>The parameter is only considered when AGENCY is used in
|
||||
"eventAssociation.priorities".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.authors">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.authors</span></span><a class="headerlink" href="#confval-eventAssociation.authors" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>The author priority list. When the eventtool comes to the point to
|
||||
select a preferred Origin based on AUTHOR it orders all Origins by its author priority and
|
||||
selects then the best one among the highest priority author. It also defines the
|
||||
author priority for custom priority checks (eventAssociation.priorities).</p>
|
||||
<p>The parameter is only considered when defined in "priorities".</p>
|
||||
<p>The author priority list. When scevent comes to the
|
||||
point to select a preferred Origin based on AUTHOR it orders
|
||||
all Origins by its author priority and selects then the best
|
||||
one among the highest priority author. It also defines the
|
||||
author priority for custom priority checks.</p>
|
||||
<p>The parameter is only considered when AUTHOR is used
|
||||
in "eventAssociation.priorities".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.methods">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.methods</span></span><a class="headerlink" href="#confval-eventAssociation.methods" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>list:string</em></p>
|
||||
<p>The method priority list. When the eventtool comes to the point to
|
||||
select a preferred Origin based on METHOD it orders all Origins by its methodID priority and
|
||||
selects then the best one among the highest priority method. It also defines the
|
||||
method priority for custom priority checks (eventAssociation.priorities).
|
||||
A defined method string must match exactly the string in Origin.methodID.</p>
|
||||
<p>The parameter is only considered when defined in "priorities".</p>
|
||||
<p>The method priority list. When the scevent comes to the
|
||||
point to select a preferred Origin based on METHOD it orders
|
||||
all Origins by its methodID priority and selects then the
|
||||
best one among the highest priority method. It also defines
|
||||
the method priority for custom priority checks. A defined
|
||||
method string must match exactly the string in
|
||||
Origin.methodID.</p>
|
||||
<p>The parameter is only considered when METHODS is used
|
||||
in "eventAssociation.priorities".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -802,8 +884,19 @@ A defined method string must match exactly the string in Origin.methodID.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.score</span></span><a class="headerlink" href="#confval-eventAssociation.score" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Defines the ScoreProcessor interface to be used along
|
||||
with priority "SCORE".</p>
|
||||
<p>The parameter is only considered when defined in "priorities".</p>
|
||||
with priority "SCORE" when defined in
|
||||
"eventAssociation.priorities".</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.enablePreferredFMSelection">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.enablePreferredFMSelection</span></span><a class="headerlink" href="#confval-eventAssociation.enablePreferredFMSelection" 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 the selection of the preferred focalmechanism. If set
|
||||
to false then only explicit commands will have effect on the
|
||||
preferred focalmechanism selection, namely the EvPrefFocMecID
|
||||
command.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -820,26 +913,27 @@ has been fixed.</p>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.delayTimeSpan">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.delayTimeSpan</span></span><a class="headerlink" href="#confval-eventAssociation.delayTimeSpan" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>int</em></p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Type: <em>int</em></p>
|
||||
<p>Unit: <em>s</em></p>
|
||||
<p>Configures a timespan to delay Event creation. If a new Origin arrives
|
||||
which cannot be associated to an existing Event, delay the Event creation for a certain
|
||||
timespan.</p>
|
||||
<p>The timespan to delay Event creation from new Origins which
|
||||
cannot be associated to an existing Event.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>eventAssociation.region.*</strong>
|
||||
<em>Region filter for creating events. Use with care! Origins</em>
|
||||
<em>outside may be ignored even if they would</em>
|
||||
<em>become preferred otherwise.</em></p>
|
||||
<em>outside may be ignored even if they would become preferred</em>
|
||||
<em>otherwise. Empty value deactivates testing this parameter.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.region.rect">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.region.rect</span></span><a class="headerlink" href="#confval-eventAssociation.region.rect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>Region by geographic coordinates.</p>
|
||||
<p>Format: "South, East, North, West"</p>
|
||||
<dd><p>Type: <em>list:double</em></p>
|
||||
<p>Region by geographic coordinates. Empty value
|
||||
deactivates testing this parameter.</p>
|
||||
<p>Format: "South,East,North,West"</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -847,7 +941,8 @@ timespan.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.region.minDepth</span></span><a class="headerlink" href="#confval-eventAssociation.region.minDepth" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>km</em></p>
|
||||
<p>Minimum depth.</p>
|
||||
<p>Minimum depth. Empty value deactivates testing this
|
||||
parameter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -855,20 +950,23 @@ timespan.</p>
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.region.maxDepth</span></span><a class="headerlink" href="#confval-eventAssociation.region.maxDepth" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>double</em></p>
|
||||
<p>Unit: <em>km</em></p>
|
||||
<p>Maximum depth.</p>
|
||||
<p>Maximum depth. Empty value deactivates testing this
|
||||
parameter.</p>
|
||||
</dd></dl>
|
||||
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><strong>eventAssociation.delayFilter.*</strong>
|
||||
<em>The delayFilter group configures an Origin filter to activate the delay feature for</em>
|
||||
<em>this Origin. If more than one filter is given they are combined with AND.</em></p>
|
||||
<em>Configure an Origin filter to delay Origin for being</em>
|
||||
<em>processed. If more than one filter is given they are</em>
|
||||
<em>combined with AND. The application requires</em>
|
||||
<em>eventAssociation.delayTimeSpan > 0.</em></p>
|
||||
</div>
|
||||
<dl class="std confval">
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.delayFilter.agencyID">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.delayFilter.agencyID</span></span><a class="headerlink" href="#confval-eventAssociation.delayFilter.agencyID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>The agencyID of the Origin to be delayed.</p>
|
||||
<p>The agency ID of the Origin to be delayed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std confval">
|
||||
@ -882,8 +980,8 @@ timespan.</p>
|
||||
<dt class="sig sig-object std" id="confval-eventAssociation.delayFilter.evaluationMode">
|
||||
<span class="sig-name descname"><span class="pre">eventAssociation.delayFilter.evaluationMode</span></span><a class="headerlink" href="#confval-eventAssociation.delayFilter.evaluationMode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Type: <em>string</em></p>
|
||||
<p>The evaluation mode of the Origin to be delayed. Can be either "manual"
|
||||
or "automatic".</p>
|
||||
<p>Values: <code class="docutils literal notranslate"><span class="pre">automatic,manual</span></code></p>
|
||||
<p>The evaluation mode of the Origin to be delayed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<section id="eventtype-extension">
|
||||
@ -1124,7 +1222,7 @@ given as well, this parameter is ignored.</p>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-O">
|
||||
<span id="cmdoption-scevent-origin-id"></span><span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--origin-id</span></span><span class="sig-prename descclassname"> <span class="pre">publicID</span></span><a class="headerlink" href="#cmdoption-scevent-O" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>OriginID to be associated. When given no messages are sent.
|
||||
<dd><p>Origin ID to be associated. When given no messages are sent.
|
||||
Only the status of the association is written to stdout.</p>
|
||||
</dd></dl>
|
||||
|
||||
@ -1226,7 +1324,8 @@ This option can be given more than once.</p>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-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-scevent-start-stop-msg" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set sending of a start and a stop message.</p>
|
||||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||||
<p>Set sending of a start and a stop message.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
@ -1266,6 +1365,52 @@ can be queried with "--db-driver-list".</p>
|
||||
<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-scevent-ep">
|
||||
<span class="sig-name descname"><span class="pre">--ep</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-ep" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Event parameters XML file for offline processing of all
|
||||
contained origins. Use ‘-’ to read from stdin.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-reprocess">
|
||||
<span class="sig-name descname"><span class="pre">--reprocess</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-reprocess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reprocess event parameters ignoring all event and journal
|
||||
objects in input file. Works only in combination with ‘--ep’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-update-event-id">
|
||||
<span class="sig-name descname"><span class="pre">--update-event-id</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-update-event-id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Update IDs of events if they already exist. Works only in
|
||||
combination with ‘--ep’.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-clear-cache">
|
||||
<span class="sig-name descname"><span class="pre">--clear-cache</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-clear-cache" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Send a clear cache message and quit.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-disable-info-log">
|
||||
<span class="sig-name descname"><span class="pre">--disable-info-log</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-disable-info-log" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Do not populate the scevent-processing-info.log file.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="output">
|
||||
<h3>Output<a class="headerlink" href="#output" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-scevent-f">
|
||||
<span id="cmdoption-scevent-formatted"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--formatted</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-f" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Use formatted XML output along with ‘--ep’. Otherwise XML
|
||||
is unformatted.</p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
@ -1319,6 +1464,10 @@ can be queried with "--db-driver-list".</p>
|
||||
<li><a class="reference internal" href="#EvTypeCertainty"><code class="docutils literal notranslate"><span class="pre">EvTypeCertainty()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#rest-api">REST API</a><ul>
|
||||
<li><a class="reference internal" href="#try-to-associate">try-to-associate</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#plugins">Plugins</a></li>
|
||||
<li><a class="reference internal" href="#module-configuration">Module Configuration</a><ul>
|
||||
<li><a class="reference internal" href="#eventtype-extension">EventType extension</a></li>
|
||||
@ -1330,6 +1479,8 @@ can be queried with "--db-driver-list".</p>
|
||||
<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="#output">Output</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -1366,7 +1517,7 @@ can be queried with "--db-driver-list".</p>
|
||||
</a>
|
||||
<div class="stretched align-center fitted content">
|
||||
<div>
|
||||
Version <b>6.9.0</b> Release
|
||||
Version <b>7.0.0</b> Development
|
||||
</div>
|
||||
<div class="copyright">
|
||||
Copyright © gempa GmbH, GFZ Potsdam.
|
||||
|
||||
Reference in New Issue
Block a user