- 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>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></table><ul><li><code>df_flight</code>: lookup table (DataFrame) of flight data 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 improper mixing of datasets, such as different magnetometer locations)</td></tr><tr><td style="text-align: left"><code>xyz_file</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of flight data CSV, HDF5, or MAT file (<code>.csv</code>, <code>.h5</code>, or <code>.mat</code> extension required)</td></tr></table><ul><li><code>df_map</code>: lookup table (DataFrame) of map data 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_file</code></td><td style="text-align: left"><code>String</code></td><td style="text-align: left">path/name of map data HDF5 or MAT file (<code>.h5</code> or <code>.mat</code> extension required)</td></tr></table><ul><li><code>temp_params</code>: (optional) <code>TempParams</code> temporary temporal parameters struct</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/464b4862b5ade55a8e90da2b1f9c1d2100ed51ad/src/compensation.jl#L3580-L3621">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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Tuesday 1 July 2025 04:51">Tuesday 1 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0 commit comments