[installation] Init with inital config for global
This commit is contained in:
216
share/doc/caps/html/apps/rifftool.html
Normal file
216
share/doc/caps/html/apps/rifftool.html
Normal file
@ -0,0 +1,216 @@
|
||||
<!doctype html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<title>rifftool — CAPS: Common Acquisition Protocol Server documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/gempa.css" type="text/css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/gempa.css?v=c960eebf" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||||
<script type="text/javascript" src="../_static/gempa.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=b3ba4146"></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" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="container">
|
||||
<img class="background" src="../_static/icon.png"/>
|
||||
<div class="content">
|
||||
<span class="title">CAPS: Common Acquisition Protocol Server </span>
|
||||
<span class="version">2025.254#f0c77b29e</span></h1>
|
||||
</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="nav-item nav-item-0">
|
||||
<a href="../index.html">Home</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="container">
|
||||
<div class="fitted content" id="anchors-container">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="rifftool">
|
||||
<span id="id1"></span><h1>rifftool<a class="headerlink" href="#rifftool" title="Permalink to this heading">¶</a></h1>
|
||||
<p><strong>CAPS data file analysis tool</strong></p>
|
||||
<section id="description">
|
||||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||||
<p>The CAPS server uses the RIFF file format for data archiving. <strong class="program">rifftool</strong>
|
||||
may be used to analyse the RIFF container, check data integrity, print record
|
||||
statistics and meta data, and to extract raw data stored in the files. The
|
||||
output depends on the selected operational mode and is written to stdout.</p>
|
||||
<p><strong class="program">rifftool</strong> addresses files directly without a request to the
|
||||
<a class="reference internal" href="../base/server.html#sec-caps-server"><span class="std std-ref">CAPS server</span></a>. This is in contrast to <a class="reference internal" href="capstool.html#capstool"><span class="std std-ref">capstool</span></a>
|
||||
which makes server requests. Hence, rifftool can be used to extract data
|
||||
files to, e.g., in miniSEED format, even if the CAPS server is not operational.</p>
|
||||
<table class="docutils align-default">
|
||||
<colgroup>
|
||||
<col style="width: 10.0%" />
|
||||
<col style="width: 90.0%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>Mode; “Description”</p></th>
|
||||
<th class="head"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>chunks</p></td>
|
||||
<td><p>Dump individual RIFF chunks including size, position and meta information specific to individual chunk type.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>index</p></td>
|
||||
<td><p>Dump the CAPS record index organized in a B+ tree (BPT).</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>data</p></td>
|
||||
<td><p>Dump the raw data stored in the CAPS records. The format is specific to the record type and different record types may be mixed in one file. E.g., if all records are of type miniSEED then the result will be a miniSEED conform file with the records sorted by sampling time.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>check</p></td>
|
||||
<td><p>Check data integrity by validating the record order. Additional check assertions may be enabled through parameters.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>records</p></td>
|
||||
<td><p>Dump meta data of all records.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>gaps</p></td>
|
||||
<td><p>Dump data gaps found in a file.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>overlaps</p></td>
|
||||
<td><p>Dump data overlaps found in a file.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="examples">
|
||||
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
|
||||
<ul>
|
||||
<li><p>Dump list of record meta data to stdout</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rifftool<span class="w"> </span>records<span class="w"> </span>NET.STA.LOC.CHA.2022.000.data
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Write the raw data stored in the CAPS records to new file</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rifftool<span class="w"> </span>data<span class="w"> </span>NET.STA.LOC.CHA.2022.000.data<span class="w"> </span>><span class="w"> </span>data.mseed
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Print gaps to stdout</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rifftool<span class="w"> </span>gaps<span class="w"> </span>NET.STA.LOC.CHA.2022.000.data
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Check data integrity by validating the record order</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rifftool<span class="w"> </span>check<span class="w"> </span>NET.STA.LOC.CHA.2022.000.data
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="command-line-options">
|
||||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||||
<p><strong class="program">rifftool [options] mode file</strong></p>
|
||||
<p>Mode is one of: check, chunks, data, index, gaps, overlaps, records</p>
|
||||
<section id="check-assertions">
|
||||
<span id="id2"></span><h3>Check Assertions<a class="headerlink" href="#check-assertions" title="Permalink to this heading">¶</a></h3>
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-no-gaps">
|
||||
<span class="sig-name descname"><span class="pre">--no-gaps</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-gaps" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Assert data file contains no gaps.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-no-overlaps">
|
||||
<span class="sig-name descname"><span class="pre">--no-overlaps</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-overlaps" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Assert no overlaps in data file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-no-data-type-change">
|
||||
<span class="sig-name descname"><span class="pre">--no-data-type-change</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-data-type-change" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Assert no data type changes among records of same data file.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="std option">
|
||||
<dt class="sig sig-object std" id="cmdoption-no-sampling-rate-change">
|
||||
<span class="sig-name descname"><span class="pre">--no-sampling-rate-change</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-sampling-rate-change" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Assert no sampling rate change among records of same data file.</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="#">rifftool</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="#command-line-options">Command-Line Options</a><ul>
|
||||
<li><a class="reference internal" href="#check-assertions">Check Assertions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/apps/rifftool.rst.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
Release <b></b> version <b>2025.254#f0c77b29e</b>
|
||||
<div class="copyright">
|
||||
© Copyright <a href="https://www.gempa.de">2013, gempa GmbH.</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user