deploy: 498c177

.buildinfo

@@ -1,4 +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: 3fd053babd2b4a4967d2d5054654753a
+config: 054452c29a0c8f9f1b6840e43727e05b
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/autoapi/overlappogram/cli/index.rst.txt

@@ -1,34 +1,94 @@
-:py:mod:`overlappogram.cli`
-===========================
+overlappogram.cli
+=================
 
 .. py:module:: overlappogram.cli
 
 
-Module Contents
----------------
+Attributes
+----------
 
+.. autoapisummary::
 
-Functions
-~~~~~~~~~
+   overlappogram.cli.NUMPY_THREAD_COUNT
+   overlappogram.cli.MODE_MAPPING
 
-.. autoapisummary::
 
-   overlappogram.cli.unfold
+Classes
+-------
+
+.. autoapisummary::
 
+   overlappogram.cli.Inverter
 
 
-Attributes
-~~~~~~~~~~
+Functions
+---------
 
 .. autoapisummary::
 
-   overlappogram.cli.NUMPY_THREAD_COUNT
+   overlappogram.cli.load_overlappogram
+   overlappogram.cli.save_em_cube
+   overlappogram.cli.save_spectral_cube
+   overlappogram.cli.load_response_cube
+   overlappogram.cli.save_prediction
+   overlappogram.cli.create_spectrally_pure_images
+   overlappogram.cli.unfold
+
 
+Module Contents
+---------------
 
 .. py:data:: NUMPY_THREAD_COUNT
    :value: 1
 
-
+
+.. py:data:: MODE_MAPPING
+
+.. py:class:: Inverter(response_cube: ndcube.NDCube, solution_fov_width: int = 1, smooth_over: str = 'dependence', response_dependency_list: list = None, field_angle_range: list = None, detector_row_range: list = None)
+
+   .. py:property:: is_inverted
+      :type: bool
+
+
+
+   .. py:method:: _invert_image_row(row_index, chunk_index)
+
+
+   .. py:method:: _progress_indicator(future)
+
+      used in multithreading to track progress of inversion
+
+
+
+   .. py:method:: _switch_to_row_inversion(model_config, alpha, rho, num_row_threads=50)
+
+
+   .. py:method:: _collect_results(mode_switch_thread_count, model_config, alpha, rho)
+
+
+   .. py:method:: _start_row_inversion(model_config, alpha, rho, num_threads)
+
+
+   .. py:method:: _start_chunk_inversion(model_config, alpha, rho, num_threads)
+
+
+   .. py:method:: _initialize_with_overlappogram(overlappogram)
+
+
+   .. py:method:: invert(overlappogram: ndcube.NDCube, model_config, alpha, rho, num_threads: int = 1, mode_switch_thread_count: int = 0, mode: InversionMode = InversionMode.HYBRID) -> (ndcube.NDCube, ndcube.NDCube, numpy.ndarray, list[int])
+
+
+.. py:function:: load_overlappogram(image_path, weights_path) -> ndcube.NDCube
+
+.. py:function:: save_em_cube(cube, path, overwrite=True) -> None
+
+.. py:function:: save_spectral_cube(spectral_cube, path, overwrite=True) -> None
+
+.. py:function:: load_response_cube(path) -> ndcube.NDCube
+
+.. py:function:: save_prediction(prediction, path, overwrite=True) -> None
+
+.. py:function:: create_spectrally_pure_images(image_list: list, gnt_path: str, rsp_dep_list: list)
 
 .. py:function:: unfold(config)
 

_sources/autoapi/overlappogram/index.rst.txt

@@ -1,51 +1,49 @@
-:py:mod:`overlappogram`
-=======================
+overlappogram
+=============
 
 .. py:module:: overlappogram
 
 
 Submodules
 ----------
+
 .. toctree::
-   :titlesonly:
    :maxdepth: 1
 
-   cli/index.rst
-   inversion/index.rst
-   io/index.rst
-   response/index.rst
-   spectral/index.rst
-
+   /autoapi/overlappogram/cli/index
+   /autoapi/overlappogram/inversion/index
+   /autoapi/overlappogram/io/index
+   /autoapi/overlappogram/response/index
+   /autoapi/overlappogram/spectral/index
 
-Package Contents
-----------------
 
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
    overlappogram.Inverter
 
 
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    overlappogram.load_overlappogram
    overlappogram.load_response_cube
 
 
+Package Contents
+----------------
 
 .. py:class:: Inverter(response_cube: ndcube.NDCube, solution_fov_width: int = 1, smooth_over: str = 'dependence', response_dependency_list: list = None, field_angle_range: list = None, detector_row_range: list = None)
 
-
    .. py:property:: is_inverted
       :type: bool
 
 
+
    .. py:method:: _invert_image_row(row_index, chunk_index)
 
 
@@ -54,6 +52,7 @@ Functions
       used in multithreading to track progress of inversion
 
 
+
    .. py:method:: _switch_to_row_inversion(model_config, alpha, rho, num_row_threads=50)
 
 
@@ -72,10 +71,7 @@ Functions
    .. py:method:: invert(overlappogram: ndcube.NDCube, model_config, alpha, rho, num_threads: int = 1, mode_switch_thread_count: int = 0, mode: InversionMode = InversionMode.HYBRID) -> (ndcube.NDCube, ndcube.NDCube, numpy.ndarray, list[int])
 
 
-
 .. py:function:: load_overlappogram(image_path, weights_path) -> ndcube.NDCube
 
-
 .. py:function:: load_response_cube(path) -> ndcube.NDCube
 
-

_sources/autoapi/overlappogram/inversion/index.rst.txt

@@ -1,29 +1,27 @@
-:py:mod:`overlappogram.inversion`
-=================================
+overlappogram.inversion
+=======================
 
 .. py:module:: overlappogram.inversion
 
 
-Module Contents
----------------
-
 Classes
-~~~~~~~
+-------
 
 .. autoapisummary::
 
    overlappogram.inversion.Inverter
 
 
-
+Module Contents
+---------------
 
 .. py:class:: Inverter(response_cube: ndcube.NDCube, solution_fov_width: int = 1, smooth_over: str = 'dependence', response_dependency_list: list = None, field_angle_range: list = None, detector_row_range: list = None)
 
-
    .. py:property:: is_inverted
       :type: bool
 
 
+
    .. py:method:: _invert_image_row(row_index, chunk_index)
 
 
@@ -32,6 +30,7 @@ Classes
       used in multithreading to track progress of inversion
 
 
+
    .. py:method:: _switch_to_row_inversion(model_config, alpha, rho, num_row_threads=50)
 
 
@@ -50,4 +49,3 @@ Classes
    .. py:method:: invert(overlappogram: ndcube.NDCube, model_config, alpha, rho, num_threads: int = 1, mode_switch_thread_count: int = 0, mode: InversionMode = InversionMode.HYBRID) -> (ndcube.NDCube, ndcube.NDCube, numpy.ndarray, list[int])
 
 
-

_sources/autoapi/overlappogram/io/index.rst.txt

@@ -1,15 +1,11 @@
-:py:mod:`overlappogram.io`
-==========================
+overlappogram.io
+================
 
 .. py:module:: overlappogram.io
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
@@ -20,19 +16,16 @@ Functions
    overlappogram.io.save_spectral_cube
 
 
+Module Contents
+---------------
 
 .. py:function:: load_overlappogram(image_path, weights_path) -> ndcube.NDCube
 
-
 .. py:function:: load_response_cube(path) -> ndcube.NDCube
 
-
 .. py:function:: save_em_cube(cube, path, overwrite=True) -> None
 
-
 .. py:function:: save_prediction(prediction, path, overwrite=True) -> None
 
-
 .. py:function:: save_spectral_cube(spectral_cube, path, overwrite=True) -> None
 
-

_sources/autoapi/overlappogram/response/index.rst.txt

@@ -1,22 +1,19 @@
-:py:mod:`overlappogram.response`
-================================
+overlappogram.response
+======================
 
 .. py:module:: overlappogram.response
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    overlappogram.response.prepare_response_function
 
 
+Module Contents
+---------------
 
 .. py:function:: prepare_response_function(response_cube: ndcube.NDCube, field_angle_range=None, response_dependency_list=None, fov_width=2) -> (numpy.ndarray, float, float)
 
-

_sources/autoapi/overlappogram/spectral/index.rst.txt

@@ -1,22 +1,19 @@
-:py:mod:`overlappogram.spectral`
-================================
+overlappogram.spectral
+======================
 
 .. py:module:: overlappogram.spectral
 
 
-Module Contents
----------------
-
-
 Functions
-~~~~~~~~~
+---------
 
 .. autoapisummary::
 
    overlappogram.spectral.create_spectrally_pure_images
 
 
+Module Contents
+---------------
 
 .. py:function:: create_spectrally_pure_images(image_list: list, gnt_path: str, rsp_dep_list: list)
 
-

autoapi/index.html

@@ -373,12 +373,12 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
-<li class="toctree-l1 has-children"><a class="reference internal" href="overlappogram/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram</span></code></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="overlappogram/cli/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.cli</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/inversion/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.inversion</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/io/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.io</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/response/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.response</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/spectral/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.spectral</span></code></a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="overlappogram/index.html">overlappogram</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="overlappogram/cli/index.html">overlappogram.cli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/inversion/index.html">overlappogram.inversion</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/io/index.html">overlappogram.io</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/response/index.html">overlappogram.response</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/spectral/index.html">overlappogram.spectral</a></li>
 </ul>
 </li>
 </ul>
@@ -440,12 +440,12 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
 <p>This page contains auto-generated API reference documentation <a class="footnote-reference brackets" href="#f1" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.</p>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="overlappogram/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram</span></code></a><ul>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/cli/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.cli</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/inversion/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.inversion</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/io/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.io</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/response/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.response</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="overlappogram/spectral/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram.spectral</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="overlappogram/index.html">overlappogram</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/cli/index.html">overlappogram.cli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/inversion/index.html">overlappogram.inversion</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/io/index.html">overlappogram.io</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/response/index.html">overlappogram.response</a></li>
+<li class="toctree-l2"><a class="reference internal" href="overlappogram/spectral/index.html">overlappogram.spectral</a></li>
 </ul>
 </li>
 </ul>
@@ -482,7 +482,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title"><code class="xref py py-mod docutils literal notranslate"><span class="pre">overlappogram</span></code></p>
+        <p class="prev-next-title">overlappogram</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>