354 lines
22 KiB
HTML
354 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>LocRouter — 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="RecordStream" href="global_recordstream.html" />
|
|
<link rel="prev" title="LocExt" href="global_locext.html" />
|
|
</head>
|
|
<body>
|
|
<div class="header">
|
|
<div class="container">
|
|
<div class="brand">
|
|
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
|
<!-- span class="title">SeisComP Release</span -->
|
|
<span class="version">6.9.0</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="nav">
|
|
<div class="container">
|
|
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<ul>
|
|
<li class="right">
|
|
<a href="../genindex.html" title="General Index"
|
|
accesskey="I">
|
|
index
|
|
</a>
|
|
</li>
|
|
<li class="right">
|
|
<a href="global_recordstream.html" title="RecordStream"
|
|
accesskey="N">
|
|
next
|
|
</a>
|
|
</li>
|
|
<li class="right">
|
|
<a href="global_locext.html" title="LocExt"
|
|
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="../toc/extensions.html" >Extensions</a>
|
|
</li>
|
|
<li class="nav-item nav-item-2">
|
|
<a href="../toc/extensions/global.html" accesskey="U">global</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container">
|
|
<div class="fitted content" id="anchors-container">
|
|
<div class="body" role="main">
|
|
|
|
<section id="locrouter">
|
|
<span id="global-locrouter"></span><h1>LocRouter<a class="headerlink" href="#locrouter" title="Permalink to this heading">¶</a></h1>
|
|
<p>Meta locator routing location requests of picks and origins to actual
|
|
locator implementations.</p>
|
|
<section id="description">
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
|
<p>Router is a meta locator which selects an actual
|
|
<a class="reference internal" href="../base/concepts/locators.html#concepts-locators"><span class="std std-ref">locator</span></a> based on region profiles configured in
|
|
GeoJSON or BNA files.</p>
|
|
<p>The locator supports both, the initial location based on a pick set and the
|
|
relocation based on an existing origin. In case no origin is available an
|
|
initial solution is calculated by a configurable locator followed by a
|
|
relocation configured through region profiles.</p>
|
|
</section>
|
|
<section id="setup">
|
|
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this heading">¶</a></h2>
|
|
<p>The Router locator offers configuration by global module parameters.</p>
|
|
<section id="plugin">
|
|
<h3>Plugin<a class="headerlink" href="#plugin" title="Permalink to this heading">¶</a></h3>
|
|
<p>Add the plugin <code class="docutils literal notranslate"><span class="pre">locrouter</span></code> to <a class="reference internal" href="global.html#confval-plugins"><code class="xref std std-confval docutils literal notranslate"><span class="pre">plugins</span></code></a> for activating the Router
|
|
locator. Example:</p>
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">plugins</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="si">${</span><span class="nv">plugins</span><span class="si">}</span>,locrouter
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
<section id="initial-locator">
|
|
<h3>Initial locator<a class="headerlink" href="#initial-locator" title="Permalink to this heading">¶</a></h3>
|
|
<p>For routing, an initial source location is required. When only picks but no
|
|
origins are provided, the initial location is unknown but it can be defined by
|
|
an initial locator independent of location. Set
|
|
<a class="reference internal" href="#confval-RouterLocator.initial.locator"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.initial.locator</span></code></a> and
|
|
<a class="reference internal" href="#confval-RouterLocator.initial.profile"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.initial.profile</span></code></a> for defining the initial locator.</p>
|
|
</section>
|
|
<section id="region-configuration">
|
|
<h3>Region Configuration<a class="headerlink" href="#region-configuration" title="Permalink to this heading">¶</a></h3>
|
|
<p>Regions may be considered by configuring their names in
|
|
<a class="reference internal" href="#confval-RouterLocator.regions"><code class="xref std std-confval docutils literal notranslate"><span class="pre">RouterLocator.regions</span></code></a>. The regions themselves are defined as polygons
|
|
files in either <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-geojson"><span class="std std-ref">GeoJSON</span></a> or
|
|
<a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-bna"><span class="std std-ref">BNA</span></a> format. Supported polygon
|
|
attributes are:</p>
|
|
<ul class="simple">
|
|
<li><p>name (recommended): Name of polygon. An empty string is assumed if not given.</p></li>
|
|
<li><p>locator (mandatory): Name of the locator interface to use.</p></li>
|
|
<li><p>profile: Name of the locator-specific profile which must be configured
|
|
according to the selected locator.</p></li>
|
|
<li><p>minDepth: Minimum depth in km the profile should be applied to.</p></li>
|
|
<li><p>maxDepth: Maximum depth in km the profile should be applied to.</p></li>
|
|
</ul>
|
|
<p>The configured features are sorted by rank and area. Larger ranks and smaller
|
|
areas are prioritized.</p>
|
|
<p>Example <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-geojson"><span class="std std-ref">GeoJSON file</span></a>:</p>
|
|
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FeatureCollection"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"features"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Feature"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Iceland"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"minDepth"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"maxDepth"</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"locator"</span><span class="p">:</span><span class="w"> </span><span class="s2">"LOCSAT"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"profile"</span><span class="p">:</span><span class="w"> </span><span class="s2">"iceland"</span>
|
|
<span class="w"> </span><span class="p">},</span>
|
|
<span class="w"> </span><span class="nt">"geometry"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Polygon"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"coordinates"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mf">-13.4958</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mf">-13.4958</span><span class="p">,</span><span class="w"> </span><span class="mf">66.5667</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">66.5667</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mf">-24.5469</span><span class="p">,</span><span class="w"> </span><span class="mf">63.3967</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="p">},</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Feature"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"World"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"locator"</span><span class="p">:</span><span class="w"> </span><span class="s2">"LOCSAT"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"profile"</span><span class="p">:</span><span class="w"> </span><span class="s2">"iasp91"</span>
|
|
<span class="w"> </span><span class="p">},</span>
|
|
<span class="w"> </span><span class="nt">"geometry"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Polygon"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"coordinates"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">-180</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">-180</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">180</span><span class="p">,</span><span class="w"> </span><span class="mi">-90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">180</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="mi">-33</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="p">]</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Example <a class="reference internal" href="global_gui.html#sec-gui-layers-vector-format-bna"><span class="std std-ref">BNA file</span></a>:</p>
|
|
<div class="highlight-properties notranslate"><div class="highlight"><pre><span></span><span class="na">"Iceland",</span><span class="w"> </span><span class="s">"rank 1", "minDepth: 0, maxDepth: 30, locator: LOCSAT, profile: iceland", 4</span>
|
|
<span class="na">-24.5469,</span><span class="w"> </span><span class="s">63.3967</span>
|
|
<span class="na">-13.4958,</span><span class="w"> </span><span class="s">63.3967</span>
|
|
<span class="na">-13.4958,</span><span class="w"> </span><span class="s">66.5667</span>
|
|
<span class="na">-24.5469,</span><span class="w"> </span><span class="s">66.5667</span>
|
|
<span class="na">"World",</span><span class="w"> </span><span class="s">"rank 1", "locator: LOCSAT, profile: iasp91", 8</span>
|
|
<span class="na">-33,</span><span class="w"> </span><span class="s">90</span>
|
|
<span class="na">-180,</span><span class="w"> </span><span class="s">90</span>
|
|
<span class="na">-180,</span><span class="w"> </span><span class="s">-90</span>
|
|
<span class="na">-33,</span><span class="w"> </span><span class="s">-90</span>
|
|
<span class="na">33,</span><span class="w"> </span><span class="s">-90</span>
|
|
<span class="na">180,</span><span class="w"> </span><span class="s">-90</span>
|
|
<span class="na">180,</span><span class="w"> </span><span class="s">90</span>
|
|
<span class="na">33,</span><span class="w"> </span><span class="s">90</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="application">
|
|
<h2>Application<a class="headerlink" href="#application" title="Permalink to this heading">¶</a></h2>
|
|
<p>Once configured, the Router locator may be used by other <cite>SeisComP</cite> modules such
|
|
as <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or <a class="reference internal" href="screloc.html#screloc"><span class="std std-ref">screloc</span></a>. Refer to the locator as “Router”.</p>
|
|
</section>
|
|
<section id="module-configuration">
|
|
<span id="global-locrouter-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p><strong>RouterLocator.*</strong>
|
|
<em>Locator parameters: Router. This locator requires the plugin</em>
|
|
<em>“locrouter” to be loaded.</em></p>
|
|
</div>
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-RouterLocator.regions">
|
|
<span class="sig-name descname"><span class="pre">RouterLocator.regions</span></span><a class="headerlink" href="#confval-RouterLocator.regions" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>A GeoJSON or BNA file defining locator profiles by region.
|
|
Supported polygon attributes:</p>
|
|
<p>name: Name of polygon</p>
|
|
<p>locator: Name of the locator interface</p>
|
|
<p>profile: Name of the locator specific profile</p>
|
|
<p>minDepth: Minimum depth in km</p>
|
|
<p>maxDepth: Minimum depth in km</p>
|
|
</dd></dl>
|
|
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p><strong>RouterLocator.initial.*</strong>
|
|
<em>Configuration of initial locator used to create an</em>
|
|
<em>initial solution based on a pick set. If a solution is</em>
|
|
<em>found, relocate of the actual locator configured in the</em>
|
|
<em>region file is invoked.</em></p>
|
|
</div>
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-RouterLocator.initial.locator">
|
|
<span class="sig-name descname"><span class="pre">RouterLocator.initial.locator</span></span><a class="headerlink" href="#confval-RouterLocator.initial.locator" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>Name of the initial locator interface, e.g., LOCSAT.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="std confval">
|
|
<dt class="sig sig-object std" id="confval-RouterLocator.initial.profile">
|
|
<span class="sig-name descname"><span class="pre">RouterLocator.initial.profile</span></span><a class="headerlink" href="#confval-RouterLocator.initial.profile" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Type: <em>string</em></p>
|
|
<p>Profile name of the initial locator, e.g., iasp91.</p>
|
|
</dd></dl>
|
|
|
|
</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="#">LocRouter</a><ul>
|
|
<li><a class="reference internal" href="#description">Description</a></li>
|
|
<li><a class="reference internal" href="#setup">Setup</a><ul>
|
|
<li><a class="reference internal" href="#plugin">Plugin</a></li>
|
|
<li><a class="reference internal" href="#initial-locator">Initial locator</a></li>
|
|
<li><a class="reference internal" href="#region-configuration">Region Configuration</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#application">Application</a></li>
|
|
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="global_locext.html"
|
|
title="previous chapter">LocExt</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="global_recordstream.html"
|
|
title="next chapter">RecordStream</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/apps/global_locrouter.rst.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<div class="horizontal layout content">
|
|
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
|
<img class="brand" src="../_static/brands/gempa.svg"/>
|
|
</a>
|
|
<div class="stretched align-center fitted content">
|
|
<div>
|
|
Version <b>6.9.0</b> Release
|
|
</div>
|
|
<div class="copyright">
|
|
Copyright © gempa GmbH, GFZ Potsdam.
|
|
</div>
|
|
</div>
|
|
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
|
<img class="brand" src="../_static/brands/gfz.svg"/>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |