Skip to content

Commit

Permalink
build based on 7800a8d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 7, 2023
1 parent fadcc92 commit d364288
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions dev/API/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/GettingStarted/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
params[:path_sensit] = params[:root_path] * params[:subject] * "/Results/senseMap_GRE.jld2"
params[:path_noise] = params[:root_path] * params[:subject] * "/Results/noisemat.jld2"
params[:path_results] = params[:root_path] * params[:subject] * "/Results/"
params[:file_name] = &quot;gre2D&quot;</code></pre><h2 id="User-examples"><a class="docs-heading-anchor" href="#User-examples">User examples</a><a id="User-examples-1"></a><a class="docs-heading-anchor-permalink" href="#User-examples" title="Permalink"></a></h2><p>Three user examples are available in the folder <a href="https://github.com/NordicMRspine/UserExample_MRINavigator">user examples</a>:</p><ul><li><strong>Compact</strong>: runs all the selected pipeline automatically but it is not customizable and not amenable to debugging.</li><li><strong>Semi-Compact</strong>: allows for some level of customization and it is easy to debug.</li><li><strong>Complete</strong>: requires more knowledge of the data structures but it is flexible and adaptable.</li></ul><h2 id="Disclaimer"><a class="docs-heading-anchor" href="#Disclaimer">Disclaimer</a><a id="Disclaimer-1"></a><a class="docs-heading-anchor-permalink" href="#Disclaimer" title="Permalink"></a></h2><p>Siemens data only were used to develop MRINavigator. All the functions to adjust the data before running the pipeline (e.g., the function to extract the navigator profiles or to remove the reference profiles) have been tested on Siemens data only. There is no guarantee that all of these functions are needed and will work on other vendors data. Other vendors users should convert the raw data in <a href="https://ismrmrd.readthedocs.io/en/latest/index.html">ISMRMRD</a> format and when loading these into the Julia framework they should make sure that all the needed information is present. Please start from the <a href="https://github.com/NordicMRspine/UserExample_MRINavigator">complete user example</a> if doing this. The functions to compute and apply the corrections should then work correctly.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../Pipelines/">Pipelines »</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="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 0.27.25 on <span class="colophon-date" title="Wednesday 6 September 2023 22:31">Wednesday 6 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
params[:file_name] = &quot;gre2D&quot;</code></pre><h2 id="User-examples"><a class="docs-heading-anchor" href="#User-examples">User examples</a><a id="User-examples-1"></a><a class="docs-heading-anchor-permalink" href="#User-examples" title="Permalink"></a></h2><p>Three user examples are available in the folder <a href="https://github.com/NordicMRspine/UserExample_MRINavigator">user examples</a>:</p><ul><li><strong>Compact</strong>: runs all the selected pipeline automatically but it is not customizable and not amenable to debugging.</li><li><strong>Semi-Compact</strong>: allows for some level of customization and it is easy to debug.</li><li><strong>Complete</strong>: requires more knowledge of the data structures but it is flexible and adaptable.</li></ul><h2 id="Disclaimer"><a class="docs-heading-anchor" href="#Disclaimer">Disclaimer</a><a id="Disclaimer-1"></a><a class="docs-heading-anchor-permalink" href="#Disclaimer" title="Permalink"></a></h2><p>Siemens data only were used to develop MRINavigator. All the functions to adjust the data before running the pipeline (e.g., the function to extract the navigator profiles or to remove the reference profiles) have been tested on Siemens data only. There is no guarantee that all of these functions are needed and will work on other vendors data. Other vendors users should convert the raw data in <a href="https://ismrmrd.readthedocs.io/en/latest/index.html">ISMRMRD</a> format and when loading these into the Julia framework they should make sure that all the needed information is present. Please start from the <a href="https://github.com/NordicMRspine/UserExample_MRINavigator">complete user example</a> if doing this. The functions to compute and apply the corrections should then work correctly.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../Pipelines/">Pipelines »</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="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 0.27.25 on <span class="colophon-date" title="Thursday 7 September 2023 12:10">Thursday 7 September 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit d364288

Please sign in to comment.