-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jul 13, 2023
1 parent
7877bb6
commit 727462e
Showing
6 changed files
with
7 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · EPGsim.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://aTrotier.github.io/EPGsim.jl/API/"/><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="../">EPGsim.jl</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="../regular/">Regular EPG </a></li><li><a class="tocitem" href="../AD/">Automatic Differentiation</a></li><li class="is-active"><a class="tocitem" href>API</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>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/aTrotier/EPGsim.jl/blob/main/docs/src/API.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"><ul><li><a href="#EPGsim.EPGStates"><code>EPGsim.EPGStates</code></a></li><li><a href="#EPGsim.EPGStates-Union{Tuple{}, Tuple{T}, Tuple{T, T}, Tuple{T, T, T}} where T<:Number"><code>EPGsim.EPGStates</code></a></li><li><a href="#EPGsim.epgDephasing"><code>EPGsim.epgDephasing</code></a></li><li><a href="#EPGsim.epgRelaxation-Tuple{EPGStates, Any, Any, Any}"><code>EPGsim.epgRelaxation</code></a></li><li><a href="#EPGsim.epgRotation"><code>EPGsim.epgRotation</code></a></li><li><a href="#EPGsim.rfRotation"><code>EPGsim.rfRotation</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="EPGsim.EPGStates" href="#EPGsim.EPGStates"><code>EPGsim.EPGStates</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">EPGStates{T <: Real}</code></pre><p>Stores the EPG states in 3 vectors Fp,Fn and Z.</p><p><strong>Constructors :</strong></p><pre><code class="nohighlight hljs">EPGStates(Fp::Vector{Complex{S}},Fn::Vector{Complex{S}},Z::Vector{Complex{S}}) where {S <: Real} | ||
| EPGStates(Fp::T=0,Fn::T=0,Z::T=1) where T <: Number</code></pre><p><strong>Fields</strong></p><ul><li><code>Fp::Vector{Complex{T}}</code></li><li><code>Fn::Vector{Complex{T}}</code></li><li><code>Z::Vector{Complex{T}}</code></li></ul><p><strong>Related functions</strong></p><ul><li><code>getStates(E::EPGStates)</code> : extract EPG states as matrix 3xN</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L4-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.EPGStates-Union{Tuple{}, Tuple{T}, Tuple{T, T}, Tuple{T, T, T}} where T<:Number" href="#EPGsim.EPGStates-Union{Tuple{}, Tuple{T}, Tuple{T, T}, Tuple{T, T, T}} where T<:Number"><code>EPGsim.EPGStates</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">getStates(E::EPGStates)</code></pre><p>Extract EPG states as matrix 3xN</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L38-L42">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgDephasing" href="#EPGsim.epgDephasing"><code>EPGsim.epgDephasing</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">epgDephasing(E::EPGStates, n=1) where T</code></pre><p>shifts the transverse dephasing states <code>F</code> corresponding to n dephasing-cycles. n can be any integer</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L53-L58">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgRelaxation-Tuple{EPGStates, Any, Any, Any}" href="#EPGsim.epgRelaxation-Tuple{EPGStates, Any, Any, Any}"><code>EPGsim.epgRelaxation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">epgRelaxation(E::EPGStates,t,T1, T2)</code></pre><p>applies relaxation matrices to a set of EPG states.</p><p><strong>Arguments</strong></p><ul><li><code>E::EPGStates</code></li><li><code>t::AbstractFloat</code> - length of time interval</li><li><code>T1::AbstractFloat</code> - T1</li><li><code>T2::AbstractFloat</code> - T2</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L91-L101">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgRotation" href="#EPGsim.epgRotation"><code>EPGsim.epgRotation</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">epgRotation(E::EPGStates, alpha::Float64, phi::Float64=0.0)</code></pre><p>applies Bloch-rotation (<=> RF pulse) to a set of EPG states.</p><p><strong>Arguments</strong></p><ul><li><code>E::EPGStates</code>`</li><li><code>alpha::Float64</code> - flip angle of the RF pulse (rad)</li><li><code>phi::Float64=0.0</code> - phase of the RF pulse (rad)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L128-L137">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.rfRotation" href="#EPGsim.rfRotation"><code>EPGsim.rfRotation</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">rfRotation(alpha, phi=0.)</code></pre><p>returns the rotation matrix for a pulse with flip angle <code>alpha</code> and phase <code>phi</code>.</p><p><strong>Arguments</strong></p><ul><li><code>alpha</code> - flip angle (radian)</li><li><code>phi=0.</code> - phase of the flip angle (radian)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/ef4b5cd201e225d8cdf15f82e97419fae0e961a4/src/RegularEPG.jl#L112-L120">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../AD/">« Automatic Differentiation</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 13 July 2023 10:28">Thursday 13 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| EPGStates(Fp::T=0,Fn::T=0,Z::T=1) where T <: Number</code></pre><p><strong>Fields</strong></p><ul><li><code>Fp::Vector{Complex{T}}</code></li><li><code>Fn::Vector{Complex{T}}</code></li><li><code>Z::Vector{Complex{T}}</code></li></ul><p><strong>Related functions</strong></p><ul><li><code>getStates(E::EPGStates)</code> : extract EPG states as matrix 3xN</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L4-L20">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.EPGStates-Union{Tuple{}, Tuple{T}, Tuple{T, T}, Tuple{T, T, T}} where T<:Number" href="#EPGsim.EPGStates-Union{Tuple{}, Tuple{T}, Tuple{T, T}, Tuple{T, T, T}} where T<:Number"><code>EPGsim.EPGStates</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">getStates(E::EPGStates)</code></pre><p>Extract EPG states as matrix 3xN</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L38-L42">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgDephasing" href="#EPGsim.epgDephasing"><code>EPGsim.epgDephasing</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">epgDephasing(E::EPGStates, n=1) where T</code></pre><p>shifts the transverse dephasing states <code>F</code> corresponding to n dephasing-cycles. n can be any integer</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L53-L58">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgRelaxation-Tuple{EPGStates, Any, Any, Any}" href="#EPGsim.epgRelaxation-Tuple{EPGStates, Any, Any, Any}"><code>EPGsim.epgRelaxation</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">epgRelaxation(E::EPGStates,t,T1, T2)</code></pre><p>applies relaxation matrices to a set of EPG states.</p><p><strong>Arguments</strong></p><ul><li><code>E::EPGStates</code></li><li><code>t::AbstractFloat</code> - length of time interval</li><li><code>T1::AbstractFloat</code> - T1</li><li><code>T2::AbstractFloat</code> - T2</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L91-L101">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.epgRotation" href="#EPGsim.epgRotation"><code>EPGsim.epgRotation</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">epgRotation(E::EPGStates, alpha::Float64, phi::Float64=0.0)</code></pre><p>applies Bloch-rotation (<=> RF pulse) to a set of EPG states.</p><p><strong>Arguments</strong></p><ul><li><code>E::EPGStates</code>`</li><li><code>alpha::Float64</code> - flip angle of the RF pulse (rad)</li><li><code>phi::Float64=0.0</code> - phase of the RF pulse (rad)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L128-L137">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="EPGsim.rfRotation" href="#EPGsim.rfRotation"><code>EPGsim.rfRotation</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">rfRotation(alpha, phi=0.)</code></pre><p>returns the rotation matrix for a pulse with flip angle <code>alpha</code> and phase <code>phi</code>.</p><p><strong>Arguments</strong></p><ul><li><code>alpha</code> - flip angle (radian)</li><li><code>phi=0.</code> - phase of the flip angle (radian)</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aTrotier/EPGsim.jl/blob/e667f9fbec1f88347e5e9f76e0fcbf7728f52563/src/RegularEPG.jl#L112-L120">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../AD/">« Automatic Differentiation</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 13 July 2023 11:39">Thursday 13 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.