Skip to content

Commit 12df9f9

Browse files
committed
Built site for gh-pages
1 parent 665c4e5 commit 12df9f9

7 files changed

Lines changed: 594 additions & 64 deletions

File tree

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
83c183d9
1+
8161b2fb

documentation/modules/segy.html

Lines changed: 156 additions & 17 deletions
Large diffs are not rendered by default.

documentation/modules/segy2grd.html

Lines changed: 132 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,41 @@
2020
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
2121
vertical-align: middle;
2222
}
23+
/* CSS for syntax highlighting */
24+
html { -webkit-text-size-adjust: 100%; }
25+
pre > code.sourceCode { white-space: pre; position: relative; }
26+
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
27+
pre > code.sourceCode > span:empty { height: 1.2em; }
28+
.sourceCode { overflow: visible; }
29+
code.sourceCode > span { color: inherit; text-decoration: inherit; }
30+
div.sourceCode { margin: 1em 0; }
31+
pre.sourceCode { margin: 0; }
32+
@media screen {
33+
div.sourceCode { overflow: auto; }
34+
}
35+
@media print {
36+
pre > code.sourceCode { white-space: pre-wrap; }
37+
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
38+
}
39+
pre.numberSource code
40+
{ counter-reset: source-line 0; }
41+
pre.numberSource code > span
42+
{ position: relative; left: -4em; counter-increment: source-line; }
43+
pre.numberSource code > span > a:first-child::before
44+
{ content: counter(source-line);
45+
position: relative; left: -1em; text-align: right; vertical-align: baseline;
46+
border: none; display: inline-block;
47+
-webkit-touch-callout: none; -webkit-user-select: none;
48+
-khtml-user-select: none; -moz-user-select: none;
49+
-ms-user-select: none; user-select: none;
50+
padding: 0 4px; width: 4em;
51+
}
52+
pre.numberSource { margin-left: 3em; padding-left: 4px; }
53+
div.sourceCode
54+
{ }
55+
@media screen {
56+
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
57+
}
2358
</style>
2459

2560

@@ -409,8 +444,19 @@
409444
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
410445
<!-- sidebar -->
411446
<!-- margin-sidebar -->
412-
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar zindex-bottom">
413-
447+
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
448+
<nav id="TOC" role="doc-toc" class="toc-active">
449+
<h2 id="toc-title">On this page</h2>
450+
451+
<ul class="collapse">
452+
<li><a href="#description" id="toc-description" class="nav-link active" data-scroll-target="#description">Description</a></li>
453+
<li><a href="#required-arguments" id="toc-required-arguments" class="nav-link" data-scroll-target="#required-arguments">Required Arguments</a></li>
454+
<li><a href="#optional-arguments" id="toc-optional-arguments" class="nav-link" data-scroll-target="#optional-arguments">Optional Arguments</a></li>
455+
<li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
456+
<li><a href="#source-code" id="toc-source-code" class="nav-link" data-scroll-target="#source-code">Source Code</a></li>
457+
<li><a href="#see-also" id="toc-see-also" class="nav-link" data-scroll-target="#see-also">See Also</a></li>
458+
</ul>
459+
</nav>
414460
</div>
415461
<!-- main -->
416462
<main class="content" id="quarto-document-content">
@@ -434,23 +480,93 @@ <h1 class="title">segy2grd</h1>
434480
</header>
435481

436482

437-
<p>Converting SEGY data to a grid.</p>
438-
<div class="callout callout-style-default callout-warning callout-titled">
439-
<div class="callout-header d-flex align-content-center">
440-
<div class="callout-icon-container">
441-
<i class="callout-icon"></i>
442-
</div>
443-
<div class="callout-title-container flex-fill">
444-
Warning
445-
</div>
446-
</div>
447-
<div class="callout-body-container callout-body">
448-
<p>This GMT supplements module has not yet been ported to the long verbose syntax. To use it, you will need to use the <a href="../..\documentation/general/monolitic.html">Monolithic</a> mode.</p>
449-
</div>
483+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">segy2grd</span>(cmd0<span class="op">::</span><span class="dt">String</span>=<span class="st">""</span>, arg1<span class="op">=</span><span class="cn">nothing</span>; kwargs<span class="op">...</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
484+
<p>Create a grid file from a SEGY file.</p>
485+
<p>(<strong>Warning: Manual translate by Claude. Needs revision</strong>)</p>
486+
<section id="description" class="level2">
487+
<h2 class="anchored" data-anchor-id="description">Description</h2>
488+
<p><strong>segy2grd</strong> reads an IEEE SEGY file and creates a binary grid file. Either a simple mapping (equivalent to <a href="../..\documentation/modules/xyz2grd.html">xyz2grd</a> -Z) or a more complicated averaging where a particular grid cell includes values from more than one sample in the SEGY file can be done. <strong>segy2grd</strong> will report if some of the nodes are not filled in with data. Such unconstrained nodes are set to a value specified by the user [Default is NaN]. Nodes with more than one value will be set to the average value.</p>
489+
</section>
490+
<section id="required-arguments" class="level2">
491+
<h2 class="anchored" data-anchor-id="required-arguments">Required Arguments</h2>
492+
<p><em>segyfile</em> An IEEE floating point SEGY file. Traces are all assumed to start at 0 time/depth (passed as first argument or via <code>cmd0</code>).</p>
493+
<ul>
494+
<li><p><strong>G</strong> or <strong>outgrid</strong> or <strong>save</strong> : – <em>outgrid=filename</em><br>
495+
Give the name of the output grid file.</p></li>
496+
<li><p><strong>I</strong> or <strong>inc</strong> or <strong>increment</strong> or <strong>spacing</strong> : – <em>inc=x_inc</em> <strong>|</strong> <em>inc=(x_inc, y_inc)</em> <strong>|</strong> <em>inc=“xinc[+e|n][/yinc[+e|n]]”</em><br>
497+
Specify the grid increments or the block sizes. More at <a href="../../documentation/common_opts/common_opts.html#spacing">spacing</a></p></li>
498+
<li><p><strong>R</strong> or <strong>region</strong> or <strong>limits</strong> : – <em>limits=(xmin, xmax, ymin, ymax)</em> <strong>|</strong> <em>limits=(BB=(xmin, xmax, ymin, ymax),)</em> <strong>|</strong> <em>limits=(LLUR=(xmin, xmax, ymin, ymax),units=“unit”)</em> <strong>|</strong> …more<br>
499+
Specify the region of interest. More at <a href="../../documentation/common_opts/common_opts.html#limits">limits</a>. For perspective view <strong>view</strong>, optionally add <em>zmin,zmax</em>. This option may be used to indicate the range used for the 3-D axes. You may ask for a larger w/e/s/n region to have more room between the image and the axes.</p></li>
500+
</ul>
501+
</section>
502+
<section id="optional-arguments" class="level2">
503+
<h2 class="anchored" data-anchor-id="optional-arguments">Optional Arguments</h2>
504+
<ul>
505+
<li><p><strong>A</strong> or <strong>add</strong> or <strong>count</strong> : – <em>add=:z</em> <strong>|</strong> <em>add=:n</em> <strong>|</strong> <em>add=true</em><br>
506+
Add up multiple values that belong to the same node (same as <strong>add=:z</strong>). Use <strong>add=:n</strong> to simply count the number of data points that were assigned to each node. [Default (no <strong>add</strong> option) will calculate mean value]. Not used for simple mapping.</p></li>
507+
<li><p><strong>D</strong> or <strong>metadata</strong> or <strong>header</strong> : – <em>metadata=string</em><br>
508+
Set grid metadata (title, remark, x/y/z units, etc.).</p></li>
509+
<li><p><strong>L</strong> or <strong>nsamp</strong> or <strong>nsamples</strong> : – <em>nsamples=val</em><br>
510+
Let <em>nsamp</em> override number of samples in each trace.</p></li>
511+
<li><p><strong>M</strong> or <strong>ntraces</strong> : – <em>ntraces=val</em><br>
512+
Fix number of traces to read in. Default tries to read 10000 traces. <strong>ntraces=0</strong> will read number in binary header, <strong>ntraces=n</strong> will attempt to read only <em>n</em> traces.</p></li>
513+
<li><p><strong>Q</strong> or <strong>adjust</strong> : – <em>adjust=(xscale=val, sint=val)</em><br>
514+
Can be used to change two different settings:<br>
515+
<strong>xscale</strong> (or <strong>x</strong>): applies scalar <em>x-scale</em> to coordinates in trace header to match the coordinates specified in <strong>region</strong>.<br>
516+
<strong>sint</strong> (or <strong>y</strong>): specifies sample interval as <em>s_int</em> if incorrect in the SEGY file.</p></li>
517+
<li><p><strong>S</strong> or <strong>spacing</strong> or <strong>varspacing</strong> : – <em>spacing=:c</em> <strong>|</strong> <em>spacing=:o</em> <strong>|</strong> <em>spacing=(byte=num,)</em><br>
518+
Set variable spacing; use <strong>:c</strong> (or <strong>:cdp</strong>) for cdp, <strong>:o</strong> (or <strong>:offset</strong>) for offset, or a NamedTuple with <strong>byte=num</strong> for 4-byte float starting at byte <em>num</em>. If <strong>spacing</strong> not set, assumes even spacing of samples at the <em>x_inc</em>, <em>y_inc</em> supplied with <strong>inc</strong>.</p></li>
519+
<li><p><strong>V</strong> or <em>verbose</em> : – <em>verbose=true</em> <strong>|</strong> <em>verbose=level</em><br>
520+
Select verbosity level. More at <a href="../../documentation/common_opts/common_opts.html#verbose">verbose</a></p></li>
521+
<li><p><strong>bi</strong> or <strong>binary_in</strong> : – <em>binary_in=??</em><br>
522+
Select native binary format for primary table input. <a href="https://docs.generic-mapping-tools.org/dev/gmt.html#bi-full">More at</a></p></li>
523+
<li><p><strong>di</strong> or <strong>nodata_in</strong> : – <em>nodata_in=val</em><br>
524+
Examine all input columns and if any item equals <em>val</em> we interpret this value as a missing data item and substitute the value NaN. Also sets nodes with no input SEGY coverage to this value [Default is NaN].</p></li>
525+
<li><p><strong>r</strong> or <strong>reg</strong> or <strong>registration</strong> : – <em>reg=:p</em> <strong>|</strong> <em>reg=:g</em><br>
526+
Select gridline or pixel node registration. Used only when output is a grid. <a href="https://docs.generic-mapping-tools.org/dev/gmt.html#nodereg-full">More at</a></p></li>
527+
<li><p><strong>yx</strong> : – <em>yx=true</em><br>
528+
Swap 1st and 2nd column on input and/or output.</p></li>
529+
</ul>
530+
</section>
531+
<section id="examples" class="level2">
532+
<h2 class="anchored" data-anchor-id="examples">Examples</h2>
533+
<p>To create a grid file from an even spaced SEGY file test.segy, try:</p>
534+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb2"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
535+
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>G <span class="op">=</span> <span class="fu">segy2grd</span>(<span class="st">"test.segy"</span>, inc<span class="op">=</span><span class="st">"0.1/0.1"</span>, outgrid<span class="op">=</span><span class="st">"test.nc"</span>, region<span class="op">=</span>(<span class="fl">198</span>,<span class="fl">208</span>,<span class="fl">18</span>,<span class="fl">25</span>), verbose<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
536+
<p>Note that this will read in 18-25s (or km) on each trace, but the first trace will be assumed to be at X=198.</p>
537+
<p>To create a grid file from the SEGY file test.segy, locating traces according to the CDP number, where there are 10 CDPs per km and the sample interval is 0.1, try:</p>
538+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb3"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
539+
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>G <span class="op">=</span> <span class="fu">segy2grd</span>(<span class="st">"test.segy"</span>, outgrid<span class="op">=</span><span class="st">"test.nc"</span>, region<span class="op">=</span>(<span class="fl">0</span>,<span class="fl">100</span>,<span class="fl">0</span>,<span class="fl">10</span>), inc<span class="op">=</span><span class="st">"0.5/0.2"</span>,</span>
540+
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> verbose<span class="op">=</span><span class="cn">true</span>, adjust<span class="op">=</span>(xscale<span class="op">=</span><span class="fl">0.1</span>, sint<span class="op">=</span><span class="fl">0.1</span>))</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
541+
<p>Because the grid interval is larger than the SEGY file sampling, the individual samples will be averaged in bins.</p>
542+
<div class="ansi-escaped-output">
543+
<pre><span class="ansi-green-fg ansi-bold">Precompiling</span> packages...
544+
545+
546+
58970.2 ms<span class="ansi-green-fg"></span>GMT
547+
548+
1 dependency successfully precompiled in 60 seconds. 80 already precompiled.</pre>
450549
</div>
451-
<p>Please open a <a href="https://github.com/GenericMappingTools/GMT.jl/issues">Feature Request</a> if you would like to see this module ported to the long verbose syntax, or better yet, consider contributing the port yourself!</p>
550+
</section>
551+
<section id="source-code" class="level2">
552+
<h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
553+
<p>This function has multiple methods:</p>
554+
<ul>
555+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/segy/segy2grd.jl#L6"><code>segy2grd(cmd0::String; kwargs...)</code></a> - segy2grd.jl:6</li>
556+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/segy/segy2grd.jl#L6"><code>segy2grd(; ...)</code></a> - segy2grd.jl:6</li>
557+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/segy/segy2grd.jl#L7"><code>segy2grd(arg1; kwargs...)</code></a> - segy2grd.jl:7</li>
558+
</ul>
559+
<pre><code></code></pre>
560+
</section>
561+
<section id="see-also" class="level2">
562+
<h2 class="anchored" data-anchor-id="see-also">See Also</h2>
563+
<ul>
564+
<li><a href="../..\documentation/modules/segy.html">segy</a>, <a href="../..\documentation/modules/segyz.html">segyz</a>, <a href="../..\documentation/modules/grd2xyz.html">grd2xyz</a>, <a href="../..\documentation/modules/xyz2grd.html">xyz2grd</a></li>
565+
<li><a href="../alphabetical.html">Alphabetical Function List</a></li>
566+
</ul>
452567

453568

569+
</section>
454570

455571
</main> <!-- /main -->
456572
<script>

0 commit comments

Comments
 (0)