build based on 419ff53

dev/api/index.html

@@ -104,4 +104,4 @@
 
 julia> raw = simulate(obj, seq, sys)
 
-julia&gt; plot_signal(raw)</code></pre></div></section></article><h3 id="plot_image"><a class="docs-heading-anchor" href="#plot_image"><code>plot_image</code></a><a id="plot_image-1"></a><a class="docs-heading-anchor-permalink" href="#plot_image" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="KomaMRIPlots.plot_image" href="#KomaMRIPlots.plot_image"><code>KomaMRIPlots.plot_image</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">p = plot_image(image; height, width, zmin, zmax, darkmode, title)</code></pre><p>Plots an image matrix.</p><p><strong>Arguments</strong></p><ul><li><code>image</code>: (<code>::Matrix{Float64}</code>) image matrix</li></ul><p><strong>Keywords</strong></p><ul><li><code>height</code>: (<code>::Int64</code>, <code>=750</code>) height of the plot</li><li><code>width</code>: (<code>::Int64</code>, <code>=nothing</code>) width of the plot</li><li><code>zmin</code>: (<code>::Float64</code>, <code>=minimum(abs.(image[:]))</code>) reference value for minimum color</li><li><code>zmax</code>: (<code>::Float64</code>, <code>=maximum(abs.(image[:]))</code>) reference value for maximum color</li><li><code>darkmode</code>: (<code>::Bool</code>, <code>=false</code>) boolean to define colors for darkmode</li><li><code>title</code>: (<code>::String</code>, <code>=&quot;&quot;</code>) title of the plot</li></ul><p><strong>Returns</strong></p><ul><li><code>p</code>: (<code>::PlotlyJS.SyncPlot</code>) plot of the image matrix</li></ul></div></section></article><h2 id="UI"><a class="docs-heading-anchor" href="#UI">UI</a><a id="UI-1"></a><a class="docs-heading-anchor-permalink" href="#UI" title="Permalink"></a></h2><h3 id="KomaUI"><a class="docs-heading-anchor" href="#KomaUI"><code>KomaUI</code></a><a id="KomaUI-1"></a><a class="docs-heading-anchor-permalink" href="#KomaUI" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="KomaMRI.KomaUI" href="#KomaMRI.KomaUI"><code>KomaMRI.KomaUI</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">out = KomaUI(; kwargs...)</code></pre><p>Launch the Koma&#39;s UI.</p><p><strong>Keywords</strong></p><ul><li><code>darkmode</code>: (<code>::Bool</code>, <code>=true</code>) define dark mode style for the UI</li><li><code>frame</code>: (<code>::Bool</code>, <code>=true</code>) display the upper frame of the Blink window</li><li><code>phantom_mode</code>: (<code>::String</code>, <code>=&quot;2D&quot;</code>, opts=[<code>&quot;2D&quot;</code>, <code>&quot;3D&quot;</code>]) load the default phantom as a   2D or 3D brain example</li><li><code>sim</code>: (<code>::Dict{String,Any}</code>, <code>=Dict{String,Any}()</code>) simulation parameters dictionary</li><li><code>rec</code>: (<code>::Dict{Symbol,Any}</code>, <code>=Dict{Symbol,Any}()</code>) reconstruction parameters dictionary</li><li><code>return_window</code>: (<code>::Bool</code>, <code>=false</code>) make the <code>out</code> be either &#39;nothing&#39; or the Blink window,   depending on whether the <code>return_window</code> keyword argument is set to true</li><li><code>show_window</code>: (<code>::Bool</code>, <code>=true</code>) display the Blink window</li></ul><p><strong>Returns</strong></p><ul><li><code>out</code>: (<code>::Nothing</code> or <code>::Blink.AtomShell.Window</code>) returns either &#39;nothing&#39; or the Blink   window, depending on whether the <code>return_window</code> keyword argument is set to true.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; KomaUI()</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cncastillo/KomaMRI.jl/blob/bc89b7732b3e9ed7312db79132d6c5f0338766f4/src/KomaUI.jl#L8-L32">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../mri-theory/">« Simulation</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 15 November 2023 13:51">Wednesday 15 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; plot_signal(raw)</code></pre></div></section></article><h3 id="plot_image"><a class="docs-heading-anchor" href="#plot_image"><code>plot_image</code></a><a id="plot_image-1"></a><a class="docs-heading-anchor-permalink" href="#plot_image" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="KomaMRIPlots.plot_image" href="#KomaMRIPlots.plot_image"><code>KomaMRIPlots.plot_image</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">p = plot_image(image; height, width, zmin, zmax, darkmode, title)</code></pre><p>Plots an image matrix.</p><p><strong>Arguments</strong></p><ul><li><code>image</code>: (<code>::Matrix{Float64}</code>) image matrix</li></ul><p><strong>Keywords</strong></p><ul><li><code>height</code>: (<code>::Int64</code>, <code>=750</code>) height of the plot</li><li><code>width</code>: (<code>::Int64</code>, <code>=nothing</code>) width of the plot</li><li><code>zmin</code>: (<code>::Float64</code>, <code>=minimum(abs.(image[:]))</code>) reference value for minimum color</li><li><code>zmax</code>: (<code>::Float64</code>, <code>=maximum(abs.(image[:]))</code>) reference value for maximum color</li><li><code>darkmode</code>: (<code>::Bool</code>, <code>=false</code>) boolean to define colors for darkmode</li><li><code>title</code>: (<code>::String</code>, <code>=&quot;&quot;</code>) title of the plot</li></ul><p><strong>Returns</strong></p><ul><li><code>p</code>: (<code>::PlotlyJS.SyncPlot</code>) plot of the image matrix</li></ul></div></section></article><h2 id="UI"><a class="docs-heading-anchor" href="#UI">UI</a><a id="UI-1"></a><a class="docs-heading-anchor-permalink" href="#UI" title="Permalink"></a></h2><h3 id="KomaUI"><a class="docs-heading-anchor" href="#KomaUI"><code>KomaUI</code></a><a id="KomaUI-1"></a><a class="docs-heading-anchor-permalink" href="#KomaUI" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="KomaMRI.KomaUI" href="#KomaMRI.KomaUI"><code>KomaMRI.KomaUI</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">out = KomaUI(; kwargs...)</code></pre><p>Launch the Koma&#39;s UI.</p><p><strong>Keywords</strong></p><ul><li><code>darkmode</code>: (<code>::Bool</code>, <code>=true</code>) define dark mode style for the UI</li><li><code>frame</code>: (<code>::Bool</code>, <code>=true</code>) display the upper frame of the Blink window</li><li><code>phantom_mode</code>: (<code>::String</code>, <code>=&quot;2D&quot;</code>, opts=[<code>&quot;2D&quot;</code>, <code>&quot;3D&quot;</code>]) load the default phantom as a   2D or 3D brain example</li><li><code>sim</code>: (<code>::Dict{String,Any}</code>, <code>=Dict{String,Any}()</code>) simulation parameters dictionary</li><li><code>rec</code>: (<code>::Dict{Symbol,Any}</code>, <code>=Dict{Symbol,Any}()</code>) reconstruction parameters dictionary</li><li><code>return_window</code>: (<code>::Bool</code>, <code>=false</code>) make the <code>out</code> be either &#39;nothing&#39; or the Blink window,   depending on whether the <code>return_window</code> keyword argument is set to true</li><li><code>show_window</code>: (<code>::Bool</code>, <code>=true</code>) display the Blink window</li></ul><p><strong>Returns</strong></p><ul><li><code>out</code>: (<code>::Nothing</code> or <code>::Blink.AtomShell.Window</code>) returns either &#39;nothing&#39; or the Blink   window, depending on whether the <code>return_window</code> keyword argument is set to true.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; KomaUI()</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/cncastillo/KomaMRI.jl/blob/419ff530e21e4f880aeed81445f0dd4cc4e7499b/src/KomaUI.jl#L8-L32">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../mri-theory/">« Simulation</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 15 November 2023 13:52">Wednesday 15 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>