Skip to content

Commit c2eae31

Browse files
committed
Deployed with MkDocs version: 1.6.1
1 parent 48f102c commit c2eae31

3 files changed

Lines changed: 9 additions & 11 deletions

File tree

processing_config/index.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,7 +1249,7 @@ <h2 id="tapering">Tapering</h2>
12491249
<ul>
12501250
<li><strong>Parameter</strong>: <code>max_percentage</code> (e.g., 0.05 for 5%)</li>
12511251
<li><strong>Supported Windows</strong>:
1252-
<code>cosine</code>, <code>hann</code>, <code>hamming</code>, <code>blackman</code>, <code>kaiser</code>, <code>flattop</code>, <code>slepian</code>, and many more...</li>
1252+
<code>cosine</code>, <code>hann</code>, <code>hamming</code>, <code>blackman</code>, <code>kaiser</code>, <code>flattop</code>, <code>slepian</code>.</li>
12531253
</ul>
12541254
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">Analysis</span><span class="p">:</span>
12551255
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">process_1</span><span class="p">:</span>
@@ -1390,7 +1390,7 @@ <h2 id="fill-gaps">Fill Gaps</h2>
13901390
<h2 id="differentiate">Differentiate</h2>
13911391
<p>Estimate the signal’s derivative:</p>
13921392
<ul>
1393-
<li><strong>Methods</strong>: <code>gradient</code></li>
1393+
<li><strong>Methods</strong>: <code>gradient</code>, <code>spectral</code></li>
13941394
</ul>
13951395
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nt">Analysis</span><span class="p">:</span>
13961396
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w"> </span><span class="nt">process_9</span><span class="p">:</span>
@@ -1401,7 +1401,7 @@ <h2 id="differentiate">Differentiate</h2>
14011401
<h2 id="integrate">Integrate</h2>
14021402
<p>Reconstruct displacement or velocity:</p>
14031403
<ul>
1404-
<li><strong>Methods</strong>: <code>cumtrapz</code>, <code>spline</code></li>
1404+
<li><strong>Methods</strong>: <code>cumtrapz</code>, <code>spline</code>, <code>spectral</code></li>
14051405
</ul>
14061406
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nt">Analysis</span><span class="p">:</span>
14071407
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span><span class="nt">process_1</span><span class="p">:</span>
@@ -1424,6 +1424,7 @@ <h2 id="time-shifting">Time Shifting</h2>
14241424
<hr />
14251425
<h2 id="remove-instrument-response">Remove Instrument Response</h2>
14261426
<p>Convert raw counts to physical units (e.g., velocity or displacement):</p>
1427+
<p>⚠️ WARNING: Remember to includ your inventory: e.g., <code>surfquake quick -w "waveform_file" -i "inventory_file.xml"</code></p>
14271428
<ul>
14281429
<li><strong>Parameters</strong>: <code>pre_filt</code> (list), <code>water_level</code>, <code>units</code>, <code>inventory</code></li>
14291430
</ul>
@@ -1436,7 +1437,7 @@ <h2 id="remove-instrument-response">Remove Instrument Response</h2>
14361437
<hr />
14371438
<h2 id="add-noise">Add Noise</h2>
14381439
<p><strong>White Noise</strong>:
1439-
- <strong>Parameter</strong>: <code>SNR_dB</code> relative to original trace</p>
1440+
- <strong>Parameter</strong>: <code>SNR_dB</code> amount of noise relative to maximum amplitude of the original trace.</p>
14401441
<p><strong>Colored Noise</strong> (optional, not in base config):
14411442
- Use <code>exponent</code> for control: 0 (white), 1 (pink), 2 (brown), -1 (blue), etc.</p>
14421443
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="nt">Analysis</span><span class="p">:</span>
@@ -1461,7 +1462,7 @@ <h2 id="spectral-whitening">Spectral Whitening</h2>
14611462
<h2 id="time-normalization">Time Normalization</h2>
14621463
<p>Standardize temporal energy distribution:</p>
14631464
<ul>
1464-
<li><strong>Methods</strong>: <code>time-normalization</code>, <code>1bit</code>, <code>clipping</code></li>
1465+
<li><strong>Methods</strong>: <code>time-normalization</code>, <code>1bit</code>, <code>clipping</code> and <code>clipping iteration</code>.</li>
14651466
<li><strong>Parameters</strong>: <code>norm_win</code>, <code>iterations</code></li>
14661467
</ul>
14671468
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="nt">Analysis</span><span class="p">:</span>
@@ -1488,13 +1489,13 @@ <h2 id="smoothing">Smoothing</h2>
14881489
<h2 id="spike-removal">Spike Removal</h2>
14891490
<p>Removes isolated outliers using hampel algorithm:</p>
14901491
<ul>
1491-
<li><strong>Parameters</strong>: <code>window_size</code>, <code>threshold</code> (in standard deviations)</li>
1492+
<li><strong>Parameters</strong>: <code>window_size</code>, <code>sigma</code> (standard deviations from the avarage noise)</li>
14921493
</ul>
14931494
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="nt">Analysis</span><span class="p">:</span>
14941495
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span><span class="nt">process_1</span><span class="p">:</span>
14951496
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;remove_spikes&#39;</span>
14961497
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="w"> </span><span class="nt">window_size</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
1497-
<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a><span class="w"> </span><span class="nt">n</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span>
1498+
<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a><span class="w"> </span><span class="nt">sigma</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4</span>
14981499
</code></pre></div>
14991500
<hr />
15001501

processing_overview/index.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,9 +1118,6 @@
11181118

11191119

11201120
<h1 id="data-processing-with-surfquake">Data Processing with SurfQuake</h1>
1121-
<blockquote>
1122-
<p>⚠️ <strong>Note</strong>: This feature is under active development. The expected stable release is <strong>SurfQuake 0.1.2 (August 2025)</strong>.</p>
1123-
</blockquote>
11241121
<p>Welcome to the <strong>Signal Processing Module</strong> of SurfQuake — a powerful and scalable command-line tool for applying signal processing pipelines to large collections of seismic waveform data.</p>
11251122
<p>Whether you're analyzing earthquake catalogs or preparing data for machine learning models, this module allows you to define, control, and automate your signal processing workflow with precision.</p>
11261123
<p>📘 Learn more in our <a href="https://projectisp.github.io/ISP_tutorial.github.io/sp_filtering/"><strong>Signal Processing Tutorial</strong></a></p>

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)