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.

411 lines
21 KiB
HTML

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>scmapcut &#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="scmssort" href="scmssort.html" />
<link rel="prev" title="scm" href="scm.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="scmssort.html" title="scmssort"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="scm.html" title="scm"
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/utilities.html" accesskey="U">Utilities</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="scmapcut">
<span id="id1"></span><h1>scmapcut<a class="headerlink" href="#scmapcut" title="Permalink to this headline"></a></h1>
<p><strong>Create image files containing maps of specific regions.</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p><em>scmapcut</em> is a commandline tool to create image files containing maps of specific
regions and for selected events. When plotting events given by their eventID, the
event parameters must be provided in a SeisComP event XML file. The XML file can
be retrieved from the database using <a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>.</p>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<ol class="arabic">
<li><p>Draw a map for the event with event ID &lt;eventID&gt;. Plot a region of at least
3 degrees around the epicentre. The created image has 800x400 px.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmapcut -E &lt;eventID&gt; --ep &lt;eventID&gt;.xml -m <span class="m">3</span> -d 800x400 -o &lt;eventID&gt;.png
</pre></div>
</div>
<div class="figure align-center" id="id3">
<span id="fig-workflow"></span><a class="reference internal image-reference" href="../_images/gempa2017xxxx.png"><img alt="../_images/gempa2017xxxx.png" src="../_images/gempa2017xxxx.png" style="width: 10cm;" /></a>
<p class="caption"><span class="caption-text">Image example.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
</li>
<li><p>Draw a map for a generic event with magnitude 4. The size of the event shown
on the map scales with magnitude. Plot a region of at least 3 degrees around
the epicentre. The created image has 800x400 px.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scmapcut --lat <span class="m">44</span> --lon <span class="m">12</span> --depth <span class="m">10</span> --mag <span class="m">4</span> -m <span class="m">0</span>.5 -d 800x400 -o generic.png
</pre></div>
</div>
<div class="figure align-center" id="id4">
<span id="fig-workflow-mag4"></span><a class="reference internal image-reference" href="../_images/generic.png"><img alt="../_images/generic.png" src="../_images/generic.png" style="width: 10cm;" /></a>
<p class="caption"><span class="caption-text">Generic example.</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</div>
</li>
</ol>
</div>
<div class="section" id="module-configuration">
<span id="scmapcut-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/scmapcut.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/scmapcut.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/scmapcut.cfg</span></code></div>
</div>
<p>scmapcut inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
</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">scmapcut [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-scmapcut-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-scmapcut-h" title="Permalink to this definition"></a></dt>
<dd><p>Show help message.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-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-scmapcut-v" title="Permalink to this definition"></a></dt>
<dd><p>Show version information.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-config-file">
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-plugins">
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-plugins" title="Permalink to this definition"></a></dt>
<dd><p>Load given plugins.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-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-scmapcut-d" title="Permalink to this definition"></a></dt>
<dd><p>Run as daemon. This means the application will fork itself
and doesnt need to be started with &amp;.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-auto-shutdown">
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-shutdown-master-module">
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-shutdown-master-username">
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-verbosity">
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-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-scmapcut-q" title="Permalink to this definition"></a></dt>
<dd><p>Quiet mode: no logging output.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-component">
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-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-scmapcut-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-scmapcut-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-scmapcut-l" title="Permalink to this definition"></a></dt>
<dd><p>Path to lock file.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-console">
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-console" title="Permalink to this definition"></a></dt>
<dd><p>Send log output to stdout.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-debug">
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scmapcut-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-scmapcut-log-file">
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-log-file" title="Permalink to this definition"></a></dt>
<dd><p>Use alternative log file.</p>
</dd></dl>
</div>
<div class="section" id="cities">
<h3>Cities<a class="headerlink" href="#cities" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scmapcut-city-xml">
<code class="sig-name descname">--city-xml</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-city-xml" title="Permalink to this definition"></a></dt>
<dd><p>Path to the cities.xml file. If undefined, the data is
read from CONFIGDIR&#64;/cities.xml or &#64;DATADIR&#64;/cities.xml.</p>
</dd></dl>
</div>
<div class="section" id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h3>
<dl class="option">
<dt id="cmdoption-scmapcut-r">
<code class="sig-name descname">-r</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--region</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-r" title="Permalink to this definition"></a></dt>
<dd><p>Cut region ([lat_dim]x[lon_dim]+lat0+lon0 or +lat0+lon+lat1+lon1).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-m">
<code class="sig-name descname">-m</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--margin</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-m" title="Permalink to this definition"></a></dt>
<dd><p>Margin in degrees around origin (margin|margin_latxmargin_lon).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-dimension">
<code class="sig-name descname">-d</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--dimension</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-dimension" title="Permalink to this definition"></a></dt>
<dd><p>Output image dimension (wxh).</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-o">
<code class="sig-name descname">-o</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--output</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-o" title="Permalink to this definition"></a></dt>
<dd><p>Output image, file name.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-lat">
<code class="sig-name descname">--lat</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-lat" title="Permalink to this definition"></a></dt>
<dd><p>Latitude of symbol.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-long">
<code class="sig-name descname">--long</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-long" title="Permalink to this definition"></a></dt>
<dd><p>Longitude of symbol.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-depth">
<code class="sig-name descname">--depth</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-depth" title="Permalink to this definition"></a></dt>
<dd><p>Depth of event.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-mag">
<code class="sig-name descname">--mag</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-mag" title="Permalink to this definition"></a></dt>
<dd><p>Magnitude of event.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-layers">
<code class="sig-name descname">--layers</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-layers" title="Permalink to this definition"></a></dt>
<dd><p>Draw polygonal layers.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-ep">
<code class="sig-name descname">--ep</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-ep" title="Permalink to this definition"></a></dt>
<dd><p>Name of XML file containing the event parameters to load.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-e">
<code class="sig-name descname">-E</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--event-id</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-e" title="Permalink to this definition"></a></dt>
<dd><p>Event ID of the event to plot on map.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-scmapcut-html-area">
<code class="sig-name descname">--html-area</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scmapcut-html-area" title="Permalink to this definition"></a></dt>
<dd><p>Print html/area section.</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="#">scmapcut</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="#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="#cities">Cities</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="scm.html"
title="previous chapter">scm</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="scmssort.html"
title="next chapter">scmssort</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/scmapcut.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>