Skip to content

Commit

Permalink
build based on 8e7e1a3
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 20, 2024
1 parent dfea580 commit f391900
Show file tree
Hide file tree
Showing 15 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-20T03:56:41","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-20T15:00:45","documenter_version":"1.3.0"}}
2 changes: 1 addition & 1 deletion dev/comp/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@
silent::Bool = false)</code></pre><p>Evaluate performance of an aeromagnetic compensation model.</p><p><strong>Arguments:</strong></p><ul><li><code>comp_params</code>: <code>CompParams</code> aeromagnetic compensation parameters struct, either:<ul><li><code>NNCompParams</code>: neural network-based aeromagnetic compensation parameters struct</li><li><code>LinCompParams</code>: linear aeromagnetic compensation parameters struct</li></ul></li><li><code>xyz</code>: <code>XYZ</code> flight data struct</li><li><code>ind</code>: selected data indices</li><li><code>mapS</code>: (optional) <code>MapS</code>, <code>MapSd</code>, or <code>MapS3D</code> scalar magnetic anomaly map struct, only used for <code>y_type = :b, :c</code></li><li><code>l_window</code>: (optional) temporal window length, only used for <code>model_type = :m3w, :m3tf</code></li><li><code>silent</code>: (optional) if true, no print outs</li></ul><p><strong>Returns:</strong></p><ul><li><code>y</code>: length <code>N</code> target vector</li><li><code>y_hat</code>: length <code>N</code> prediction vector</li><li><code>err</code>: length <code>N</code> compensation error</li><li><code>features</code>: length <code>Nf</code> feature vector (including components of TL <code>A</code>, etc.)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MIT-AI-Accelerator/MagNav.jl/blob/8e7e1a31a9660beb0fda834738e63b014751cd3a/src/compensation.jl#L3196-L3219">source</a></section><section><div><pre><code class="language-julia hljs">comp_test(comp_params::CompParams, lines,
df_line::DataFrame, df_flight::DataFrame, df_map::DataFrame;
l_window::Int = 5,
silent::Bool = false)</code></pre><p>Evaluate performance of an aeromagnetic compensation model.</p><p><strong>Arguments:</strong></p><ul><li><code>comp_params</code>: <code>CompParams</code> aeromagnetic compensation parameters struct, either:<ul><li><code>NNCompParams</code>: neural network-based aeromagnetic compensation parameters struct</li><li><code>LinCompParams</code>: linear aeromagnetic compensation parameters struct</li></ul></li><li><code>lines</code>: selected line number(s)</li><li><code>df_line</code>: lookup table (DataFrame) of <code>lines</code></li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>flight</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">flight name (e.g., <code>:Flt1001</code>)</td></tr><tr><td style="text-align: left"><code>line</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">line number, i.e., segments within <code>flight</code></td></tr><tr><td style="text-align: left"><code>t_start</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">start time of <code>line</code> to use [s]</td></tr><tr><td style="text-align: left"><code>t_end</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">end time of <code>line</code> to use [s]</td></tr><tr><td style="text-align: left"><code>full_line</code></td><td style="text-align: left"><code>Bool</code></td><td style="text-align: left">(optional) if true, <code>t_start</code> to <code>t_end</code> is full line</td></tr><tr><td style="text-align: left"><code>map_name</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) name of magnetic anomaly map relevant to <code>line</code></td></tr><tr><td style="text-align: left"><code>map_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) type of magnetic anomaly map for <code>map_name</code> {<code>drape</code>,<code>HAE</code>}</td></tr><tr><td style="text-align: left"><code>line_alt</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">(optional) nominal altitude of <code>line</code> [m]</td></tr></table><ul><li><code>df_flight</code>: lookup table (DataFrame) of flight data HDF5 files</li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>flight</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">flight name (e.g., <code>:Flt1001</code>)</td></tr><tr><td style="text-align: left"><code>xyz_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">subtype of <code>XYZ</code> to use for flight data {<code>:XYZ0</code>,<code>:XYZ1</code>,<code>:XYZ20</code>,<code>:XYZ21</code>}</td></tr><tr><td style="text-align: left"><code>xyz_set</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">flight dataset number (used to prevent inproper mixing of datasets, such as different magnetometer locations)</td></tr><tr><td style="text-align: left"><code>xyz_h5</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of flight data HDF5 file (<code>.h5</code> extension optional)</td></tr></table><ul><li><code>df_map</code>: lookup table (DataFrame) of map data HDF5 files</li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>map_name</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">name of magnetic anomaly map</td></tr><tr><td style="text-align: left"><code>map_h5</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of map data HDF5 file (<code>.h5</code> extension optional)</td></tr><tr><td style="text-align: left"><code>map_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) type of magnetic anomaly map {<code>drape</code>,<code>HAE</code>}</td></tr><tr><td style="text-align: left"><code>map_alt</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">(optional) map altitude, -1 for drape map [m]</td></tr></table><ul><li><code>l_window</code>: (optional) temporal window length, only used for <code>model_type = :m3w, :m3tf</code></li><li><code>silent</code>: (optional) if true, no print outs</li></ul><p><strong>Returns:</strong></p><ul><li><code>y</code>: length <code>N</code> target vector</li><li><code>y_hat</code>: length <code>N</code> prediction vector</li><li><code>err</code>: length <code>N</code> mean-corrected (per line) compensation error</li><li><code>features</code>: length <code>Nf</code> feature vector (including components of TL <code>A</code>, etc.)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MIT-AI-Accelerator/MagNav.jl/blob/8e7e1a31a9660beb0fda834738e63b014751cd3a/src/compensation.jl#L3403-L3449">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../maps/">« Magnetic Anomaly Maps</a><a class="docs-footer-nextpage" href="../nncomp/">NN-Based Model Diagrams »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 03:56">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
silent::Bool = false)</code></pre><p>Evaluate performance of an aeromagnetic compensation model.</p><p><strong>Arguments:</strong></p><ul><li><code>comp_params</code>: <code>CompParams</code> aeromagnetic compensation parameters struct, either:<ul><li><code>NNCompParams</code>: neural network-based aeromagnetic compensation parameters struct</li><li><code>LinCompParams</code>: linear aeromagnetic compensation parameters struct</li></ul></li><li><code>lines</code>: selected line number(s)</li><li><code>df_line</code>: lookup table (DataFrame) of <code>lines</code></li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>flight</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">flight name (e.g., <code>:Flt1001</code>)</td></tr><tr><td style="text-align: left"><code>line</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">line number, i.e., segments within <code>flight</code></td></tr><tr><td style="text-align: left"><code>t_start</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">start time of <code>line</code> to use [s]</td></tr><tr><td style="text-align: left"><code>t_end</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">end time of <code>line</code> to use [s]</td></tr><tr><td style="text-align: left"><code>full_line</code></td><td style="text-align: left"><code>Bool</code></td><td style="text-align: left">(optional) if true, <code>t_start</code> to <code>t_end</code> is full line</td></tr><tr><td style="text-align: left"><code>map_name</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) name of magnetic anomaly map relevant to <code>line</code></td></tr><tr><td style="text-align: left"><code>map_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) type of magnetic anomaly map for <code>map_name</code> {<code>drape</code>,<code>HAE</code>}</td></tr><tr><td style="text-align: left"><code>line_alt</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">(optional) nominal altitude of <code>line</code> [m]</td></tr></table><ul><li><code>df_flight</code>: lookup table (DataFrame) of flight data HDF5 files</li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>flight</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">flight name (e.g., <code>:Flt1001</code>)</td></tr><tr><td style="text-align: left"><code>xyz_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">subtype of <code>XYZ</code> to use for flight data {<code>:XYZ0</code>,<code>:XYZ1</code>,<code>:XYZ20</code>,<code>:XYZ21</code>}</td></tr><tr><td style="text-align: left"><code>xyz_set</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">flight dataset number (used to prevent inproper mixing of datasets, such as different magnetometer locations)</td></tr><tr><td style="text-align: left"><code>xyz_h5</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of flight data HDF5 file (<code>.h5</code> extension optional)</td></tr></table><ul><li><code>df_map</code>: lookup table (DataFrame) of map data HDF5 files</li></ul><table><tr><th style="text-align: left"><strong>Field</strong></th><th style="text-align: left"><strong>Type</strong></th><th style="text-align: left"><strong>Description</strong></th></tr><tr><td style="text-align: left"><code>map_name</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">name of magnetic anomaly map</td></tr><tr><td style="text-align: left"><code>map_h5</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of map data HDF5 file (<code>.h5</code> extension optional)</td></tr><tr><td style="text-align: left"><code>map_type</code></td><td style="text-align: left"><code>Symbol</code></td><td style="text-align: left">(optional) type of magnetic anomaly map {<code>drape</code>,<code>HAE</code>}</td></tr><tr><td style="text-align: left"><code>map_alt</code></td><td style="text-align: left"><code>Real</code></td><td style="text-align: left">(optional) map altitude, -1 for drape map [m]</td></tr></table><ul><li><code>l_window</code>: (optional) temporal window length, only used for <code>model_type = :m3w, :m3tf</code></li><li><code>silent</code>: (optional) if true, no print outs</li></ul><p><strong>Returns:</strong></p><ul><li><code>y</code>: length <code>N</code> target vector</li><li><code>y_hat</code>: length <code>N</code> prediction vector</li><li><code>err</code>: length <code>N</code> mean-corrected (per line) compensation error</li><li><code>features</code>: length <code>Nf</code> feature vector (including components of TL <code>A</code>, etc.)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MIT-AI-Accelerator/MagNav.jl/blob/8e7e1a31a9660beb0fda834738e63b014751cd3a/src/compensation.jl#L3403-L3449">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../maps/">« Magnetic Anomaly Maps</a><a class="docs-footer-nextpage" href="../nncomp/">NN-Based Model Diagrams »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 15:00">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit f391900

Please sign in to comment.