Update documentation

DiamondLightSource · May 23, 2024 · 478107c · 478107c
commit 478107c
Show file tree

Hide file tree

Showing 253 changed files with 39,486 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 009d47f1aabaf16891a980a7721f2e5e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api/httomolibgpu.cuda_kernels.doctree b/.doctrees/api/httomolibgpu.cuda_kernels.doctree
diff --git a/.doctrees/api/httomolibgpu.cupywrapper.doctree b/.doctrees/api/httomolibgpu.cupywrapper.doctree
diff --git a/.doctrees/api/httomolibgpu.doctree b/.doctrees/api/httomolibgpu.doctree
diff --git a/.doctrees/api/httomolibgpu.misc.corr.doctree b/.doctrees/api/httomolibgpu.misc.corr.doctree
diff --git a/.doctrees/api/httomolibgpu.misc.doctree b/.doctrees/api/httomolibgpu.misc.doctree
diff --git a/.doctrees/api/httomolibgpu.misc.morph.doctree b/.doctrees/api/httomolibgpu.misc.morph.doctree
diff --git a/.doctrees/api/httomolibgpu.misc.rescale.doctree b/.doctrees/api/httomolibgpu.misc.rescale.doctree
diff --git a/.doctrees/api/httomolibgpu.prep.alignment.doctree b/.doctrees/api/httomolibgpu.prep.alignment.doctree
diff --git a/.doctrees/api/httomolibgpu.prep.doctree b/.doctrees/api/httomolibgpu.prep.doctree
diff --git a/.doctrees/api/httomolibgpu.prep.normalize.doctree b/.doctrees/api/httomolibgpu.prep.normalize.doctree
diff --git a/.doctrees/api/httomolibgpu.prep.phase.doctree b/.doctrees/api/httomolibgpu.prep.phase.doctree
diff --git a/.doctrees/api/httomolibgpu.prep.stripe.doctree b/.doctrees/api/httomolibgpu.prep.stripe.doctree
diff --git a/.doctrees/api/httomolibgpu.recon.algorithm.doctree b/.doctrees/api/httomolibgpu.recon.algorithm.doctree
diff --git a/.doctrees/api/httomolibgpu.recon.doctree b/.doctrees/api/httomolibgpu.recon.doctree
diff --git a/.doctrees/api/httomolibgpu.recon.rotation.doctree b/.doctrees/api/httomolibgpu.recon.rotation.doctree
diff --git a/.doctrees/bibliography/biblio.doctree b/.doctrees/bibliography/biblio.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples/DistortionCorr.doctree b/.doctrees/examples/DistortionCorr.doctree
diff --git a/.doctrees/examples/pipeline1_FBP.doctree b/.doctrees/examples/pipeline1_FBP.doctree
diff --git a/.doctrees/examples/pipeline2_iterative.doctree b/.doctrees/examples/pipeline2_iterative.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/nbsphinx/examples/DistortionCorr.ipynb b/.doctrees/nbsphinx/examples/DistortionCorr.ipynb
diff --git a/.doctrees/nbsphinx/examples/pipeline1_FBP.ipynb b/.doctrees/nbsphinx/examples/pipeline1_FBP.ipynb
diff --git a/.doctrees/nbsphinx/examples/pipeline2_iterative.ipynb b/.doctrees/nbsphinx/examples/pipeline2_iterative.ipynb
diff --git a/.doctrees/nbsphinx/examples_DistortionCorr_1_0.png b/.doctrees/nbsphinx/examples_DistortionCorr_1_0.png
diff --git a/.doctrees/nbsphinx/examples_DistortionCorr_1_1.png b/.doctrees/nbsphinx/examples_DistortionCorr_1_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline1_FBP_2_1.png b/.doctrees/nbsphinx/examples_pipeline1_FBP_2_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline1_FBP_4_1.png b/.doctrees/nbsphinx/examples_pipeline1_FBP_4_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline1_FBP_5_1.png b/.doctrees/nbsphinx/examples_pipeline1_FBP_5_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline1_FBP_6_1.png b/.doctrees/nbsphinx/examples_pipeline1_FBP_6_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline2_iterative_2_1.png b/.doctrees/nbsphinx/examples_pipeline2_iterative_2_1.png
diff --git a/.doctrees/nbsphinx/examples_pipeline2_iterative_4_1.png b/.doctrees/nbsphinx/examples_pipeline2_iterative_4_1.png
diff --git a/.doctrees/reference/api.doctree b/.doctrees/reference/api.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/examples_DistortionCorr_1_0.png b/_images/examples_DistortionCorr_1_0.png
diff --git a/_images/examples_DistortionCorr_1_1.png b/_images/examples_DistortionCorr_1_1.png
diff --git a/_images/examples_pipeline1_FBP_2_1.png b/_images/examples_pipeline1_FBP_2_1.png
diff --git a/_images/examples_pipeline1_FBP_4_1.png b/_images/examples_pipeline1_FBP_4_1.png
diff --git a/_images/examples_pipeline1_FBP_5_1.png b/_images/examples_pipeline1_FBP_5_1.png
diff --git a/_images/examples_pipeline1_FBP_6_1.png b/_images/examples_pipeline1_FBP_6_1.png
diff --git a/_images/examples_pipeline2_iterative_2_1.png b/_images/examples_pipeline2_iterative_2_1.png
diff --git a/_images/examples_pipeline2_iterative_4_1.png b/_images/examples_pipeline2_iterative_4_1.png
diff --git a/_modules/httomolibgpu/cuda_kernels.html b/_modules/httomolibgpu/cuda_kernels.html
diff --git a/_modules/httomolibgpu/misc/corr.html b/_modules/httomolibgpu/misc/corr.html
diff --git a/_modules/httomolibgpu/misc/morph.html b/_modules/httomolibgpu/misc/morph.html
diff --git a/_modules/httomolibgpu/misc/rescale.html b/_modules/httomolibgpu/misc/rescale.html
diff --git a/_modules/httomolibgpu/prep/alignment.html b/_modules/httomolibgpu/prep/alignment.html
diff --git a/_modules/httomolibgpu/prep/normalize.html b/_modules/httomolibgpu/prep/normalize.html
diff --git a/_modules/httomolibgpu/prep/phase.html b/_modules/httomolibgpu/prep/phase.html
diff --git a/_modules/httomolibgpu/prep/stripe.html b/_modules/httomolibgpu/prep/stripe.html
diff --git a/_modules/httomolibgpu/recon/algorithm.html b/_modules/httomolibgpu/recon/algorithm.html
diff --git a/_modules/httomolibgpu/recon/rotation.html b/_modules/httomolibgpu/recon/rotation.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,336 @@
+
+
+<!DOCTYPE html>
+
+
+<html lang="en" >
+
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; HTTomolibgpu Documentation page</title>
+
+
+
+  <script data-cfasync="false">
+    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
+    document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
+  </script>
+
+  <!-- Loaded before other Sphinx assets -->
+  <link href="../_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
+<link href="../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
+<link href="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
+
+
+  <link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
+  <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
+
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
+    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/css/general.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
+
+  <!-- Pre-loaded scripts that we'll load fully later -->
+  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
+<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
+
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/clipboard.min.js"></script>
+    <script src="../_static/copybutton.js"></script>
+    <script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></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="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"/>
+  </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="">
+
+
+
+  <a class="skip-link" href="#main-content">Skip to main content</a>
+
+  <input type="checkbox"
+          class="sidebar-toggle"
+          name="__primary"
+          id="__primary"/>
+  <label class="overlay overlay-primary" for="__primary"></label>
+
+  <input type="checkbox"
+          class="sidebar-toggle"
+          name="__secondary"
+          id="__secondary"/>
+  <label class="overlay overlay-secondary" for="__secondary"></label>
+
+  <div class="search-button__wrapper">
+    <div class="search-button__overlay"></div>
+    <div class="search-button__search-container">
+<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"
+         id="search-input"
+         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></div>
+  </div>
+
+    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
+    </nav>
+
+  <div class="bd-container">
+    <div class="bd-container__inner bd-page-width">
+
+      <div 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">
+
+
+
+
+
+    <p class="title logo__title">HTTomolibgpu Documentation page</p>
+
+</a></div>
+        <div class="sidebar-primary-item"><nav class="bd-links" id="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">HTTomolibGPU</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Examples</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../examples/pipeline1_FBP.html">Example 1 (FBP and Fourier)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/pipeline2_iterative.html">Example 2 (Iterative Rec)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/DistortionCorr.html">Example 3 (Distortion corr)</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><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.misc.corr.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.misc.corr</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.misc.morph.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.misc.morph</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.misc.rescale.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.misc.rescale</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.prep.alignment.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.prep.alignment</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.prep.normalize.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.prep.normalize</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.prep.phase.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.prep.phase</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.prep.stripe.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.prep.stripe</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.recon.algorithm.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.recon.algorithm</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/httomolibgpu.recon.rotation.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">httomolibgpu.recon.rotation</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../bibliography/biblio.html">Bibliography</a></li>
+</ul>
+
+    </div>
+</nav></div>
+    </div>
+
+
+  <div class="sidebar-primary-items__end sidebar-primary__section">
+  </div>
+
+  <div id="rtd-footer-container"></div>
+
+
+      </div>
+
+      <main id="main-content" class="bd-main">
+
+
+
+<div class="sbt-scroll-pixel-helper"></div>
+
+          <div class="bd-content">
+            <div class="bd-article-container">
+
+              <div class="bd-header-article">
+<div class="header-article-items header-article__inner">
+
+    <div class="header-article-items__start">
+
+        <div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
+  <span class="fa-solid fa-bars"></span>
+</label></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>
+
+
+<script>
+document.write(`
+  <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
+    <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
+    <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
+    <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
+  </button>
+`);
+</script>
+
+<script>
+document.write(`
+  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
+    <i class="fa-solid fa-magnifying-glass"></i>
+  </button>
+`);
+</script>
+
+</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" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="httomolibgpu/cuda_kernels.html">httomolibgpu.cuda_kernels</a></li>
+<li><a href="httomolibgpu/misc/corr.html">httomolibgpu.misc.corr</a></li>
+<li><a href="httomolibgpu/misc/morph.html">httomolibgpu.misc.morph</a></li>
+<li><a href="httomolibgpu/misc/rescale.html">httomolibgpu.misc.rescale</a></li>
+<li><a href="httomolibgpu/prep/alignment.html">httomolibgpu.prep.alignment</a></li>
+<li><a href="httomolibgpu/prep/normalize.html">httomolibgpu.prep.normalize</a></li>
+<li><a href="httomolibgpu/prep/phase.html">httomolibgpu.prep.phase</a></li>
+<li><a href="httomolibgpu/prep/stripe.html">httomolibgpu.prep.stripe</a></li>
+<li><a href="httomolibgpu/recon/algorithm.html">httomolibgpu.recon.algorithm</a></li>
+<li><a href="httomolibgpu/recon/rotation.html">httomolibgpu.recon.rotation</a></li>
+</ul>
+
+                </article>
+
+
+
+
+                <footer class="bd-footer-article">
+
+<div class="footer-article-items footer-article__inner">
+
+    <div class="footer-article-item"><!-- Previous / next buttons -->
+<div class="prev-next-area">
+</div></div>
+
+</div>
+
+                </footer>
+
+            </div>
+
+
+
+
+          </div>
+          <footer class="bd-footer-content">
+
+<div class="bd-footer-content__inner container">
+
+  <div class="footer-item">
+
+  </div>
+
+  <div class="footer-item">
+
+  <p class="copyright">
+
+      © Copyright 2024, Diamond Light Source.
+      <br/>
+
+  </p>
+
+  </div>
+
+  <div class="footer-item">
+    <p class="last-updated">
+  Last updated on May 23, 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 src="../_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
+<script src="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
+
+  <footer class="bd-footer">
+  </footer>
+  </body>
+</html>
diff --git a/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css
diff --git a/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css
diff --git a/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css
@@ -0,0 +1,7 @@
+:root {
+--tabs-color-label-active: hsla(231, 99%, 66%, 1);
+--tabs-color-label-inactive: rgba(178, 206, 245, 0.62);
+--tabs-color-overline: rgb(207, 236, 238);
+--tabs-color-underline: rgb(207, 236, 238);
+--tabs-size-label: 1rem;
+}
diff --git a/_sources/api/httomolibgpu.cuda_kernels.rst b/_sources/api/httomolibgpu.cuda_kernels.rst
@@ -0,0 +1,10 @@
+httomolibgpu.cuda\_kernels package
+==================================
+
+Module contents
+---------------
+
+.. automodule:: httomolibgpu.cuda_kernels
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/httomolibgpu.cupywrapper.rst b/_sources/api/httomolibgpu.cupywrapper.rst
@@ -0,0 +1,6 @@
+:mod:`httomolibgpu.cupywrapper`
+============================================
+.. automodule:: httomolibgpu.cupywrapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/httomolibgpu.misc.corr.rst b/_sources/api/httomolibgpu.misc.corr.rst
@@ -0,0 +1,6 @@
+:mod:`httomolibgpu.misc.corr`
+============================================
+.. automodule:: httomolibgpu.misc.corr
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/httomolibgpu.misc.morph.rst b/_sources/api/httomolibgpu.misc.morph.rst
@@ -0,0 +1,6 @@
+:mod:`httomolibgpu.misc.morph`
+============================================
+.. automodule:: httomolibgpu.misc.morph
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/httomolibgpu.misc.rescale.rst b/_sources/api/httomolibgpu.misc.rescale.rst
@@ -0,0 +1,6 @@
+:mod:`httomolibgpu.misc.rescale`
+============================================
+.. automodule:: httomolibgpu.misc.rescale
+   :members:
+   :undoc-members:
+   :show-inheritance: