build based on f2bb44d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-07T10:16:13","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-14T14:00:34","documenter_version":"1.8.0"}}

dev/basicReconstruction.html

@@ -16,4 +16,4 @@
   spectralCleaning=true, fgFrames=1:10, bgCorrectionInternal=false,
   noiseFreqThresh=0.0, kargs...)</code></pre><p>This function is responsible for loading the measurement data and potential background data that is subtracted from the measurements. For any frame to be reconstructed, the low level reconstruction routine is called.</p><h2 id="Low-Level-Reconstruction"><a class="docs-heading-anchor" href="#Low-Level-Reconstruction">Low Level Reconstruction</a><a id="Low-Level-Reconstruction-1"></a><a class="docs-heading-anchor-permalink" href="#Low-Level-Reconstruction" title="Permalink"></a></h2><p>Finally, we have arrived at the low level reconstruction routine that has the signature</p><pre><code class="language-julia hljs">function reconstruction(S, u::Array; sparseTrafo = nothing,
                         lambd=0, progress=nothing, solver = &quot;Kaczmarz&quot;,
-                        weights=nothing, kargs...)</code></pre><p>One can see that it requires the system matrix <code>S</code> and the measurements <code>u</code> to be already loaded.</p><p>We note that <code>S</code> is typeless for a reason here. For a regular reconstruction one will basically feed in an <code>Array{ComplexF32,2}</code> in here, although more precisely it will be a <code>Transposed</code> version of that type if the <code>Kaczmarz</code> algorithm is being used for efficiency reasons.</p><p>However, in case that matrix compression is applied <code>S</code> will be of type <code>SparseMatrixCSC</code>. And for <a href="multiPatch.html#Multi-Patch-Reconstruction">Multi-Patch Reconstruction</a> <code>S</code> will be of type <code>MultiPatchOperator</code>. Hence, the solvers are implemented in a very generic way and require only certain functions to be implemented. The low level reconstruction method calls one of the solvers from <a href="https://github.com/tknopp/RegularizedLeastSquares.jl">RegularizedLeastSquares.jl</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="overview.html">« Getting Started</a><a class="docs-footer-nextpage" href="parameters.html">Parameters »</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.7.0 on <span class="colophon-date" title="Thursday 7 November 2024 10:16">Thursday 7 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                        weights=nothing, kargs...)</code></pre><p>One can see that it requires the system matrix <code>S</code> and the measurements <code>u</code> to be already loaded.</p><p>We note that <code>S</code> is typeless for a reason here. For a regular reconstruction one will basically feed in an <code>Array{ComplexF32,2}</code> in here, although more precisely it will be a <code>Transposed</code> version of that type if the <code>Kaczmarz</code> algorithm is being used for efficiency reasons.</p><p>However, in case that matrix compression is applied <code>S</code> will be of type <code>SparseMatrixCSC</code>. And for <a href="multiPatch.html#Multi-Patch-Reconstruction">Multi-Patch Reconstruction</a> <code>S</code> will be of type <code>MultiPatchOperator</code>. Hence, the solvers are implemented in a very generic way and require only certain functions to be implemented. The low level reconstruction method calls one of the solvers from <a href="https://github.com/tknopp/RegularizedLeastSquares.jl">RegularizedLeastSquares.jl</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="overview.html">« Getting Started</a><a class="docs-footer-nextpage" href="parameters.html">Parameters »</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.8.0 on <span class="colophon-date" title="Thursday 14 November 2024 14:00">Thursday 14 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>