Update documentation

dkazanc · Dec 20, 2024 · 299ad17 · 299ad17
commit 299ad17
Show file tree

Hide file tree

Showing 281 changed files with 37,145 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7c7f0320fb5af9c9e11dbccb27b2479d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api/tomobar.astra_wrappers.astra_base.doctree b/.doctrees/api/tomobar.astra_wrappers.astra_base.doctree
diff --git a/.doctrees/api/tomobar.astra_wrappers.astra_tools2d.doctree b/.doctrees/api/tomobar.astra_wrappers.astra_tools2d.doctree
diff --git a/.doctrees/api/tomobar.astra_wrappers.astra_tools3d.doctree b/.doctrees/api/tomobar.astra_wrappers.astra_tools3d.doctree
diff --git a/.doctrees/api/tomobar.astra_wrappers.doctree b/.doctrees/api/tomobar.astra_wrappers.doctree
diff --git a/.doctrees/api/tomobar.cuda_kernels.doctree b/.doctrees/api/tomobar.cuda_kernels.doctree
diff --git a/.doctrees/api/tomobar.doctree b/.doctrees/api/tomobar.doctree
diff --git a/.doctrees/api/tomobar.fourier.doctree b/.doctrees/api/tomobar.fourier.doctree
diff --git a/.doctrees/api/tomobar.methodsDIR.doctree b/.doctrees/api/tomobar.methodsDIR.doctree
diff --git a/.doctrees/api/tomobar.methodsDIR_CuPy.doctree b/.doctrees/api/tomobar.methodsDIR_CuPy.doctree
diff --git a/.doctrees/api/tomobar.methodsIR.doctree b/.doctrees/api/tomobar.methodsIR.doctree
diff --git a/.doctrees/api/tomobar.methodsIR_CuPy.doctree b/.doctrees/api/tomobar.methodsIR_CuPy.doctree
diff --git a/.doctrees/api/tomobar.regularisers.doctree b/.doctrees/api/tomobar.regularisers.doctree
diff --git a/.doctrees/api/tomobar.regularisersCuPy.doctree b/.doctrees/api/tomobar.regularisersCuPy.doctree
diff --git a/.doctrees/api/tomobar.supp.dicts.doctree b/.doctrees/api/tomobar.supp.dicts.doctree
diff --git a/.doctrees/api/tomobar.supp.doctree b/.doctrees/api/tomobar.supp.doctree
diff --git a/.doctrees/api/tomobar.supp.funcs.doctree b/.doctrees/api/tomobar.supp.funcs.doctree
diff --git a/.doctrees/api/tomobar.supp.suppTools.doctree b/.doctrees/api/tomobar.supp.suppTools.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/howto/installation.doctree b/.doctrees/howto/installation.doctree
diff --git a/.doctrees/howto/use.doctree b/.doctrees/howto/use.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/introduction/about.doctree b/.doctrees/introduction/about.doctree
diff --git a/.doctrees/introduction/dependencies.doctree b/.doctrees/introduction/dependencies.doctree
diff --git a/.doctrees/introduction/references.doctree b/.doctrees/introduction/references.doctree
diff --git a/.doctrees/reference/api.doctree b/.doctrees/reference/api.doctree
diff --git a/.doctrees/tutorials/basic_iter_recon.doctree b/.doctrees/tutorials/basic_iter_recon.doctree
diff --git a/.doctrees/tutorials/direct_recon.doctree b/.doctrees/tutorials/direct_recon.doctree
diff --git a/.doctrees/tutorials/real_data_recon.doctree b/.doctrees/tutorials/real_data_recon.doctree
diff --git a/.doctrees/tutorials/regul_iter_recon.doctree b/.doctrees/tutorials/regul_iter_recon.doctree
diff --git a/.doctrees/tutorials/synthetic_recon.doctree b/.doctrees/tutorials/synthetic_recon.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/FBP_dendr.jpg b/_images/FBP_dendr.jpg
diff --git a/_images/FBP_recon.png b/_images/FBP_recon.png
diff --git a/_images/FISTA_GH_TV_dendr.jpg b/_images/FISTA_GH_TV_dendr.jpg
diff --git a/_images/FISTA_SWLS_TV_dendr.jpg b/_images/FISTA_SWLS_TV_dendr.jpg
diff --git a/_images/FISTA_TV_dendr.jpg b/_images/FISTA_TV_dendr.jpg
diff --git a/_images/PWLS_TV_WV_recon.png b/_images/PWLS_TV_WV_recon.png
diff --git a/_images/PWLS_TV_recon.png b/_images/PWLS_TV_recon.png
diff --git a/_images/SWLS_TV_WV_recon.png b/_images/SWLS_TV_WV_recon.png
diff --git a/_images/TomoRec_surf2.jpg b/_images/TomoRec_surf2.jpg
diff --git a/_images/phantom3d.png b/_images/phantom3d.png
diff --git a/_images/projdata_backgr.png b/_images/projdata_backgr.png
diff --git a/_images/projdata_norm.jpg b/_images/projdata_norm.jpg
diff --git a/_images/recsFISTA_stud.png b/_images/recsFISTA_stud.png
diff --git a/_images/sinogram3d.png b/_images/sinogram3d.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,367 @@
+
+<!DOCTYPE html>
+
+
+<html lang="en" data-content_root="../" >
+
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; Tomobar Documentation page</title>
+
+
+
+  <script data-cfasync="false">
+    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
+    document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
+  </script>
+  <!--
+    this give us a css class that will be invisible only if js is disabled
+  -->
+  <noscript>
+    <style>
+      .pst-js-only { display: none !important; }
+
+    </style>
+  </noscript>
+
+  <!-- Loaded before other Sphinx assets -->
+  <link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
+<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
+
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />
+    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/general.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
+
+  <!-- So that users can add custom icons -->
+  <script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
+  <!-- Pre-loaded scripts that we'll load fully later -->
+  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
+<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
+
+    <script src="../_static/documentation_options.js?v=58f36ac1"></script>
+    <script src="../_static/doctools.js?v=9bcbadda"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
+    <script src="../_static/copybutton.js?v=f281be69"></script>
+    <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
+    <script src="../_static/design-tabs.js?v=f930bc37"></script>
+    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
+    <link rel="icon" href="../_static/tomobar_logo_light.png"/>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1"/>
+  <meta name="docsearch:language" content="en"/>
+  <meta name="docsearch:version" content="" />
+    <meta name="docbuild:last-update" content="Dec 20, 2024"/>
+  </head>
+
+
+  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
+
+
+
+  <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
+
+  <div id="pst-scroll-pixel-helper"></div>
+
+  <button type="button" class="btn rounded-pill" id="pst-back-to-top">
+    <i class="fa-solid fa-arrow-up"></i>Back to top</button>
+
+
+  <dialog id="pst-search-dialog">
+
+<form class="bd-search d-flex align-items-center"
+      action="../search.html"
+      method="get">
+  <i class="fa-solid fa-magnifying-glass"></i>
+  <input type="search"
+         class="form-control"
+         name="q"
+         placeholder="Search..."
+         aria-label="Search..."
+         autocomplete="off"
+         autocorrect="off"
+         autocapitalize="off"
+         spellcheck="false"/>
+  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
+</form>
+  </dialog>
+
+  <div class="pst-async-banner-revealer d-none">
+  <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
+</div>
+
+
+    <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
+    </header>
+
+
+  <div class="bd-container">
+    <div class="bd-container__inner bd-page-width">
+
+
+
+
+
+      <dialog id="pst-primary-sidebar-modal"></dialog>
+      <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
+
+
+
+  <div class="sidebar-header-items sidebar-primary__section">
+
+
+
+
+  </div>
+
+    <div class="sidebar-primary-items__start sidebar-primary__section">
+        <div class="sidebar-primary-item">
+
+
+
+
+
+<a class="navbar-brand logo" href="../index.html">
+
+
+
+
+
+
+
+
+
+
+    <img src="../_static/tomobar_logo_light.png" class="logo__image only-light" alt="Tomobar Documentation page - Home"/>
+    <img src="../_static/tomobar_logo_dark.png" class="logo__image only-dark pst-js-only" alt="Tomobar Documentation page - Home"/>
+
+
+</a></div>
+        <div class="sidebar-primary-item">
+
+<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
+ <i class="fa-solid fa-magnifying-glass"></i>
+ <span class="search-button__default-text">Search</span>
+ <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
+</button></div>
+        <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
+    <div class="bd-toc-item navbar-nav active">
+        <p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../introduction/about.html">About ToMoBAR</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/dependencies.html">Dependencies</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/references.html">References</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">How To's</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../howto/installation.html">Installation Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../howto/use.html">Using ToMoBAR</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/direct_recon.html">Direct reconstruction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/basic_iter_recon.html">Basic iterative reconstruction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/regul_iter_recon.html">Regularised iterative reconstruction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/synthetic_recon.html">Synthethic data reconstruction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/real_data_recon.html">Real data reconstruction</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference guides</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/api.html">API reference</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.methodsDIR.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.methodsDIR</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.methodsDIR_CuPy.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.methodsDIR_CuPy</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.methodsIR.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.methodsIR</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.methodsIR_CuPy.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.methodsIR_CuPy</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.regularisers.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.regularisers</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.regularisersCuPy.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.regularisersCuPy</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.supp.dicts.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.supp.dicts</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/tomobar.supp.suppTools.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomobar.supp.suppTools</span></code></a></li>
+</ul>
+</details></li>
+</ul>
+
+    </div>
+</nav></div>
+    </div>
+
+
+  <div class="sidebar-primary-items__end sidebar-primary__section">
+      <div class="sidebar-primary-item">
+<div id="ethical-ad-placement"
+      class="flat"
+      data-ea-publisher="readthedocs"
+      data-ea-type="readthedocs-sidebar"
+      data-ea-manual="true">
+</div></div>
+  </div>
+
+
+      </div>
+
+      <main id="main-content" class="bd-main" role="main">
+
+
+
+<div class="sbt-scroll-pixel-helper"></div>
+
+          <div class="bd-content">
+            <div class="bd-article-container">
+
+              <div class="bd-header-article d-print-none">
+<div class="header-article-items header-article__inner">
+
+    <div class="header-article-items__start">
+
+        <div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
+  <span class="fa-solid fa-bars"></span>
+</button></div>
+
+    </div>
+
+
+    <div class="header-article-items__end">
+
+        <div class="header-article-item">
+
+<div class="article-header-buttons">
+
+
+
+<button onclick="toggleFullScreen()"
+  class="btn btn-sm btn-fullscreen-button"
+  title="Fullscreen mode"
+  data-bs-placement="bottom" data-bs-toggle="tooltip"
+>
+
+
+<span class="btn__icon-container">
+  <i class="fas fa-expand"></i>
+  </span>
+
+</button>
+
+
+
+<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode"  data-bs-placement="bottom" data-bs-toggle="tooltip">
+  <i class="theme-switch fa-solid fa-sun                fa-lg" data-mode="light" title="Light"></i>
+  <i class="theme-switch fa-solid fa-moon               fa-lg" data-mode="dark"  title="Dark"></i>
+  <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"  title="System Settings"></i>
+</button>
+
+
+<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
+    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
+</button>
+
+</div></div>
+
+    </div>
+
+</div>
+</div>
+
+
+
+<div id="jb-print-docs-body" class="onlyprint">
+    <h1></h1>
+    <!-- Table of contents -->
+    <div id="print-main-content">
+        <div id="jb-print-toc">
+
+        </div>
+    </div>
+</div>
+
+
+
+<div id="searchbox"></div>
+                <article class="bd-article">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="tomobar/cuda_kernels.html">tomobar.cuda_kernels</a></li>
+<li><a href="tomobar/fourier.html">tomobar.fourier</a></li>
+<li><a href="tomobar/methodsDIR.html">tomobar.methodsDIR</a></li>
+<li><a href="tomobar/methodsDIR_CuPy.html">tomobar.methodsDIR_CuPy</a></li>
+<li><a href="tomobar/methodsIR.html">tomobar.methodsIR</a></li>
+<li><a href="tomobar/methodsIR_CuPy.html">tomobar.methodsIR_CuPy</a></li>
+<li><a href="tomobar/regularisers.html">tomobar.regularisers</a></li>
+<li><a href="tomobar/regularisersCuPy.html">tomobar.regularisersCuPy</a></li>
+<li><a href="tomobar/supp/dicts.html">tomobar.supp.dicts</a></li>
+<li><a href="tomobar/supp/suppTools.html">tomobar.supp.suppTools</a></li>
+</ul>
+
+                </article>
+
+
+
+
+
+
+                <footer class="prev-next-footer d-print-none">
+
+<div class="prev-next-area">
+</div>
+                </footer>
+
+            </div>
+
+
+
+
+          </div>
+          <footer class="bd-footer-content">
+
+<div class="bd-footer-content__inner container">
+
+  <div class="footer-item">
+
+<p class="component-author">
+By Daniil Kazantsev
+</p>
+
+  </div>
+
+  <div class="footer-item">
+
+
+  <p class="copyright">
+
+      © Copyright 2024, Diamond Light Source and Manchester University, UK.
+      <br/>
+
+  </p>
+
+  </div>
+
+  <div class="footer-item">
+    <p class="last-updated">
+  Last updated on Dec 20, 2024.
+  <br/>
+</p>
+  </div>
+
+  <div class="footer-item">
+
+  </div>
+
+</div>
+          </footer>
+
+
+      </main>
+    </div>
+  </div>
+
+  <!-- Scripts loaded after <body> so the DOM is not blocked -->
+  <script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
+<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
+
+  <footer class="bd-footer">
+  </footer>
+  </body>
+</html>