Skip to content

Commit e3840e4

Browse files
rcabdiarcabdia
committed
Deployed with MkDocs version: 1.6.1
1 parent e1d92fd commit e3840e4

File tree

4 files changed

+71
-42
lines changed

4 files changed

+71
-42
lines changed

‎search/search_index.json‎

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

‎sitemap.xml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,94 +2,94 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://github.com/rcabdia/SurfQuake/</loc>
5-
<lastmod>2025-08-27</lastmod>
5+
<lastmod>2025-09-10</lastmod>
66
</url>
77
<url>
88
<loc>https://github.com/rcabdia/SurfQuake/associate/</loc>
9-
<lastmod>2025-08-27</lastmod>
9+
<lastmod>2025-09-10</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://github.com/rcabdia/SurfQuake/bash_script/</loc>
13-
<lastmod>2025-08-27</lastmod>
13+
<lastmod>2025-09-10</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://github.com/rcabdia/SurfQuake/beamforming_documentation/</loc>
17-
<lastmod>2025-08-27</lastmod>
17+
<lastmod>2025-09-10</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://github.com/rcabdia/SurfQuake/characteristic_functions_documentation/</loc>
21-
<lastmod>2025-08-27</lastmod>
21+
<lastmod>2025-09-10</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://github.com/rcabdia/SurfQuake/db/</loc>
25-
<lastmod>2025-08-27</lastmod>
25+
<lastmod>2025-09-10</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://github.com/rcabdia/SurfQuake/examples/</loc>
29-
<lastmod>2025-08-27</lastmod>
29+
<lastmod>2025-09-10</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://github.com/rcabdia/SurfQuake/explore_data/</loc>
33-
<lastmod>2025-08-27</lastmod>
33+
<lastmod>2025-09-10</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://github.com/rcabdia/SurfQuake/install/</loc>
37-
<lastmod>2025-08-27</lastmod>
37+
<lastmod>2025-09-10</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://github.com/rcabdia/SurfQuake/locate/</loc>
41-
<lastmod>2025-08-27</lastmod>
41+
<lastmod>2025-09-10</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://github.com/rcabdia/SurfQuake/mti/</loc>
45-
<lastmod>2025-08-27</lastmod>
45+
<lastmod>2025-09-10</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://github.com/rcabdia/SurfQuake/particle_motion_documentation/</loc>
49-
<lastmod>2025-08-27</lastmod>
49+
<lastmod>2025-09-10</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://github.com/rcabdia/SurfQuake/picker/</loc>
53-
<lastmod>2025-08-27</lastmod>
53+
<lastmod>2025-09-10</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://github.com/rcabdia/SurfQuake/plotting_interaction_documentation/</loc>
57-
<lastmod>2025-08-27</lastmod>
57+
<lastmod>2025-09-10</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://github.com/rcabdia/SurfQuake/processing_config/</loc>
61-
<lastmod>2025-08-27</lastmod>
61+
<lastmod>2025-09-10</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://github.com/rcabdia/SurfQuake/processing_overview/</loc>
65-
<lastmod>2025-08-27</lastmod>
65+
<lastmod>2025-09-10</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://github.com/rcabdia/SurfQuake/processing_stream_config/</loc>
69-
<lastmod>2025-08-27</lastmod>
69+
<lastmod>2025-09-10</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://github.com/rcabdia/SurfQuake/project/</loc>
73-
<lastmod>2025-08-27</lastmod>
73+
<lastmod>2025-09-10</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://github.com/rcabdia/SurfQuake/scripts/</loc>
77-
<lastmod>2025-08-27</lastmod>
77+
<lastmod>2025-09-10</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://github.com/rcabdia/SurfQuake/source/</loc>
81-
<lastmod>2025-08-27</lastmod>
81+
<lastmod>2025-09-10</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://github.com/rcabdia/SurfQuake/spectral_analysis_documentation/</loc>
85-
<lastmod>2025-08-27</lastmod>
85+
<lastmod>2025-09-10</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://github.com/rcabdia/SurfQuake/trace_header_documentation/</loc>
89-
<lastmod>2025-08-27</lastmod>
89+
<lastmod>2025-09-10</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://github.com/rcabdia/SurfQuake/utils/</loc>
93-
<lastmod>2025-08-27</lastmod>
93+
<lastmod>2025-09-10</lastmod>
9494
</url>
9595
</urlset>

‎sitemap.xml.gz‎

-1 Bytes
Binary file not shown.

‎trace_header_documentation/index.html‎

Lines changed: 47 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -680,6 +680,15 @@
680680
</span>
681681
</a>
682682

683+
</li>
684+
685+
<li class="md-nav__item">
686+
<a href="#trace-header-modification" class="md-nav__link">
687+
<span class="md-ellipsis">
688+
Trace header modification
689+
</span>
690+
</a>
691+
683692
</li>
684693

685694
<li class="md-nav__item">
@@ -1292,6 +1301,26 @@ <h2 id="header-info-from-command-line">Header Info from Command Line</h2>
12921301
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>Picks<span class="w"> </span><span class="p">|</span><span class="w"> </span>None<span class="w"> </span><span class="p">|</span><span class="w"> </span>None<span class="w"> </span>
12931302
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>References<span class="w"> </span><span class="p">|</span><span class="w"> </span>None<span class="w"> </span><span class="p">|</span><span class="w"> </span>None
12941303
</code></pre></div></p>
1304+
<h2 id="trace-header-modification">Trace header modification</h2>
1305+
<p>If you need to modify the header of your traces, I recommend that you use <em>quick</em> or <em>process_daily</em> command and use the <strong>rename</strong> process. This process simply maps the original traces header information into the new one. Here, you will find an example of config file with the process of mapping network, station, location and channel codes.</p>
1306+
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>Analysis:
1307+
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span>process_1:
1308+
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span>name:<span class="w"> </span><span class="s1">&#39;rename&#39;</span>
1309+
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>
1310+
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span>networks:
1311+
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span>IM:<span class="w"> </span>IH<span class="w"> </span><span class="c1"># Replace network XX → YY</span>
1312+
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span>IK:<span class="w"> </span>IN
1313+
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>
1314+
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span>stations:
1315+
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span>IL02:<span class="w"> </span>XX02
1316+
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="w"> </span>ARNO:<span class="w"> </span>MELI
1317+
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>
1318+
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a><span class="w"> </span>channels:
1319+
<a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a><span class="w"> </span>SHZ:<span class="w"> </span>BHZ<span class="w"> </span><span class="c1"># Entire channel replacement</span>
1320+
<a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>
1321+
<a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a><span class="w"> </span>components:
1322+
<a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a><span class="w"> </span>Z:<span class="w"> </span>E<span class="w"> </span><span class="c1"># Only the last component letter (Z → E, N → Z, etc.)</span>
1323+
</code></pre></div>
12951324
<h2 id="surfquake-extended-header-fields">SurfQuake-Extended Header Fields</h2>
12961325
<p>These fields are dynamically added during processing or interactive analysis:</p>
12971326
<h3 id="tracestatspicks-list-of-dicts"><code>trace.stats.picks</code> (list of dicts)</h3>
@@ -1301,12 +1330,12 @@ <h3 id="tracestatspicks-list-of-dicts"><code>trace.stats.picks</code> (list of d
13011330
- <code>phase</code> (str): Picked phase (e.g., <code>P</code>, <code>S</code>, <code>Lg</code>)
13021331
- <code>amplitude</code> (float): Measured amplitude at pick time
13031332
- <code>polarity</code> (str): <code>U</code> (up), <code>D</code> (down), or <code>?</code></p>
1304-
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
1305-
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">&quot;time&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">1727123830.321</span><span class="p">,</span>
1306-
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">&quot;phase&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;P&quot;</span><span class="p">,</span>
1307-
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">&quot;amplitude&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">3.21e-05</span><span class="p">,</span>
1308-
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">&quot;polarity&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;U&quot;</span>
1309-
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="p">}</span>
1333+
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
1334+
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">&quot;time&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">1727123830.321</span><span class="p">,</span>
1335+
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">&quot;phase&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;P&quot;</span><span class="p">,</span>
1336+
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">&quot;amplitude&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">3.21e-05</span><span class="p">,</span>
1337+
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">&quot;polarity&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;U&quot;</span>
1338+
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="p">}</span>
13101339
</code></pre></div>
13111340
<h3 id="tracestatsreferences-list-of-float"><code>trace.stats.references</code> (list of float)</h3>
13121341
<p>Stores timestamps marking user-defined reference lines during plotting (e.g., using keypress <code>w</code>). These are used for alignment, cross-checking picks, or beamforming time tags.</p>
@@ -1343,16 +1372,16 @@ <h3 id="tracestatsgeodetic"><code>trace.stats.geodetic</code></h3>
13431372
</tbody>
13441373
</table>
13451374
<h3 id="example">Example:</h3>
1346-
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">geodetic</span> <span class="o">=</span> <span class="p">{</span>
1347-
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="s2">&quot;distance&quot;</span><span class="p">:</span> <span class="mf">254.7</span><span class="p">,</span>
1348-
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="s2">&quot;baz&quot;</span><span class="p">:</span> <span class="mf">123.4</span><span class="p">,</span>
1349-
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> <span class="s2">&quot;az&quot;</span><span class="p">:</span> <span class="mf">303.4</span><span class="p">,</span>
1350-
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> <span class="s2">&quot;incidence&quot;</span><span class="p">:</span> <span class="mf">31.5</span><span class="p">,</span>
1351-
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> <span class="s2">&quot;arrivals&quot;</span><span class="p">:</span> <span class="p">{</span>
1352-
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a> <span class="s2">&quot;P&quot;</span><span class="p">:</span> <span class="mf">1727123829.20</span><span class="p">,</span>
1353-
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a> <span class="s2">&quot;S&quot;</span><span class="p">:</span> <span class="mf">1727123844.03</span>
1354-
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a> <span class="p">}</span>
1355-
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="p">}</span>
1375+
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">geodetic</span> <span class="o">=</span> <span class="p">{</span>
1376+
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a> <span class="s2">&quot;distance&quot;</span><span class="p">:</span> <span class="mf">254.7</span><span class="p">,</span>
1377+
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a> <span class="s2">&quot;baz&quot;</span><span class="p">:</span> <span class="mf">123.4</span><span class="p">,</span>
1378+
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a> <span class="s2">&quot;az&quot;</span><span class="p">:</span> <span class="mf">303.4</span><span class="p">,</span>
1379+
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a> <span class="s2">&quot;incidence&quot;</span><span class="p">:</span> <span class="mf">31.5</span><span class="p">,</span>
1380+
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a> <span class="s2">&quot;arrivals&quot;</span><span class="p">:</span> <span class="p">{</span>
1381+
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a> <span class="s2">&quot;P&quot;</span><span class="p">:</span> <span class="mf">1727123829.20</span><span class="p">,</span>
1382+
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a> <span class="s2">&quot;S&quot;</span><span class="p">:</span> <span class="mf">1727123844.03</span>
1383+
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a> <span class="p">}</span>
1384+
<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="p">}</span>
13561385
</code></pre></div>
13571386
<hr />
13581387
<h2 id="trace-header-management-in-surfquake">Trace Header Management in SurfQuake</h2>
@@ -1377,8 +1406,8 @@ <h2 id="best-practices">Best Practices</h2>
13771406
<li>Pick and reference data are stored in-memory and optionally exported to CSV.</li>
13781407
<li>Ensure that when traces are saved or passed between steps, <code>trace.stats</code> is retained.</li>
13791408
<li>You can inspect or modify these attributes using standard Python syntax:
1380-
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">picks</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="o">...</span><span class="p">})</span>
1381-
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">references</span> <span class="o">=</span> <span class="p">[]</span>
1409+
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">picks</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="o">...</span><span class="p">})</span>
1410+
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="n">trace</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">references</span> <span class="o">=</span> <span class="p">[]</span>
13821411
</code></pre></div></li>
13831412
</ul>
13841413
<hr />

0 commit comments

Comments
 (0)