Skip to content

Commit

Permalink
build based on d0c901b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 30, 2024
1 parent 3c93420 commit 8fc7f25
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion previews/PR12/GIRFApplier/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>GIRFApplier · MRIGradients Documentation</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">MRIGradients Documentation</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../GIRFEssential/">GIRFEssential</a></li><li class="is-active"><a class="tocitem" href>GIRFApplier</a></li><li><a class="tocitem" href="../Utilities/">Utilities</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>GIRFApplier</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>GIRFApplier</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/BRAIN-TO/MRIGradients.jl/blob/main/docs/src/GIRFApplier.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-binding" id="MRIGradients.apply_girf-Tuple{GirfApplier, Vararg{Any, 4}}" href="#MRIGradients.apply_girf-Tuple{GirfApplier, Vararg{Any, 4}}"><code>MRIGradients.apply_girf</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">apply_girf(g::GirfApplier, gradient_in, time_in, time_out, direction)

Function for predicting the gradient by applying the GIRF
This is done in one dimension only. Repeat this function for multiple dimensions</code></pre><p><strong>Arguments</strong></p><ul><li><code>g::GirfApplier</code> - GirfApplier containing GIRF data</li><li><code>gradient_in</code> - input gradient waveform corresponding to time_in vector</li><li><code>time_in</code> - time vector corresponding to input gradient waveform</li><li><code>time_out</code> - output time vector desired (decimation)</li><li><code>direction</code> - direction of the GIRF to use (x,y,z etc...)</li></ul><p><strong>Outputs:</strong></p><ul><li><code>grad_OUT_resampled</code> - Vector, gradient waveform with GIRF applied, in the time points of <code>time_out</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/BRAIN-TO/MRIGradients.jl/blob/217e5e827cab3ee2fbbf5b09d44d3e09d2d10853/src/GIRFApplier.jl#L15-L29">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../GIRFEssential/">« GIRFEssential</a><a class="docs-footer-nextpage" href="../Utilities/">Utilities »</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="Tuesday 30 January 2024 19:42">Tuesday 30 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
This is done in one dimension only. Repeat this function for multiple dimensions</code></pre><p><strong>Arguments</strong></p><ul><li><code>g::GirfApplier</code> - GirfApplier containing GIRF data</li><li><code>gradient_in</code> - input gradient waveform corresponding to time_in vector</li><li><code>time_in</code> - time vector corresponding to input gradient waveform</li><li><code>time_out</code> - output time vector desired (decimation)</li><li><code>direction</code> - direction of the GIRF to use (x,y,z etc...)</li></ul><p><strong>Outputs:</strong></p><ul><li><code>grad_OUT_resampled</code> - Vector, gradient waveform with GIRF applied, in the time points of <code>time_out</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/BRAIN-TO/MRIGradients.jl/blob/d0c901b27b0ba96a5f7876a61d9cb645f8f01d76/src/GIRFApplier.jl#L15-L29">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../GIRFEssential/">« GIRFEssential</a><a class="docs-footer-nextpage" href="../Utilities/">Utilities »</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="Tuesday 30 January 2024 21:05">Tuesday 30 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 8fc7f25

Please sign in to comment.