1382 lines
		
	
	
		
			87 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			1382 lines
		
	
	
		
			87 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html>
 | 
						||
 | 
						||
<html  lang="en">
 | 
						||
  <head>
 | 
						||
    <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 | 
						||
 | 
						||
    <title>scevent — 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="scmag" href="scmag.html" />
 | 
						||
    <link rel="prev" title="scautopick" href="scautopick.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.1</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="scmag.html" title="scmag"
 | 
						||
             accesskey="N">
 | 
						||
            next
 | 
						||
          </a>
 | 
						||
        </li>
 | 
						||
        <li class="right">
 | 
						||
          <a href="scautopick.html" title="scautopick"
 | 
						||
             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="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>
 | 
						||
<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
 | 
						||
<a class="reference internal" href="../base/glossary.html#term-origin"><span class="xref std std-term">origins</span></a> (results of localization processes) for one earthquake
 | 
						||
or other seismic events because as time
 | 
						||
goes by more seismic phases are available. scevent receives these origins and
 | 
						||
associates the origins to <a class="reference internal" href="../base/glossary.html#term-event"><span class="xref std std-term">events</span></a>. It is also possible to import
 | 
						||
and associate origins from other agencies.</p>
 | 
						||
<p>The main tasks of scevent are:</p>
 | 
						||
<ul class="simple">
 | 
						||
<li><p><a class="reference internal" href="#scevent-assocorg"><span class="std std-ref">Associate origins</span></a> to events.</p></li>
 | 
						||
<li><p>Set the <a class="reference internal" href="#scevent-eventid"><span class="std std-ref">ID of events</span></a>.</p></li>
 | 
						||
<li><p>Set the <a class="reference internal" href="#scevent-preforg"><span class="std std-ref">preferred origin</span></a> from all available origins.</p></li>
 | 
						||
<li><p>Set the <a class="reference internal" href="#scevent-prefmag"><span class="std std-ref">preferred magnitude</span></a> from all available magnitudes.</p></li>
 | 
						||
<li><p>Set the <a class="reference internal" href="#scevent-preffm"><span class="std std-ref">preferred focal mechanism</span></a> from all available focal mechanisms.</p></li>
 | 
						||
<li><p><em>Optional:</em> Set the event type of automatic origins based by the plugin
 | 
						||
<a class="reference internal" href="scevent_regioncheck.html#scevent-regioncheck"><span class="std std-ref">evrc</span></a> based on the hypocenter location of the
 | 
						||
preferred origin. This requires the configuration of the
 | 
						||
<a class="reference internal" href="scevent_regioncheck.html#scevent-regioncheck"><span class="std std-ref">evrc</span></a> plugin and of geographic regions by
 | 
						||
<a class="reference internal" href="global_gui.html#sec-gui-layers"><span class="std std-ref">polygons in BNA or GeoJSON format</span></a>.</p></li>
 | 
						||
</ul>
 | 
						||
</section>
 | 
						||
<section id="origin-association">
 | 
						||
<span id="scevent-assocorg"></span><h2>Origin Association<a class="headerlink" href="#origin-association" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>scevent associates origins to events by searching for the best match of the new
 | 
						||
(incoming) origin to other origins for existing events:</p>
 | 
						||
<ul class="simple">
 | 
						||
<li><p>Associate origins belonging to belonging to <strong>the same seismic event</strong>
 | 
						||
to the same event object in <cite>SeisComP</cite>.</p></li>
 | 
						||
<li><p>Associate origins belonging to <strong>different seismic events</strong>
 | 
						||
to different event objects in <cite>SeisComP</cite>.</p></li>
 | 
						||
</ul>
 | 
						||
<p>If no match can be found, a new event can be formed.</p>
 | 
						||
<p>Origins can be filtered/ignored based on</p>
 | 
						||
<ul class="simple">
 | 
						||
<li><p>ID of agency which has created the origin:
 | 
						||
<a class="reference internal" href="global.html#confval-processing.blacklist.agencies"><code class="xref std std-confval docutils literal notranslate"><span class="pre">processing.blacklist.agencies</span></code></a>,
 | 
						||
<a class="reference internal" href="global.html#confval-processing.whitelist.agencies"><code class="xref std std-confval docutils literal notranslate"><span class="pre">processing.whitelist.agencies</span></code></a> (global parameters),</p></li>
 | 
						||
<li><p>Hypocenter parameters: <a class="reference internal" href="#confval-eventAssociation.region.rect"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.region.rect</span></code></a>,
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.region.minDepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.region.minDepth</span></code></a>,
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.region.maxDepth"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.region.maxDepth</span></code></a>.</p></li>
 | 
						||
</ul>
 | 
						||
<section id="origin-match">
 | 
						||
<h3>Origin match<a class="headerlink" href="#origin-match" title="Permalink to this heading">¶</a></h3>
 | 
						||
<p>The new origin is matched to existing origins by comparing differences in epicenter,
 | 
						||
origin time, and <a class="reference internal" href="../base/glossary.html#term-arrival"><span class="xref std std-term">arrivals</span></a> (associated picks).
 | 
						||
The new origin is matched to an existing origin which has the highest rank in
 | 
						||
the following three groups (1, 2, 3):</p>
 | 
						||
<ol class="arabic">
 | 
						||
<li><p>Location and Time (lowest)</p>
 | 
						||
<p>The difference in horizontal location is less than
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.maximumDistance"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.maximumDistance</span></code></a> (degrees)
 | 
						||
and the difference in origin times is less than
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.maximumTimeSpan"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.maximumTimeSpan</span></code></a>.</p>
 | 
						||
</li>
 | 
						||
<li><p>Picks</p>
 | 
						||
<p>The two origins have more than <a class="reference internal" href="#confval-eventAssociation.minimumMatchingArrivals"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.minimumMatchingArrivals</span></code></a>
 | 
						||
matching picks. Picks are matched either by ID or by time depending
 | 
						||
on <a class="reference internal" href="#confval-eventAssociation.maximumMatchingArrivalTimeDiff"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.maximumMatchingArrivalTimeDiff</span></code></a>.</p>
 | 
						||
</li>
 | 
						||
<li><p>Picks and Location and Time (highest)</p>
 | 
						||
<p>This is the best match, for which both the location-and-time and picks
 | 
						||
criteria above are satisfied.</p>
 | 
						||
</li>
 | 
						||
</ol>
 | 
						||
<p>If more than one origin is found in the highest ranking class, then the first
 | 
						||
one of them is chosen.</p>
 | 
						||
<div class="admonition note">
 | 
						||
<p class="admonition-title">Note</p>
 | 
						||
<p>For efficiency events in the cache are scanned first and if no matches are found,
 | 
						||
the database is scanned for the time window <a class="reference internal" href="#confval-eventAssociation.eventTimeBefore"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.eventTimeBefore</span></code></a> -
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.eventTimeAfter"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.eventTimeAfter</span></code></a>
 | 
						||
around the incoming Origin time. The cached events are ordered by eventID and
 | 
						||
thus in time.</p>
 | 
						||
</div>
 | 
						||
</section>
 | 
						||
<section id="no-origin-match">
 | 
						||
<h3>No origin match<a class="headerlink" href="#no-origin-match" title="Permalink to this heading">¶</a></h3>
 | 
						||
<p>If no event with an origin that matches the incoming origin is found, then a
 | 
						||
new event is formed and the origin is associated to that event. The following
 | 
						||
criteria are applied to allow the creation of the new event:</p>
 | 
						||
<ul class="simple">
 | 
						||
<li><p>The agency for the origin is not black listed (<a class="reference internal" href="global.html#confval-processing.blacklist.agencies"><code class="xref std std-confval docutils literal notranslate"><span class="pre">processing.blacklist.agencies</span></code></a>).</p></li>
 | 
						||
<li><p>The origin is automatic and it has more than <a class="reference internal" href="#confval-eventAssociation.minimumDefiningPhases"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.minimumDefiningPhases</span></code></a>
 | 
						||
<a class="reference internal" href="../base/glossary.html#term-arrival"><span class="xref std std-term">arrivals</span></a> (associated picks).</p></li>
 | 
						||
</ul>
 | 
						||
<figure class="align-center" id="id2">
 | 
						||
<a class="reference internal image-reference" href="../_images/Association_of_an_origin_by_matching_picks.jpg"><img alt="alternate association of an origin by matching picks." src="../_images/Association_of_an_origin_by_matching_picks.jpg" style="width: 529.0px; height: 397.0px;" /></a>
 | 
						||
<figcaption>
 | 
						||
<p><span class="caption-text">Association of an origin to an event by matching picks.</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
 | 
						||
</figcaption>
 | 
						||
</figure>
 | 
						||
</section>
 | 
						||
</section>
 | 
						||
<section id="preferred-origin">
 | 
						||
<span id="scevent-preforg"></span><h2>Preferred Origin<a class="headerlink" href="#preferred-origin" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>The preferred origin is set by ranking of all associated origins. The ranking
 | 
						||
is controlled by <a class="reference internal" href="#confval-eventAssociation.priorities"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.priorities</span></code></a> and related configuration
 | 
						||
parameters.</p>
 | 
						||
</section>
 | 
						||
<section id="preferred-magnitude">
 | 
						||
<span id="scevent-prefmag"></span><h2>Preferred Magnitude<a class="headerlink" href="#preferred-magnitude" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>The preferred magnitude is set by ranking of the
 | 
						||
<a class="reference internal" href="scmag.html#scmag-summarym"><span class="std std-ref">summary magnitude</span></a> and all <a class="reference internal" href="scmag.html#scmag-networkm"><span class="std std-ref">network magnitudes</span></a>
 | 
						||
of the preferred origin. The ranking is mainly controlled by
 | 
						||
<a class="reference internal" href="#confval-eventAssociation.magTypes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.magTypes</span></code></a> and <a class="reference internal" href="#confval-eventAssociation.minimumMagnitudes"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventAssociation.minimumMagnitudes</span></code></a>
 | 
						||
and related configuration parameters.</p>
 | 
						||
<p>Magnitudes where the evaluation mode is ‘rejected’ are ignored.</p>
 | 
						||
</section>
 | 
						||
<section id="preferred-focal-mechanism">
 | 
						||
<span id="scevent-preffm"></span><h2>Preferred Focal Mechanism<a class="headerlink" href="#preferred-focal-mechanism" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>The most recent manual focal mechanism or, if no manual ones are unavailable, the
 | 
						||
most recent automatic focal mechnisms becomes preferred.</p>
 | 
						||
</section>
 | 
						||
<section id="scevent-eventid">
 | 
						||
<span id="id-of-events"></span><h2>ID of Events<a class="headerlink" href="#scevent-eventid" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>The ID of an event or eventID uniquely identifies an event. The ID is derived from
 | 
						||
the time of occurrence of the event within a year. As configured by <a class="reference internal" href="#confval-eventIDPattern"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventIDPattern</span></code></a>
 | 
						||
it typically consists of a prefix configured by <a class="reference internal" href="#confval-eventIDPrefix"><code class="xref std std-confval docutils literal notranslate"><span class="pre">eventIDPrefix</span></code></a> and a
 | 
						||
string containing the year and a set of characters or numbers defining the time.</p>
 | 
						||
</section>
 | 
						||
<section id="journals">
 | 
						||
<span id="scevent-journals"></span><h2>Journals<a class="headerlink" href="#journals" title="Permalink to this heading">¶</a></h2>
 | 
						||
<p>scevent can be commanded by journals to do a certain action. Journal entries are being
 | 
						||
received via the messaging bus to any of the subscribed groups. A journal entry
 | 
						||
contains an action, a subject (a publicID of an object) and optional parameters.
 | 
						||
Journals can be interactively sent to the messaging by <a class="reference internal" href="scsendjournal.html#scsendjournal"><span class="std std-ref">scsendjournal</span></a>.</p>
 | 
						||
<p>If scevent has handled an action, it will send a reply journal entry with
 | 
						||
an action formed from the origin action name plus <strong>OK</strong> or <strong>Failed</strong>. The
 | 
						||
parameters of the journal entry contain a possible reason.</p>
 | 
						||
<p>The following actions are supported by scevent:</p>
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvGrabOrg">
 | 
						||
<span class="sig-name descname"><span class="pre">EvGrabOrg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvGrabOrg" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Grabs an origin and associates it to the given event. If the origin is
 | 
						||
already associated with another event then its reference to this event
 | 
						||
will be removed.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The ID of the origin to be grabbed</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvMerge">
 | 
						||
<span class="sig-name descname"><span class="pre">EvMerge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvMerge" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Merges an event (source) into another event (target). After successful
 | 
						||
completion the source event will be deleted.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event (target)</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The ID of an existing event (source)</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvName">
 | 
						||
<span class="sig-name descname"><span class="pre">EvName</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvName" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Adds or updates the event description with type “earthquake name”.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – An event name</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvNewEvent">
 | 
						||
<span class="sig-name descname"><span class="pre">EvNewEvent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvNewEvent" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Creates a new event based on a given origin. The origin must not yet be
 | 
						||
associated with another event.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The origin publicID of the origin which will be used to
 | 
						||
create the new event.</p></li>
 | 
						||
<li><p><strong>parameters</strong> – Unused</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvOpComment">
 | 
						||
<span class="sig-name descname"><span class="pre">EvOpComment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvOpComment" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Adds or updates the event comment text with id “Operator”.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The comment text</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefFocMecID">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefFocMecID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefFocMecID" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the preferred focal mechanism ID of an event. If a focal mechanism ID
 | 
						||
is passed then it will be fixed as preferred solution for this event and
 | 
						||
any subsequent focal mechanism associations will not cause a change of the
 | 
						||
preferred focal mechanism.</p>
 | 
						||
<p>If an empty focal mechanism ID is passed then this is considered as “unfix”
 | 
						||
and scevent will switch back to automatic preferred selection mode.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The focal mechanism ID which will become preferred or empty.</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefMagType">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefMagType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefMagType" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Set the preferred magnitude of the event matching the requested magnitude
 | 
						||
type.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The desired preferred magnitude type</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefMw">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefMw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefMw" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the moment magnitude (Mw) of the preferred focal mechanism as
 | 
						||
preferred magnitude of the event.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – Boolean flag, either “true” or “false”</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefOrgAutomatic">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefOrgAutomatic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefOrgAutomatic" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Releases the fixed origin constraint. This call is equal to <code class="code docutils literal notranslate"><span class="pre">EvPrefOrgID(eventID,</span> <span class="pre">'')</span></code>.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – Unused</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefOrgEvalMode">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefOrgEvalMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefOrgEvalMode" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the preferred origin based on an evaluation mode. The configured
 | 
						||
priorities are still valid. If an empty evaluation mode is passed then
 | 
						||
scevent releases this constraint.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The evaluation mode (“automatic”, “manual”) or empty</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvPrefOrgID">
 | 
						||
<span class="sig-name descname"><span class="pre">EvPrefOrgID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvPrefOrgID" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the preferred origin ID of an event. If an origin ID is passed then
 | 
						||
it will be fixed as preferred solution for this event and any subsequent
 | 
						||
origin associations will not cause a change of the preferred origin.</p>
 | 
						||
<p>If an empty origin ID is passed then this is considered as “unfix” and
 | 
						||
scevent will switch back to automatic preferred selection mode.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The origin ID which will become preferred or empty.</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvRefresh">
 | 
						||
<span class="sig-name descname"><span class="pre">EvRefresh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvRefresh" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Refreshes the event information. This operation can be useful if the
 | 
						||
configured fep region files have changed on disc and scevent should
 | 
						||
update the region information. Changed plugin parameters can be another
 | 
						||
reason to refresh the event status.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – Unused</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvSplitOrg">
 | 
						||
<span class="sig-name descname"><span class="pre">EvSplitOrg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvSplitOrg" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Remove an origin reference from an event and create a new event for
 | 
						||
this origin.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event holding a reference to the
 | 
						||
given origin ID.</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The ID of the origin to be split</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvType">
 | 
						||
<span class="sig-name descname"><span class="pre">EvType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvType" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the event type to the passed value.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The event type</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="py function">
 | 
						||
<dt class="sig sig-object py" id="EvTypeCertainty">
 | 
						||
<span class="sig-name descname"><span class="pre">EvTypeCertainty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">objectID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#EvTypeCertainty" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Sets the event type certainty to the passed value.</p>
 | 
						||
<dl class="field-list simple">
 | 
						||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 | 
						||
<dd class="field-odd"><ul class="simple">
 | 
						||
<li><p><strong>objectID</strong> – The ID of an existing event</p></li>
 | 
						||
<li><p><strong>parameters</strong> – The event type certainty</p></li>
 | 
						||
</ul>
 | 
						||
</dd>
 | 
						||
</dl>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
</section>
 | 
						||
<section id="plugins">
 | 
						||
<h2>Plugins<a class="headerlink" href="#plugins" title="Permalink to this heading">¶</a></h2>
 | 
						||
<ul>
 | 
						||
<li><p><a class="reference internal" href="scevent_eventtype.html#scevent-eventtype"><span class="std std-ref">EventType</span></a></p>
 | 
						||
<p>evtype plugin for scevent</p>
 | 
						||
</li>
 | 
						||
<li><p><a class="reference internal" href="scevent_regioncheck.html#scevent-regioncheck"><span class="std std-ref">RegionCheck</span></a></p>
 | 
						||
<p>evrc plugin for scevent</p>
 | 
						||
</li>
 | 
						||
</ul>
 | 
						||
</section>
 | 
						||
<section id="module-configuration">
 | 
						||
<span id="scevent-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/scevent.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/scevent.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/scevent.cfg</span></code></div>
 | 
						||
</div>
 | 
						||
<p>scevent 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-eventIDPrefix">
 | 
						||
<span class="sig-name descname"><span class="pre">eventIDPrefix</span></span><a class="headerlink" href="#confval-eventIDPrefix" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Type: <em>string</em></p>
 | 
						||
<p>Prefix for all Event IDs</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventIDPattern">
 | 
						||
<span class="sig-name descname"><span class="pre">eventIDPattern</span></span><a class="headerlink" href="#confval-eventIDPattern" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">%p%Y%04c</span></code></p>
 | 
						||
<p>Type: <em>string</em></p>
 | 
						||
<p>Defines the pattern to generate an event ID.</p>
 | 
						||
<p>%p : prefix</p>
 | 
						||
<p>%Y : year</p>
 | 
						||
<p>%[w]c: alpha character</p>
 | 
						||
<p>%[w]C: upper case alpha character</p>
 | 
						||
<p>%[w]d: decimal</p>
 | 
						||
<p>%[w]x: hexadecimal</p>
 | 
						||
<p>%[w]X: upper case hexadecimal</p>
 | 
						||
<p>[w] is an optional width parameter.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<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>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
 | 
						||
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
 | 
						||
the given time ranges for event association.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-populateFERegion">
 | 
						||
<span class="sig-name descname"><span class="pre">populateFERegion</span></span><a class="headerlink" href="#confval-populateFERegion" 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 enabled, then the EventDescription with type
 | 
						||
‘Flinn-Engdahl region’ will be populated with the
 | 
						||
Flinn-Engdahl region name.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<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
 | 
						||
candidates.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-processing.blacklist.eventIDs">
 | 
						||
<span class="sig-name descname"><span class="pre">processing.blacklist.eventIDs</span></span><a class="headerlink" href="#confval-processing.blacklist.eventIDs" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Type: <em>list:string</em></p>
 | 
						||
<p>Defines a list of event ID patterns to be blocked. The
 | 
						||
items of this list are only matched against %c, %C, %d,
 | 
						||
%x and %X of the eventIDPattern description. Year (%Y)
 | 
						||
and prefix (%p) are not matched. The match is
 | 
						||
case-sensitive, so ‘abcd’ would only by blocked in
 | 
						||
combination with %c. If %C is used, ‘ABCD’ is matched.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<div class="admonition note">
 | 
						||
<p class="admonition-title">Note</p>
 | 
						||
<p><strong>eventAssociation.*</strong>
 | 
						||
<em>Criteria defining if Origins are associated to an event</em>
 | 
						||
<em>and which Origins and magnitudes become preferred.</em></p>
 | 
						||
</div>
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.minimumDefiningPhases">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.minimumScore">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.minimumScore</span></span><a class="headerlink" href="#confval-eventAssociation.minimumScore" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Type: <em>double</em></p>
 | 
						||
<p>Minimum score of an automatic Origin to be allowed to
 | 
						||
form an new Event. This requires an activated score
 | 
						||
plugin and a score processor. Configure "score"
 | 
						||
for defining the score processor and the score processor
 | 
						||
parameters. If minimumScore is defined, "minimumDefiningPhases"
 | 
						||
has no effect on association as this phase check will be
 | 
						||
superseded by the score check. It is the task of the score
 | 
						||
processor to evaluate a proper score for all input Origins.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.ignoreFMDerivedOrigins">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.ignoreFMDerivedOrigins</span></span><a class="headerlink" href="#confval-eventAssociation.ignoreFMDerivedOrigins" 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>Ignore and do not associate Origins derived
 | 
						||
from CMT/MT inversions.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.eventTimeBefore">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.eventTimeBefore</span></span><a class="headerlink" href="#confval-eventAssociation.eventTimeBefore" title="Permalink to this definition">¶</a></dt>
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.eventTimeAfter">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.eventTimeAfter</span></span><a class="headerlink" href="#confval-eventAssociation.eventTimeAfter" title="Permalink to this definition">¶</a></dt>
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.minimumMatchingArrivals">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.maximumMatchingArrivalTimeDiff">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.maximumMatchingArrivalTimeDiff</span></span><a class="headerlink" href="#confval-eventAssociation.maximumMatchingArrivalTimeDiff" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-1</span></code></p>
 | 
						||
<p>Type: <em>double</em></p>
 | 
						||
<p>Unit: <em>s</em></p>
 | 
						||
<p>Negative time window: compare only pickIDs to find
 | 
						||
matching arrivals. A non negative
 | 
						||
value (including 0) compares pick times regardless
 | 
						||
of the pickID. Pass: |pick1.time - pick2.time| <= threshold</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.compareAllArrivalTimes">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.compareAllArrivalTimes</span></span><a class="headerlink" href="#confval-eventAssociation.compareAllArrivalTimes" 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>This parameter is only used in conjunction with
 | 
						||
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
 | 
						||
or if one matching arrival is enough.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.allowLooseAssociatedArrivals">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.allowLooseAssociatedArrivals</span></span><a class="headerlink" href="#confval-eventAssociation.allowLooseAssociatedArrivals" 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>Allows to match picks that are associated with weight 0.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.maximumTimeSpan">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.maximumTimeSpan</span></span><a class="headerlink" href="#confval-eventAssociation.maximumTimeSpan" title="Permalink to this definition">¶</a></dt>
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.maximumDistance">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.maximumDistance</span></span><a class="headerlink" href="#confval-eventAssociation.maximumDistance" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">5</span></code></p>
 | 
						||
<p>Type: <em>double</em></p>
 | 
						||
<p>Unit: <em>degrees</em></p>
 | 
						||
<p>Allowed location difference between an incoming Origin compared with
 | 
						||
preferred Origins to get associated.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.magTypes">
 | 
						||
<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>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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.minimumMagnitudes">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.minMwCount">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.mbOverMwCount">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.mbOverMwValue">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.magPriorityOverStationCount">
 | 
						||
<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
 | 
						||
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
 | 
						||
which is only taken into account if two magnitudes have the
 | 
						||
same priority.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<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>
 | 
						||
<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>
 | 
						||
</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>
 | 
						||
</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>
 | 
						||
</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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.score">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.declareFakeEventForRejectedOrigin">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.declareFakeEventForRejectedOrigin</span></span><a class="headerlink" href="#confval-eventAssociation.declareFakeEventForRejectedOrigin" 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 the preferred Origin has evaluation status ‘rejected’, the
 | 
						||
Event type will be set to ‘not existing’ unless the Event
 | 
						||
type has been fixed by an operator or the preferred Origin
 | 
						||
has been fixed.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<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>
 | 
						||
<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>
 | 
						||
</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>
 | 
						||
</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></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.region.minDepth">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.region.maxDepth">
 | 
						||
<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>
 | 
						||
</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>
 | 
						||
</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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventAssociation.delayFilter.author">
 | 
						||
<span class="sig-name descname"><span class="pre">eventAssociation.delayFilter.author</span></span><a class="headerlink" href="#confval-eventAssociation.delayFilter.author" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Type: <em>string</em></p>
 | 
						||
<p>The author of the Origin to be delayed.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<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>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<section id="eventtype-extension">
 | 
						||
<span id="scevent-eventtype"></span><h3>EventType extension<a class="headerlink" href="#eventtype-extension" title="Permalink to this heading">¶</a></h3>
 | 
						||
<p>evtype plugin for scevent</p>
 | 
						||
<div class="admonition note">
 | 
						||
<p class="admonition-title">Note</p>
 | 
						||
<p><strong>eventType.*</strong>
 | 
						||
<em>Set the event type based on type comments of picks. Add the</em>
 | 
						||
<em>plugin “evtype” to the list of plugins in the order</em>
 | 
						||
<em>of priority to make this feature available.</em></p>
 | 
						||
</div>
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventType.setEventType">
 | 
						||
<span class="sig-name descname"><span class="pre">eventType.setEventType</span></span><a class="headerlink" href="#confval-eventType.setEventType" 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>Allow setting the event type.
 | 
						||
The type of events which have manual origins will
 | 
						||
not be changed unless configured explicitely by
 | 
						||
"overwriteManual".</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventType.overwriteEventType">
 | 
						||
<span class="sig-name descname"><span class="pre">eventType.overwriteEventType</span></span><a class="headerlink" href="#confval-eventType.overwriteEventType" 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 overwriting existing event types set by other modules.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventType.overwriteManual">
 | 
						||
<span class="sig-name descname"><span class="pre">eventType.overwriteManual</span></span><a class="headerlink" href="#confval-eventType.overwriteManual" 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>Allow setting the event type if the mode of the preferred
 | 
						||
origin is manual or if the event type was set manually.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-eventType.pickCommentIDs">
 | 
						||
<span class="sig-name descname"><span class="pre">eventType.pickCommentIDs</span></span><a class="headerlink" href="#confval-eventType.pickCommentIDs" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">scrttv:eventTypeHint,deepc:eventTypeHint</span></code></p>
 | 
						||
<p>Type: <em>list:string</em></p>
 | 
						||
<p>Consider comments of picks which have one of the
 | 
						||
given values. An empty list disables setting the type.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
</section>
 | 
						||
<section id="regioncheck-extension">
 | 
						||
<span id="scevent-regioncheck"></span><h3>RegionCheck extension<a class="headerlink" href="#regioncheck-extension" title="Permalink to this heading">¶</a></h3>
 | 
						||
<p>evrc plugin for scevent</p>
 | 
						||
<div class="admonition note">
 | 
						||
<p class="admonition-title">Note</p>
 | 
						||
<p><strong>rc.*</strong>
 | 
						||
<em>Test if events lie within or outside geographic regions defined</em>
 | 
						||
<em>by polygons.</em>
 | 
						||
<em>Events within a region are flagged as positive, outside as negative.</em>
 | 
						||
<em>The event type is set accordingly. Add the</em>
 | 
						||
<em>plugin “evrc” to the plugins parameter in the</em>
 | 
						||
<em>order of priority to make this feature available. Read the</em>
 | 
						||
<em>documentation of the RegionCheck for more details.</em></p>
 | 
						||
</div>
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.setEventType">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.setEventType</span></span><a class="headerlink" href="#confval-rc.setEventType" 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 setting the event type.
 | 
						||
The type of events which have manual origins will
 | 
						||
not be changed unless configured explicitely by
 | 
						||
"overwriteManual".</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.overwriteEventType">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.overwriteEventType</span></span><a class="headerlink" href="#confval-rc.overwriteEventType" 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 overwriting existing event types. Disabling does not
 | 
						||
allow accounting for changes in source region.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.overwriteManual">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.overwriteManual</span></span><a class="headerlink" href="#confval-rc.overwriteManual" 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>Allow setting the event type if the mode of the preferred
 | 
						||
origin is manual or if the event type was set manually.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.regions">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.regions</span></span><a class="headerlink" href="#confval-rc.regions" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">!reject</span></code></p>
 | 
						||
<p>Type: <em>list:string</em></p>
 | 
						||
<p>The list of closed polygon names defining regions for
 | 
						||
flagging event as positive or negative.
 | 
						||
A polygon name defines a positive region but names with
 | 
						||
prefix !  (exclamation mark) define negative regions.
 | 
						||
Evaluation is done in the order of the polygons. The last
 | 
						||
matching criteria applies and the event type is set
 | 
						||
accordingly.</p>
 | 
						||
<p>Default: If events are not positive or are negative regions
 | 
						||
the event type is set to "outside of network
 | 
						||
interest". Default:
 | 
						||
"!reject", use "accecpt" to overwrite
 | 
						||
the default.</p>
 | 
						||
<p>Examples:</p>
 | 
						||
<p>Events are flagged positive within the polygon
 | 
						||
"germany":</p>
 | 
						||
<p>germany</p>
 | 
						||
<p>All events are flagged positive but events within the
 | 
						||
polygon "quarries" are negative:</p>
 | 
						||
<p>accept,!quarries</p>
 | 
						||
<p>Events within the polygon "germany" are flagged
 | 
						||
positive but all other events and events within the polygon
 | 
						||
"quarries" are negaitve:</p>
 | 
						||
<p>germany,!quarries</p>
 | 
						||
<p>All events are flagged positive but events within the
 | 
						||
polygon "germany" are negative and all events
 | 
						||
within the polygon "saxony" are positive:</p>
 | 
						||
<p>accept,!germany,saxony</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.readEventTypeFromBNA">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.readEventTypeFromBNA</span></span><a class="headerlink" href="#confval-rc.readEventTypeFromBNA" 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>Consider the event type, minDepth and maxDepth values from
 | 
						||
the polygons defined by GeoJSON or BNA files. Read the
 | 
						||
documentation of the RegionCheck plugin for the details.</p>
 | 
						||
<p>When eventType is defined in the polygons, the value
 | 
						||
supersedes values of ‘eventTypePositive’ and
 | 
						||
‘eventTypeNegative’.
 | 
						||
If not set, ‘eventTypePositive’ and ‘eventTypeNegative’ are
 | 
						||
considered.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.eventTypePositive">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.eventTypePositive</span></span><a class="headerlink" href="#confval-rc.eventTypePositive" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Type: <em>string</em></p>
 | 
						||
<p>New type of an event which is flagged positive. Ignored
 | 
						||
if ‘readEventTypeFromBNA’ is active and the polygons
 | 
						||
define eventType.</p>
 | 
						||
<p>Empty: Do not set type.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<dl class="std confval">
 | 
						||
<dt class="sig sig-object std" id="confval-rc.eventTypeNegative">
 | 
						||
<span class="sig-name descname"><span class="pre">rc.eventTypeNegative</span></span><a class="headerlink" href="#confval-rc.eventTypeNegative" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">"outside</span> <span class="pre">of</span> <span class="pre">network</span> <span class="pre">interest"</span></code></p>
 | 
						||
<p>Type: <em>string</em></p>
 | 
						||
<p>New type of an event which is flagged negative. Ignored
 | 
						||
if ‘readEventTypeFromBNA’ is active and the polygons
 | 
						||
define eventType.</p>
 | 
						||
<p>Empty means default: "outside of network interest"</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
</section>
 | 
						||
</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-scevent-h">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-V">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-D">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-x">
 | 
						||
<span id="cmdoption-scevent-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-scevent-x" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Time span in hours after which objects expire.</p>
 | 
						||
</dd></dl>
 | 
						||
 | 
						||
<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.
 | 
						||
Only the status of the association is written to stdout.</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-scevent-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-scevent-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-scevent-v">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-q">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-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-scevent-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-scevent-s">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-l">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-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-scevent-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-scevent-debug">
 | 
						||
<span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-scevent-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-scevent-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-scevent-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-scevent-u">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-H">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-t">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-g">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-S">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-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></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-scevent-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-scevent-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-scevent-d">
 | 
						||
<span id="cmdoption-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-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-scevent-db-disable" title="Permalink to this definition">¶</a></dt>
 | 
						||
<dd><p>Do not use the database at all</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="#">scevent</a><ul>
 | 
						||
<li><a class="reference internal" href="#description">Description</a></li>
 | 
						||
<li><a class="reference internal" href="#origin-association">Origin Association</a><ul>
 | 
						||
<li><a class="reference internal" href="#origin-match">Origin match</a></li>
 | 
						||
<li><a class="reference internal" href="#no-origin-match">No origin match</a></li>
 | 
						||
</ul>
 | 
						||
</li>
 | 
						||
<li><a class="reference internal" href="#preferred-origin">Preferred Origin</a></li>
 | 
						||
<li><a class="reference internal" href="#preferred-magnitude">Preferred Magnitude</a></li>
 | 
						||
<li><a class="reference internal" href="#preferred-focal-mechanism">Preferred Focal Mechanism</a></li>
 | 
						||
<li><a class="reference internal" href="#scevent-eventid">ID of Events</a></li>
 | 
						||
<li><a class="reference internal" href="#journals">Journals</a><ul>
 | 
						||
<li><a class="reference internal" href="#EvGrabOrg"><code class="docutils literal notranslate"><span class="pre">EvGrabOrg()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvMerge"><code class="docutils literal notranslate"><span class="pre">EvMerge()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvName"><code class="docutils literal notranslate"><span class="pre">EvName()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvNewEvent"><code class="docutils literal notranslate"><span class="pre">EvNewEvent()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvOpComment"><code class="docutils literal notranslate"><span class="pre">EvOpComment()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefFocMecID"><code class="docutils literal notranslate"><span class="pre">EvPrefFocMecID()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefMagType"><code class="docutils literal notranslate"><span class="pre">EvPrefMagType()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefMw"><code class="docutils literal notranslate"><span class="pre">EvPrefMw()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefOrgAutomatic"><code class="docutils literal notranslate"><span class="pre">EvPrefOrgAutomatic()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefOrgEvalMode"><code class="docutils literal notranslate"><span class="pre">EvPrefOrgEvalMode()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvPrefOrgID"><code class="docutils literal notranslate"><span class="pre">EvPrefOrgID()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvRefresh"><code class="docutils literal notranslate"><span class="pre">EvRefresh()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvSplitOrg"><code class="docutils literal notranslate"><span class="pre">EvSplitOrg()</span></code></a></li>
 | 
						||
<li><a class="reference internal" href="#EvType"><code class="docutils literal notranslate"><span class="pre">EvType()</span></code></a></li>
 | 
						||
<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="#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>
 | 
						||
<li><a class="reference internal" href="#regioncheck-extension">RegionCheck extension</a></li>
 | 
						||
</ul>
 | 
						||
</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>
 | 
						||
</ul>
 | 
						||
</li>
 | 
						||
</ul>
 | 
						||
</li>
 | 
						||
</ul>
 | 
						||
 | 
						||
  </div>
 | 
						||
  <div>
 | 
						||
    <h4>Previous topic</h4>
 | 
						||
    <p class="topless"><a href="scautopick.html"
 | 
						||
                          title="previous chapter">scautopick</a></p>
 | 
						||
  </div>
 | 
						||
  <div>
 | 
						||
    <h4>Next topic</h4>
 | 
						||
    <p class="topless"><a href="scmag.html"
 | 
						||
                          title="next chapter">scmag</a></p>
 | 
						||
  </div>
 | 
						||
  <div role="note" aria-label="source link">
 | 
						||
    <h3>This Page</h3>
 | 
						||
    <ul class="this-page-menu">
 | 
						||
      <li><a href="../_sources/apps/scevent.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.1</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> |