benjamin
/
seiscomp-training
1
0
Fork 0
Code Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '906e9ccf6b'
${ noResults }
seiscomp-training/share/doc/seiscomp/html/apps/scheli.html

858 lines
45 KiB
HTML
Raw Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>scheli &#8212; SeisComP Release documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<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 src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="scmm" href="scmm.html" />
<link rel="prev" title="scesv" href="scesv.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">5.3.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="scmm.html" title="scmm"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scesv.html" title="scesv"
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="../gui.html" accesskey="U">Graphical User Interfaces</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="scheli">
<span id="id1"></span><h1>scheli<a class="headerlink" href="#scheli" title="Permalink to this headline"></a></h1>
<p><strong>Real-time helicorder view for one stream.</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p><strong class="program">scheli</strong> visualizes waveforms from a single stream or multiple stations
mimicking a drum-recorder plot (see <a class="reference internal" href="#fig-scheli"><span class="std std-ref">scheli in GUI mode</span></a>):</p>
<ul class="simple">
<li><p><strong class="program">scheli</strong> plots one configurable trace in helicorder style in the
<a class="reference internal" href="../base/glossary.html#term-gui"><span class="xref std std-term">GUI</span></a> (<a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a>).</p></li>
<li><p>Configurable GUI: trace colors, visualized time spans, number of rows, data filtering,
amplitude ranges and much more.</p></li>
<li><p>Automatic image capturing: Capture helicorder images at configurable time intervals
of one trace in <a class="reference internal" href="#scheli-show"><span class="std std-ref">GUI mode</span></a> or a set of multiple channels in
<a class="reference internal" href="#scheli-capture"><span class="std std-ref">capture mode</span></a>.
The images can be used, e.g. for showing data images on web sites.</p></li>
</ul>
<div class="figure align-center" id="id3">
<span id="fig-scheli"></span><a class="reference internal image-reference" href="../_images/scheli.png"><img alt="../_images/scheli.png" src="../_images/scheli.png" style="width: 16cm;" /></a>
<p class="caption"><span class="caption-text">scheli in GUI mode</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<ol class="arabic" id="scheli-show">
<li><p><strong>GUI mode - Simple helicorder window:</strong></p>
<ul>
<li><p>Learn about the plenty command-line options for <strong class="program">scheli</strong>:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli -h
</pre></div>
</div>
</li>
<li><p>Start <strong class="program">scheli</strong> with the configured values and informative debug output:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --debug
</pre></div>
</div>
</li>
<li><p>Let <strong class="program">scheli</strong> show data from the CX station PB01 for the previous 5 hours
overriding configuration by command-line paramaters:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli --stream CX.PB01..HHZ --rows <span class="m">10</span>
</pre></div>
</div>
</li>
<li><p>Define the data request window by end time and duration; scale traces to the
maximum amplitude per row:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>scheli --stream IU.TSUM.00.BHZ --end-time &quot;2021-04-22 14:00:00&quot; --time-span 600 --amp-scaling row
</pre></div>
</div>
</li>
</ul>
</li>
</ol>
<ol class="arabic" id="scheli-capture" start="2">
<li><p><strong>Capture mode - Image capturing:</strong></p>
<p>Capture the helicorder plot for 3 stations in intervals of 10 seconds.
The data is retrieved using seedlink and the plots are stored as PNG images.
The image files are named according to network, station, stream and location codes
of the requested stations. Command-line parameters override the module configuration.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scheli capture --stream CX.PB01..HHZ --stream CX.PB02..HHZ --stream CX.PB04..HHZ --interval <span class="m">10</span> -o <span class="s2">&quot;/tmp/heli_%N_%S_%L_%C.png&quot;</span> -H localhost -I slink://localhost
</pre></div>
</div>
<p>The output file names will be generated based on network code (%N), station code (%S),
location code (%L) and stream code (%C):</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>/tmp/CX.PB01..HHZ.png
/tmp/CX.PB02..HHZ.png
/tmp/CX.PB04..HHZ.png
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h2>
<p>Specifc <strong class="program">scheli</strong> parameters are adjusted in the <a class="reference internal" href="#scheli-configuration"><span class="std std-ref">module configuration</span></a>.
Colors of traces etc. can be adjusted by setting the <em>scheme</em> parameters in
the global configuration of scheli. For alternating colors between the traces
set the parameters scheme.colors.records.foreground and
scheme.colors.records.alternateForeground in <code class="file docutils literal notranslate"><span class="pre">scheli.cfg</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># The general color of records/traces.</span>
scheme.colors.records.foreground <span class="o">=</span> 4286F4
<span class="c1"># A general trace color of the alternate trace (eg scheli).</span>
scheme.colors.records.alternateForeground <span class="o">=</span> B72D0E
</pre></div>
</div>
</div>
<div class="section" id="module-configuration">
<span id="scheli-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this headline"></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/scheli.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/scheli.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/scheli.cfg</span></code></div>
</div>
<p>scheli inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
<dl class="confval">
<dt id="confval-heli.streams">
<code class="sig-name descname">heli.streams</code><a class="headerlink" href="#confval-heli.streams" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>list:string</em></p>
<p>List of stream codes to be plotted (net.sta.loc.cha).
If not in capture mode only the first stream is shown.
When using a list, the first entry is considered.
Use commas for separating streams.</p>
<p>Example: GR.MOX..BHZ</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.filter">
<code class="sig-name descname">heli.filter</code><a class="headerlink" href="#confval-heli.filter" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>Filter to be applied on the data.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.numberOfRows">
<code class="sig-name descname">heli.numberOfRows</code><a class="headerlink" href="#confval-heli.numberOfRows" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">48</span></code></p>
<p>Type: <em>integer</em></p>
<p>Filter to be applied on the data.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.rowTimeSpan">
<code class="sig-name descname">heli.rowTimeSpan</code><a class="headerlink" href="#confval-heli.rowTimeSpan" 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>Length of data per trace.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.timeFormat">
<code class="sig-name descname">heli.timeFormat</code><a class="headerlink" href="#confval-heli.timeFormat" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">%F</span></code></p>
<p>Type: <em>string</em></p>
<p>The time format used to print the start and end time of the
whole plot (upper right corner). The format specification is
the one used in the strftime function (man strftime).</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.recordTime">
<code class="sig-name descname">heli.recordTime</code><a class="headerlink" href="#confval-heli.recordTime" 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>Set current time to last data sample.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.lineWidth">
<code class="sig-name descname">heli.lineWidth</code><a class="headerlink" href="#confval-heli.lineWidth" 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>Unit: <em>px</em></p>
<p>Line width of traces.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.colors">
<code class="sig-name descname">heli.colors</code><a class="headerlink" href="#confval-heli.colors" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">FF0000,</span> <span class="pre">0000FF</span></code></p>
<p>Type: <em>list:string</em></p>
<p>A list of alternating row colors cycled through for painting
traces.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.antialiasing">
<code class="sig-name descname">heli.antialiasing</code><a class="headerlink" href="#confval-heli.antialiasing" 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>Use anti aliasing to plot the traces. The default uses the
settings from scheme.records.antiAliasing</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.stream.description">
<code class="sig-name descname">heli.stream.description</code><a class="headerlink" href="#confval-heli.stream.description" 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>Add stream description to traces.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>heli.amplitudeRange.*</strong>
<em>Gain-corrected amplitudes given in units of the sensor.</em>
<em>For example: m/s.</em></p>
</div>
<dl class="confval">
<dt id="confval-heli.amplitudeRange.scaling">
<code class="sig-name descname">heli.amplitudeRange.scaling</code><a class="headerlink" href="#confval-heli.amplitudeRange.scaling" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">minmax</span></code></p>
<p>Type: <em>string</em></p>
<p>Define the method to scale traces within rows. Possible
values are:</p>
<p>minmax: Scale all rows to configured minimum and maximum
amplitudes configured by amplitudeRange.min and
amplitudeRange.max</p>
<p>row: Scale each row to the maximum within this row.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.amplitudeRange.min">
<code class="sig-name descname">heli.amplitudeRange.min</code><a class="headerlink" href="#confval-heli.amplitudeRange.min" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">-0.00001</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>unit of input data</em></p>
<p>Minimum amplitude to show in trace. Requires
amplitudeRange.scale = “minmax”.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.amplitudeRange.max">
<code class="sig-name descname">heli.amplitudeRange.max</code><a class="headerlink" href="#confval-heli.amplitudeRange.max" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0.00001</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>unit of input data</em></p>
<p>Minimum amplitude to show in trace. Requires
amplitudeRange.scale = “minmax”.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><strong>heli.dump.*</strong>
<em>Control dumping of PNG images.</em>
<em>Execute “scheli capture” for image generation in</em>
<em>the background without the graphics.</em></p>
</div>
<dl class="confval">
<dt id="confval-heli.dump.interval">
<code class="sig-name descname">heli.dump.interval</code><a class="headerlink" href="#confval-heli.dump.interval" 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>Unit: <em>s</em></p>
<p>Image creation interval. Negative values disable image
dumping.
If enabled, images are generated at the configured
interval.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.dump.outputFile">
<code class="sig-name descname">heli.dump.outputFile</code><a class="headerlink" href="#confval-heli.dump.outputFile" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">/tmp/heli_%N_%S_%L_%C.png</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of output file.
The filename can contain placeholders
that are replaced by the corresponding streamID parts:</p>
<p>%N : network code</p>
<p>%S : station code</p>
<p>%L : location code</p>
<p>%C : channel code</p>
<p>Placeholders are important if more than one stream
is given and capture mode is active.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.dump.dpi">
<code class="sig-name descname">heli.dump.dpi</code><a class="headerlink" href="#confval-heli.dump.dpi" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>dpi</em></p>
<p>Image resolution.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.dump.xres">
<code class="sig-name descname">heli.dump.xres</code><a class="headerlink" href="#confval-heli.dump.xres" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1024</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>px</em></p>
<p>Number of pixels horizontally.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-heli.dump.yres">
<code class="sig-name descname">heli.dump.yres</code><a class="headerlink" href="#confval-heli.dump.yres" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">768</span></code></p>
<p>Type: <em>integer</em></p>
<p>Unit: <em>px</em></p>
<p>Number of pixels vertically.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-scripts.postprocessing">
<code class="sig-name descname">scripts.postprocessing</code><a class="headerlink" href="#confval-scripts.postprocessing" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>path</em></p>
<p>Define the path to a script that is called whenever an image
has been captured and written to disc. The only parameter is
the path to the generated image.</p>
</dd></dl>
</div>
<div class="section" id="command-line-options">
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this headline"></a></h2>
<p><strong class="program">scheli [options]</strong></p>
<div class="section" id="generic">
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-h">
<code class="sig-name descname">-h</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-v">
<code class="sig-name descname">-V</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-v" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-config-file">
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-config-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative configuration file. When this option is
used the loading of all stages is disabled. Only the
given configuration file is parsed and used. To use
another name for the configuration create a symbolic
link of the application or copy it. Example:
scautopick -&gt; scautopick2.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-plugins">
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-d">
<code class="sig-name descname">-D</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--daemon</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-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 &amp;.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-auto-shutdown">
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-shutdown-master-module">
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-shutdown-master-username">
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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>
</div>
<div class="section" id="verbosity">
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-verbosity">
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="id2">
<code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--v</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#id2" title="Permalink to this definition"></a></dt>
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-q">
<code class="sig-name descname">-q</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-component">
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-s">
<code class="sig-name descname">-s</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--syslog</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-l">
<code class="sig-name descname">-l</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--lockfile</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-console">
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-print-component">
<code class="sig-name descname">--print-component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-print-component" title="Permalink to this definition"></a></dt>
<dd><p>For each log entry print the component right after the
log level. By default the component output is enabled
for file output but disabled for console output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-trace">
<code class="sig-name descname">--trace</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-trace" title="Permalink to this definition"></a></dt>
<dd><p>Execute in trace mode.
Equivalent to –verbosity=4 –console=1 –print-component=1
–print-context=1 .</p>
</dd></dl>
</div>
<div class="section" id="messaging">
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-u">
<code class="sig-name descname">-u</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--user</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-host">
<code class="sig-name descname">-H</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--host</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-host" 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="option">
<dt id="cmdoption-scheli-t">
<code class="sig-name descname">-t</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--timeout</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-g">
<code class="sig-name descname">-g</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--primary-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-subscribe-group">
<code class="sig-name descname">-S</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--subscribe-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-subscribe-group" 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="option">
<dt id="cmdoption-scheli-content-type">
<code class="sig-name descname">--content-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-content-type" title="Permalink to this definition"></a></dt>
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-start-stop-msg">
<code class="sig-name descname">--start-stop-msg</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-start-stop-msg" title="Permalink to this definition"></a></dt>
<dd><p>Set sending of a start and a stop message.</p>
</dd></dl>
</div>
<div class="section" id="database">
<h3>Database<a class="headerlink" href="#database" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-db-driver-list">
<code class="sig-name descname">--db-driver-list</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-db-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported database drivers.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-database">
<code class="sig-name descname">-d</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--database</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-database" title="Permalink to this definition"></a></dt>
<dd><p>The database connection string, format:
<a class="reference external" href="service://user:pwd&#64;host/database">service://user:pwd&#64;host/database</a>.
“service” is the name of the database driver which
can be queried with “–db-driver-list”.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-config-module">
<code class="sig-name descname">--config-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-config-module" title="Permalink to this definition"></a></dt>
<dd><p>The config module to use.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-inventory-db">
<code class="sig-name descname">--inventory-db</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-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="option">
<dt id="cmdoption-scheli-config-db">
<code class="sig-name descname">--config-db</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-config-db" title="Permalink to this definition"></a></dt>
<dd><p>Load the configuration from the given database or file,
format: [<a class="reference external" href="service://]location">service://]location</a> .</p>
</dd></dl>
</div>
<div class="section" id="records">
<h3>Records<a class="headerlink" href="#records" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-record-driver-list">
<code class="sig-name descname">--record-driver-list</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-record-driver-list" title="Permalink to this definition"></a></dt>
<dd><p>List all supported record stream drivers.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-i">
<code class="sig-name descname">-I</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--record-url</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-i" title="Permalink to this definition"></a></dt>
<dd><p>The recordstream source URL, format:
[<a class="reference external" href="service://">service://</a>]location[#type].
“service” is the name of the recordstream driver
which can be queried with “–record-driver-list”.
If “service” is not given, “<a class="reference external" href="file://">file://</a>” is
used.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-record-file">
<code class="sig-name descname">--record-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-record-file" title="Permalink to this definition"></a></dt>
<dd><p>Specify a file as record source.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-record-type">
<code class="sig-name descname">--record-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-record-type" title="Permalink to this definition"></a></dt>
<dd><p>Specify a type for the records being read.</p>
</dd></dl>
</div>
<div class="section" id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-f">
<code class="sig-name descname">-F</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--full-screen</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-f" title="Permalink to this definition"></a></dt>
<dd><p>Start the application filling the entire screen.
This only works with GUI applications.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-n">
<code class="sig-name descname">-N</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--non-interactive</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-n" title="Permalink to this definition"></a></dt>
<dd><p>Use non-interactive presentation mode. This only works with
GUI applications.</p>
</dd></dl>
</div>
<div class="section" id="mode">
<h3>Mode<a class="headerlink" href="#mode" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-offline">
<code class="sig-name descname">--offline</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scheli-offline" title="Permalink to this definition"></a></dt>
<dd><p>Do not connect to a messaging server and do not use the
database.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-end-time">
<code class="sig-name descname">--end-time</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-end-time" title="Permalink to this definition"></a></dt>
<dd><p>Set the acquisition end time, e.g. ‘2017-09-08 13:30:00’,
default: ‘gmt’</p>
</dd></dl>
</div>
<div class="section" id="data">
<h3>Data<a class="headerlink" href="#data" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-stream">
<code class="sig-name descname">--stream</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-stream" title="Permalink to this definition"></a></dt>
<dd><p>The record stream that should be displayed. Can be used
multiple times for multiple streams.</p>
<p>Example: GR.MOX..BHZ (net.sta.loc.cha)</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-filter">
<code class="sig-name descname">--filter</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-filter" title="Permalink to this definition"></a></dt>
<dd><p>The filter to apply</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-gain">
<code class="sig-name descname">--gain</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-gain" title="Permalink to this definition"></a></dt>
<dd><p>Gain applied to the data before plotting</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-amp-scaling">
<code class="sig-name descname">--amp-scaling</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-amp-scaling" title="Permalink to this definition"></a></dt>
<dd><p>Lower bound of amplitude range per row. Possible values:</p>
<p>minmax: Scale all rows to configured minimum and maximum
amplitudes.</p>
<p>row: Scale each row to the maximum within this row.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-amp-range-min">
<code class="sig-name descname">--amp-range-min</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-amp-range-min" title="Permalink to this definition"></a></dt>
<dd><p>Lower bound of amplitude range per row</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-amp-range-max">
<code class="sig-name descname">--amp-range-max</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-amp-range-max" title="Permalink to this definition"></a></dt>
<dd><p>Upper bound of amplitude range per row</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-amp-range">
<code class="sig-name descname">--amp-range</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-amp-range" title="Permalink to this definition"></a></dt>
<dd><p>Arround zero bound of amplitude range per row</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-record-time">
<code class="sig-name descname">--record-time</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-record-time" title="Permalink to this definition"></a></dt>
<dd><p>Do the last row always contain the last record received</p>
</dd></dl>
</div>
<div class="section" id="output">
<h3>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scheli-desc">
<code class="sig-name descname">--desc</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-desc" title="Permalink to this definition"></a></dt>
<dd><p>Enable/disable the display of a station description</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-rows">
<code class="sig-name descname">--rows</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-rows" title="Permalink to this definition"></a></dt>
<dd><p>Configure the number of rows to display</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-time-span">
<code class="sig-name descname">--time-span</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-time-span" title="Permalink to this definition"></a></dt>
<dd><p>Configure the time-span (in secs) per row. Unit: seconds.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-aa">
<code class="sig-name descname">--aa</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-aa" title="Permalink to this definition"></a></dt>
<dd><p>Set antialiasing for rendering the traces</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-xres">
<code class="sig-name descname">--xres</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-xres" title="Permalink to this definition"></a></dt>
<dd><p>Output x resolution when generating images. Unit: dpi.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-yres">
<code class="sig-name descname">--yres</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-yres" title="Permalink to this definition"></a></dt>
<dd><p>Output y resolution when generating images. Unit: dpi.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-dpi">
<code class="sig-name descname">--dpi</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-dpi" title="Permalink to this definition"></a></dt>
<dd><p>Output dpi when generating postscript. Unit:dpi.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-o">
<code class="sig-name descname">-o</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-o" title="Permalink to this definition"></a></dt>
<dd><p>Output filename. Placeholders are %N,%S,%L,%C for network
code, station code, location code, channel code.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scheli-interval">
<code class="sig-name descname">--interval</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scheli-interval" title="Permalink to this definition"></a></dt>
<dd><p>Snapshot interval (less than 0 disables timed snapshots).
Unit: seconds.</p>
</dd></dl>
</div>
</div>
</div>
<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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">scheli</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
<li><a class="reference internal" href="#generic">Generic</a></li>
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
<li><a class="reference internal" href="#messaging">Messaging</a></li>
<li><a class="reference internal" href="#database">Database</a></li>
<li><a class="reference internal" href="#records">Records</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#mode">Mode</a></li>
<li><a class="reference internal" href="#data">Data</a></li>
<li><a class="reference internal" href="#output">Output</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="scesv.html"
title="previous chapter">scesv</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scmm.html"
title="next chapter">scmm</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scheli.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>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.
</div>
</div>
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
<img class="brand" src="../_static/brands/gfz.svg"/>
</a>
</div>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink