From a266d0ba02478d5155386d1a07dada194003fecb Mon Sep 17 00:00:00 2001 From: jmbhughes Date: Tue, 28 May 2024 14:34:59 +0000 Subject: [PATCH] deploy: 498c177d4fa26ef8d57230e708021eb3f1d7f793 --- .buildinfo | 2 +- .../autoapi/overlappogram/cli/index.rst.txt | 84 ++++++-- _sources/autoapi/overlappogram/index.rst.txt | 32 ++- .../overlappogram/inversion/index.rst.txt | 16 +- .../autoapi/overlappogram/io/index.rst.txt | 17 +- .../overlappogram/response/index.rst.txt | 13 +- .../overlappogram/spectral/index.rst.txt | 13 +- autoapi/index.html | 26 +-- autoapi/overlappogram/cli/index.html | 185 +++++++++++++++--- autoapi/overlappogram/index.html | 68 ++++--- autoapi/overlappogram/inversion/index.html | 54 +++-- autoapi/overlappogram/io/index.html | 44 ++--- autoapi/overlappogram/response/index.html | 36 ++-- autoapi/overlappogram/spectral/index.html | 34 ++-- genindex.html | 70 +++++-- index.html | 2 +- objects.inv | Bin 858 -> 944 bytes searchindex.js | 2 +- 18 files changed, 453 insertions(+), 245 deletions(-) diff --git a/.buildinfo b/.buildinfo index 7fba667..cd139fc 100644 --- a/.buildinfo +++ b/.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 diff --git a/_sources/autoapi/overlappogram/cli/index.rst.txt b/_sources/autoapi/overlappogram/cli/index.rst.txt index 5a77c5e..fa72e34 100644 --- a/_sources/autoapi/overlappogram/cli/index.rst.txt +++ b/_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) diff --git a/_sources/autoapi/overlappogram/index.rst.txt b/_sources/autoapi/overlappogram/index.rst.txt index 9fa0286..b71ec26 100644 --- a/_sources/autoapi/overlappogram/index.rst.txt +++ b/_sources/autoapi/overlappogram/index.rst.txt @@ -1,36 +1,32 @@ -: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:: @@ -38,14 +34,16 @@ Functions 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 - diff --git a/_sources/autoapi/overlappogram/inversion/index.rst.txt b/_sources/autoapi/overlappogram/inversion/index.rst.txt index 2ea42f5..3b71231 100644 --- a/_sources/autoapi/overlappogram/inversion/index.rst.txt +++ b/_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]) - diff --git a/_sources/autoapi/overlappogram/io/index.rst.txt b/_sources/autoapi/overlappogram/io/index.rst.txt index 94fc0a0..f2ba881 100644 --- a/_sources/autoapi/overlappogram/io/index.rst.txt +++ b/_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 - diff --git a/_sources/autoapi/overlappogram/response/index.rst.txt b/_sources/autoapi/overlappogram/response/index.rst.txt index 1d92a28..f4411e6 100644 --- a/_sources/autoapi/overlappogram/response/index.rst.txt +++ b/_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) - diff --git a/_sources/autoapi/overlappogram/spectral/index.rst.txt b/_sources/autoapi/overlappogram/spectral/index.rst.txt index 7b382f8..a4a74fa 100644 --- a/_sources/autoapi/overlappogram/spectral/index.rst.txt +++ b/_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) - diff --git a/autoapi/index.html b/autoapi/index.html index a43d58f..165213a 100644 --- a/autoapi/index.html +++ b/autoapi/index.html @@ -373,12 +373,12 @@ aria-label="Section Navigation">

Section Navigation

@@ -442,11 +442,9 @@
-

overlappogram.io#

-
-

Module Contents#

+

overlappogram.io#

-

Functions#

+

Functions#

@@ -466,6 +464,9 @@

Functions +

Module Contents#

overlappogram.io.load_overlappogram(image_path, weights_path) → ndcube.NDCube#
@@ -491,7 +492,6 @@

Functionsoverlappogram.io.save_spectral_cube(spectral_cube, path, overwrite=True) → None#

- @@ -511,7 +511,7 @@

Functions

previous

-

overlappogram.inversion

+

overlappogram.inversion

 Functions

next

-

overlappogram.response

+

overlappogram.response

 @@ -541,15 +541,13 @@

Functions diff --git a/autoapi/overlappogram/response/index.html b/autoapi/overlappogram/response/index.html index 6aaeec0..33b3b15 100644 --- a/autoapi/overlappogram/response/index.html +++ b/autoapi/overlappogram/response/index.html @@ -373,12 +373,12 @@ aria-label="Section Navigation">

Section Navigation

@@ -442,11 +442,9 @@

load_overlappogram(→ ndcube.NDCube)

@@ -454,12 +452,14 @@

Functions +

Module Contents#

overlappogram.response.prepare_response_function(response_cube: ndcube.NDCube, field_angle_range=None, response_dependency_list=None, fov_width=2)#
- @@ -479,7 +479,7 @@

Functions

previous

-

overlappogram.io

+

overlappogram.io

 Functions

next

-

overlappogram.spectral

+

overlappogram.spectral

 @@ -509,11 +509,9 @@

Functions diff --git a/autoapi/overlappogram/spectral/index.html b/autoapi/overlappogram/spectral/index.html index 542b287..41659fc 100644 --- a/autoapi/overlappogram/spectral/index.html +++ b/autoapi/overlappogram/spectral/index.html @@ -372,12 +372,12 @@ aria-label="Section Navigation">

Section Navigation

@@ -441,11 +441,9 @@

prepare_response_function(response_cube[, ...])

@@ -453,12 +451,14 @@

Functions +

Module Contents#

overlappogram.spectral.create_spectrally_pure_images(image_list: list, gnt_path: str, rsp_dep_list: list)#
- @@ -478,7 +478,7 @@

Functions

previous

-

overlappogram.response

+

overlappogram.response

 @@ -499,11 +499,9 @@

Functions diff --git a/genindex.html b/genindex.html index 26ac9f7..a47dbb3 100644 --- a/genindex.html +++ b/genindex.html @@ -404,47 +404,61 @@

Index

_

create_spectrally_pure_images(image_list, gnt_path, ...)
    -
  • _start_chunk_inversion() (overlappogram.inversion.Inverter method) +
  • _start_chunk_inversion() (overlappogram.cli.Inverter method)
    • -
  • _start_row_inversion() (overlappogram.inversion.Inverter method) +
  • _start_row_inversion() (overlappogram.cli.Inverter method)
    • -
  • _switch_to_row_inversion() (overlappogram.inversion.Inverter method) +
  • _switch_to_row_inversion() (overlappogram.cli.Inverter method)
    • @@ -454,31 +468,41 @@

    _

    C

    I

      -
    • is_inverted (overlappogram.inversion.Inverter property) +
    • is_inverted (overlappogram.cli.Inverter property)
      • @@ -491,6 +515,8 @@

      L

    • load_overlappogram() (in module overlappogram)
      • @@ -499,6 +525,8 @@

      L

    • load_response_cube() (in module overlappogram)
      • @@ -508,6 +536,8 @@

      L

      M

      diff --git a/objects.inv b/objects.inv index fe7f0b99fafc2905f508024175d6d31825083d8b..6be646605a5dac7ac7b6b2b22c457fd1b744a2e4 100644 GIT binary patch delta 833 zcmV-H1HSy)2CxT^e1Dd~a@!yfhVMKDo%U*{z2=rlGK~+8J!vwXo-_olZKg;t0y%L` zeT}|epQOkbTZ&~1ka81f`ThlVmlbO$IFV8;3zA{Exy(dba=>3PDYYPyU5L8H1Su7d%1@oAD$!Lk&fRqns#(zjf12W5x*;oCDQK0e`CGT5a6~y%K3(Fw2={ zgtIqDUYK4b;^;I6lBvEDmXReSg?Jf`EDJLON*RfiQKCgL99wB(oTjTX|7~}mn8=65 zo74CZxVcWcO0@VO0ehpv;nXfhAg!3@R;3wi;;57}k3=?BUde3i0uuTi^*k;nu>%GA zCU~%1aH0n)M1LiGphj%sN6CcdXQ)VYAqW%lE(n3xz{21~pU!S>lj+rbKDqy1QB$Hx zKjQt@$(=DKYhN;z=zKl8~*Hdkz;SIlNoVe=a>%X5wgzID{!6h z*xZ;TrhhBk`@Q$q$M-hPV=;Gq9-DBcUYl^n19ZA=x|N`_-cDns)5}y)JUU)o$IvlQP+mfgi|;D6d8HdRv-RxF~%oKK02Sn9%AB*ia$p9skWY+t3%0~0ZchM2MZRFmEs~RG;1$%)m45}P0^ddSb$t>wOzI9DuYI>Ng*9*? zGsty)U2WQ~x;acBcqN(SCLwDJ+?=((-Hp%^^1~tRcjRWR@ud1hE8wyYtj6~Lo%upX zM_mK_1WrW;Sc~Sd{`>P+VPjraUT?Si37HzSbA0bjwPwxW#U1TTYL>A#dzM@KYE{cN z&MRqDNE16-0 zvo}azn8{PoJB^8C>Zg3hb>mo8g;`R)0%t#ES6g5{~WKC}%{!4sm+A zfRXjkpuzRv#CA*)1-rbr`G({^q}dnq?F%TvLxYO&;Djn5W;Z5$oyyAA)O^x(P$5IQ zwV+2g+gO|IJQEbpb~HOYzL?+O2UviDk^&m}eH!9A^rwY;e{JZ%IE}OKV@5&V8p7W< zW4y=m(SPAP93UnRs0b7?yW=7QvyO)^6$+WLalwI^#KRW=QBf|~vZ3VU8F)?V_9{i{ z!S@q=+1^AQNIRi^?7PSeR=|ZUpfv5c*0zhf+HD|sC57bnLbd|@oJ@YSIBDc;HT|u6EJsyrnym(0pxw c>B??i8i=BKH_+|5m>=%_+*&UB52~>b%*Um4i2wiq diff --git a/searchindex.js b/searchindex.js index 08852dc..eb9a2fe 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Attributes": [[1, "attributes"]], "Building the docs": [[8, "building-the-docs"]], "Chunked mode": [[12, "chunked-mode"]], "Classes": [[2, "classes"], [3, "classes"]], "Configuration": [[7, "configuration"]], "Contents:": [[11, null]], "Development": [[8, "development"]], "Examples": [[9, "examples"]], "Functions": [[1, "functions"], [2, "functions"], [4, "functions"], [5, "functions"], [6, "functions"]], "Help": [[10, "help"]], "Hybrid mode": [[12, "hybrid-mode"]], "Indices and tables": [[11, "indices-and-tables"]], "Installation": [[12, "installation"]], "Module Contents": [[1, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [6, "module-contents"]], "Optimization modes": [[12, "optimization-modes"]], "Overview": [[12, "overview"]], "Package Contents": [[2, "package-contents"]], "Row mode": [[12, "row-mode"]], "Running": [[12, "running"]], "Running tests": [[8, "running-tests"]], "Setting up pre-commit": [[8, "setting-up-pre-commit"]], "Submodules": [[2, "submodules"]], "Welcome to overlappogram\u2019s documentation!": [[11, "welcome-to-overlappogram-s-documentation"]], "execution section": [[7, "execution-section"]], "inversion section": [[7, "inversion-section"]], "model section": [[7, "model-section"]], "output section": [[7, "output-section"]], "overlappogram": [[2, "module-overlappogram"]], "overlappogram.cli": [[1, "module-overlappogram.cli"]], "overlappogram.inversion": [[3, "module-overlappogram.inversion"]], "overlappogram.io": [[4, "module-overlappogram.io"]], "overlappogram.response": [[5, "module-overlappogram.response"]], "overlappogram.spectral": [[6, "module-overlappogram.spectral"]], "paths section": [[7, "paths-section"]]}, "docnames": ["autoapi/index", "autoapi/overlappogram/cli/index", "autoapi/overlappogram/index", "autoapi/overlappogram/inversion/index", "autoapi/overlappogram/io/index", "autoapi/overlappogram/response/index", "autoapi/overlappogram/spectral/index", "configuration", "development", "examples", "help", "index", "overview"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/index.rst", "autoapi/overlappogram/cli/index.rst", "autoapi/overlappogram/index.rst", "autoapi/overlappogram/inversion/index.rst", "autoapi/overlappogram/io/index.rst", "autoapi/overlappogram/response/index.rst", "autoapi/overlappogram/spectral/index.rst", "configuration.rst", "development.rst", "examples.rst", "help.rst", "index.rst", "overview.rst"], "indexentries": {"_collect_results() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._collect_results", false]], "_collect_results() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._collect_results", false]], "_initialize_with_overlappogram() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._initialize_with_overlappogram", false]], "_initialize_with_overlappogram() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._initialize_with_overlappogram", false]], "_invert_image_row() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._invert_image_row", false]], "_invert_image_row() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._invert_image_row", false]], "_progress_indicator() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._progress_indicator", false]], "_progress_indicator() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._progress_indicator", false]], "_start_chunk_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._start_chunk_inversion", false]], "_start_chunk_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._start_chunk_inversion", false]], "_start_row_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._start_row_inversion", false]], "_start_row_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._start_row_inversion", false]], "_switch_to_row_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._switch_to_row_inversion", false]], "_switch_to_row_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._switch_to_row_inversion", false]], "create_spectrally_pure_images() (in module overlappogram.spectral)": [[6, "overlappogram.spectral.create_spectrally_pure_images", false]], "invert() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter.invert", false]], "invert() (overlappogram.inverter method)": [[2, "overlappogram.Inverter.invert", false]], "inverter (class in overlappogram)": [[2, "overlappogram.Inverter", false]], "inverter (class in overlappogram.inversion)": [[3, "overlappogram.inversion.Inverter", false]], "is_inverted (overlappogram.inversion.inverter property)": [[3, "overlappogram.inversion.Inverter.is_inverted", false]], "is_inverted (overlappogram.inverter property)": [[2, "overlappogram.Inverter.is_inverted", false]], "load_overlappogram() (in module overlappogram)": [[2, "overlappogram.load_overlappogram", false]], "load_overlappogram() (in module overlappogram.io)": [[4, "overlappogram.io.load_overlappogram", false]], "load_response_cube() (in module overlappogram)": [[2, "overlappogram.load_response_cube", false]], "load_response_cube() (in module overlappogram.io)": [[4, "overlappogram.io.load_response_cube", false]], "module": [[1, "module-overlappogram.cli", false], [2, "module-overlappogram", false], [3, "module-overlappogram.inversion", false], [4, "module-overlappogram.io", false], [5, "module-overlappogram.response", false], [6, "module-overlappogram.spectral", false]], "numpy_thread_count (in module overlappogram.cli)": [[1, "overlappogram.cli.NUMPY_THREAD_COUNT", false]], "overlappogram": [[2, "module-overlappogram", false]], "overlappogram.cli": [[1, "module-overlappogram.cli", false]], "overlappogram.inversion": [[3, "module-overlappogram.inversion", false]], "overlappogram.io": [[4, "module-overlappogram.io", false]], "overlappogram.response": [[5, "module-overlappogram.response", false]], "overlappogram.spectral": [[6, "module-overlappogram.spectral", false]], "prepare_response_function() (in module overlappogram.response)": [[5, "overlappogram.response.prepare_response_function", false]], "save_em_cube() (in module overlappogram.io)": [[4, "overlappogram.io.save_em_cube", false]], "save_prediction() (in module overlappogram.io)": [[4, "overlappogram.io.save_prediction", false]], "save_spectral_cube() (in module overlappogram.io)": [[4, "overlappogram.io.save_spectral_cube", false]], "unfold() (in module overlappogram.cli)": [[1, "overlappogram.cli.unfold", false]]}, "objects": {"": [[2, 0, 0, "-", "overlappogram"]], "overlappogram": [[2, 1, 1, "", "Inverter"], [1, 0, 0, "-", "cli"], [3, 0, 0, "-", "inversion"], [4, 0, 0, "-", "io"], [2, 5, 1, "", "load_overlappogram"], [2, 5, 1, "", "load_response_cube"], [5, 0, 0, "-", "response"], [6, 0, 0, "-", "spectral"]], "overlappogram.Inverter": [[2, 2, 1, "", "_collect_results"], [2, 2, 1, "", "_initialize_with_overlappogram"], [2, 2, 1, "", "_invert_image_row"], [2, 2, 1, "", "_progress_indicator"], [2, 2, 1, "", "_start_chunk_inversion"], [2, 2, 1, "", "_start_row_inversion"], [2, 2, 1, "", "_switch_to_row_inversion"], [2, 2, 1, "", "invert"], [2, 3, 1, "", "is_inverted"]], "overlappogram.cli": [[1, 4, 1, "", "NUMPY_THREAD_COUNT"], [1, 5, 1, "", "unfold"]], "overlappogram.inversion": [[3, 1, 1, "", "Inverter"]], "overlappogram.inversion.Inverter": [[3, 2, 1, "", "_collect_results"], [3, 2, 1, "", "_initialize_with_overlappogram"], [3, 2, 1, "", "_invert_image_row"], [3, 2, 1, "", "_progress_indicator"], [3, 2, 1, "", "_start_chunk_inversion"], [3, 2, 1, "", "_start_row_inversion"], [3, 2, 1, "", "_switch_to_row_inversion"], [3, 2, 1, "", "invert"], [3, 3, 1, "", "is_inverted"]], "overlappogram.io": [[4, 5, 1, "", "load_overlappogram"], [4, 5, 1, "", "load_response_cube"], [4, 5, 1, "", "save_em_cube"], [4, 5, 1, "", "save_prediction"], [4, 5, 1, "", "save_spectral_cube"]], "overlappogram.response": [[5, 5, 1, "", "prepare_response_function"]], "overlappogram.spectral": [[6, 5, 1, "", "create_spectrally_pure_images"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "data", "Python data"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:data", "5": "py:function"}, "terms": {"": [7, 10, 12], "0": [2, 3], "1": [0, 1, 2, 3], "10": 7, "2": [5, 7], "35": 7, "50": [2, 3], "A": 7, "For": 7, "If": [7, 8, 10], "In": [7, 12], "It": [8, 12], "The": [7, 8, 12], "Then": 8, "There": [7, 12], "These": 12, "To": [8, 12], "_collect_result": [2, 3], "_initialize_with_overlappogram": [2, 3], "_invert_image_row": [2, 3], "_progress_ind": [2, 3], "_start_chunk_invers": [2, 3], "_start_row_invers": [2, 3], "_switch_to_row_invers": [2, 3], "accept": 12, "accompani": 7, "accord": 12, "activ": 8, "adjac": 12, "all": [7, 8, 10], "allow": 12, "alpha": [2, 3, 7], "alreadi": 7, "an": [1, 7, 10, 12], "angl": 7, "ani": 8, "api": 11, "appear": 12, "ar": [7, 8, 12], "arc": 7, "artifact": 12, "atom": 7, "auto": 0, "autoapi": 0, "avoid": 12, "base": [8, 12], "becaus": 12, "begin": [7, 12], "benefit": 10, "between": 7, "bin": 8, "bool": [2, 3], "boolean": 7, "boundari": 12, "bug": 10, "build": 11, "built": 8, "can": [7, 8, 10, 12], "captur": 12, "carri": 12, "case": 7, "check": 8, "chianti": 7, "chunk": 7, "chunk_index": [2, 3], "cli": [0, 2], "code": [8, 10], "coeffici": 7, "combin": 12, "come": 9, "commit": 11, "complet": 12, "comput": 7, "confid": 12, "config": [1, 12], "configur": [1, 11, 12], "consequ": 12, "consist": 8, "constant": 7, "contact": 8, "contain": [0, 7], "contigu": 12, "contribut": 8, "correspond": [7, 12], "could": 12, "cpu": 12, "creat": [0, 8, 12], "create_spectrally_pure_imag": 6, "cube": [4, 12], "cubixss": 11, "current": 7, "cyclic": 7, "default": 7, "defin": [7, 12], "depend": [2, 3, 7], "describ": 7, "descript": 7, "detector": 7, "detector_row_rang": [2, 3, 7], "dev": 8, "develop": 11, "differ": 7, "direct": 12, "directori": [7, 8], "discontinu": 12, "discuss": 10, "divid": [7, 12], "do": [7, 8, 12], "doc": 11, "document": [0, 7, 8, 12], "doesn": 12, "done": 12, "e": 8, "each": [7, 12], "eccco": [1, 11], "effect": 7, "either": 7, "elasticnet": [7, 12], "els": 10, "email": 10, "emiss": 12, "encount": 10, "encourag": [8, 10], "environ": 8, "everi": [7, 8], "everyon": 10, "exampl": [7, 11], "execut": [11, 12], "exhaust": 7, "exist": 7, "expect": 7, "fail": 7, "featur": [7, 12], "few": 12, "fewer": 12, "field": 7, "field_angle_rang": [2, 3, 5, 7], "file": [1, 7, 12], "find": 7, "finish": 12, "first": [8, 10], "float": 7, "follow": 8, "format": [1, 7], "four": 7, "fov_width": 5, "friendli": 10, "from": [7, 10], "function": 7, "futur": [2, 3], "g": 7, "gener": [0, 12], "get": [8, 12], "github": [1, 10], "given": [1, 12], "gnt": 7, "gnt_path": 6, "ground": 12, "guid": 8, "guidelin": 8, "ha": 7, "happen": 12, "harder": 12, "have": 12, "help": 11, "here": [7, 8], "how": 7, "html": [1, 8], "http": 1, "hybrid": [2, 3, 7], "i": [7, 8, 10, 11, 12], "imag": [7, 12], "image_list": 6, "image_path": [2, 4], "includ": 7, "independ": 12, "index": 11, "indic": 7, "input": 7, "inquiri": 10, "instal": [8, 11], "instead": 12, "instrument": [7, 12], "int": [2, 3], "integ": 7, "invers": [0, 2, 11, 12], "inversionmod": [2, 3], "invert": [2, 3, 7, 11, 12], "io": [0, 1, 2], "is_invert": [2, 3], "issu": [8, 10], "iter": 7, "its": 12, "l1_ratio": 7, "learn": 7, "left": 12, "less": 7, "like": [7, 10], "linear": 12, "link": 7, "list": [2, 3, 6, 7], "ll": 8, "load_overlappogram": [2, 4], "load_response_cub": [2, 4], "logarithm": 7, "logt": 7, "loop": 7, "m": 8, "made": 7, "magix": 11, "mai": 12, "make": [7, 8, 10], "make_spectr": 7, "map": 12, "matrix": 12, "max_it": 7, "maximum": 7, "measur": 12, "method": 7, "mission": 1, "mode": [2, 3, 7, 11], "mode_switch_thread_count": [2, 3, 7, 12], "model": [11, 12], "model_config": [2, 3], "modul": 11, "more": [7, 12], "most": 12, "multipl": 12, "multipli": 7, "multithread": [2, 3], "must": 8, "n": 7, "navig": 8, "ndcube": [2, 3, 4, 5], "need": [8, 10], "newcom": 12, "next": 12, "non": 12, "none": [2, 3, 4, 5], "note": 7, "notic": [10, 12], "now": [7, 8], "num_row_thread": [2, 3], "num_thread": [2, 3, 7, 12], "number": [7, 12], "numpy_thread_count": 1, "observ": [11, 12], "one": 12, "onli": [7, 12], "open": 10, "oper": 7, "optim": [7, 11], "option": 7, "other": [8, 10, 12], "otherwis": 7, "our": 8, "out": 12, "output": [11, 12], "over": 7, "overlap": 12, "overlappogram": [0, 7, 12], "overview": 11, "overwrit": [4, 7], "overwritten": 7, "own": 12, "packag": [8, 10, 11], "page": [0, 11], "paramet": [7, 12], "path": [2, 4, 11], "penalti": 7, "perform": 12, "physic": 7, "pip": [8, 12], "pixel": 7, "pleas": [8, 10], "point": [7, 12], "possibl": [10, 12], "pre": 11, "predict": 4, "prefix": 7, "prepare_response_funct": 5, "previou": 12, "program": [7, 12], "progress": [2, 3], "properti": [2, 3, 7], "provid": 7, "pure": [7, 12], "pytest": 8, "python": [8, 11], "r": 8, "random": 7, "rang": 7, "rather": [7, 10], "re": 10, "recommend": [8, 12], "recov": 12, "refer": 11, "regress": 12, "remain": [7, 12], "repositori": 8, "requir": [7, 8], "respons": [0, 2, 7, 12], "response_cub": [2, 3, 5], "response_dependency_list": [2, 3, 5, 7], "response_dependency_nam": 7, "result": 12, "rho": [2, 3, 7], "row": 7, "row_index": [2, 3], "rsp_dep_list": 6, "run": [7, 11], "same": 12, "save_em_cub": 4, "save_predict": 4, "save_spectral_cub": 4, "scikit": 7, "search": 11, "second": 7, "section": [11, 12], "see": [1, 7, 8], "select": 7, "sequenti": [7, 12], "set": [7, 11, 12], "should": 7, "simplest": 12, "simpli": 12, "singl": 12, "six": 7, "sklearn": 7, "slitless": 12, "smooth": 7, "smooth_ov": [2, 3, 7], "so": 10, "solut": [7, 12], "solution_fov_width": [2, 3, 7], "some": 12, "someon": 10, "sometim": 12, "soon": 9, "sourc": 8, "speak": 10, "specif": 7, "spectral": [0, 2, 7, 12], "spectral_cub": 4, "spectrogram": 12, "sphinx": [0, 8], "start": [7, 10, 12], "stop": 12, "str": [2, 3, 6], "string": 7, "style": 8, "suggest": 7, "sun": [11, 12], "support": [7, 10], "switch": [7, 12], "t": [7, 12], "take": 12, "temperatur": 7, "tend": 12, "term": 7, "termin": 12, "test": 11, "than": [7, 10, 12], "thank": 10, "them": 8, "thi": [0, 7, 8, 10, 12], "thread": [7, 12], "three": [7, 12], "thu": 12, "time": [8, 12], "tol": 7, "toler": 7, "toml": [1, 7, 12], "too": 10, "track": [2, 3], "train": 7, "true": [4, 7, 12], "truth": 12, "turn": 12, "two": 7, "u": [8, 12], "understand": 12, "unfold": [1, 7, 12], "unit": 7, "unless": 12, "up": [10, 11], "updat": 7, "us": [2, 3, 7, 8, 10, 12], "user": 10, "util": 12, "valid": 12, "valu": 7, "variou": 7, "venv": 8, "verifi": 12, "view": 7, "virtual": 8, "wai": 12, "wait": 12, "want": 10, "warm": [7, 12], "warm_start": [7, 12], "we": [7, 8, 10, 12], "weight": 7, "weights_path": [2, 4], "what": 7, "when": [7, 8, 12], "where": [7, 12], "whether": 7, "which": 12, "width": 7, "work": [8, 12], "would": [7, 12], "write": 7, "written": 7, "yet": 12, "you": [7, 8, 10, 12], "your": 10}, "titles": ["API Reference", "overlappogram.cli", "overlappogram", "overlappogram.inversion", "overlappogram.io", "overlappogram.response", "overlappogram.spectral", "Configuration", "Development", "Examples", "Help", "Welcome to overlappogram\u2019s documentation!", "Overview"], "titleterms": {"": 11, "api": 0, "attribut": 1, "build": 8, "chunk": 12, "class": [2, 3], "cli": 1, "commit": 8, "configur": 7, "content": [1, 2, 3, 4, 5, 6, 11], "develop": 8, "doc": 8, "document": 11, "exampl": 9, "execut": 7, "function": [1, 2, 4, 5, 6], "help": 10, "hybrid": 12, "indic": 11, "instal": 12, "invers": [3, 7], "io": 4, "mode": 12, "model": 7, "modul": [1, 3, 4, 5, 6], "optim": 12, "output": 7, "overlappogram": [1, 2, 3, 4, 5, 6, 11], "overview": 12, "packag": 2, "path": 7, "pre": 8, "refer": 0, "respons": 5, "row": 12, "run": [8, 12], "section": 7, "set": 8, "spectral": 6, "submodul": 2, "tabl": 11, "test": 8, "up": 8, "welcom": 11}}) \ No newline at end of file +Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Attributes": [[1, "attributes"]], "Building the docs": [[8, "building-the-docs"]], "Chunked mode": [[12, "chunked-mode"]], "Classes": [[1, "classes"], [2, "classes"], [3, "classes"]], "Configuration": [[7, "configuration"]], "Contents:": [[11, null]], "Development": [[8, "development"]], "Examples": [[9, "examples"]], "Functions": [[1, "functions"], [2, "functions"], [4, "functions"], [5, "functions"], [6, "functions"]], "Help": [[10, "help"]], "Hybrid mode": [[12, "hybrid-mode"]], "Indices and tables": [[11, "indices-and-tables"]], "Installation": [[12, "installation"]], "Module Contents": [[1, "module-contents"], [3, "module-contents"], [4, "module-contents"], [5, "module-contents"], [6, "module-contents"]], "Optimization modes": [[12, "optimization-modes"]], "Overview": [[12, "overview"]], "Package Contents": [[2, "package-contents"]], "Row mode": [[12, "row-mode"]], "Running": [[12, "running"]], "Running tests": [[8, "running-tests"]], "Setting up pre-commit": [[8, "setting-up-pre-commit"]], "Submodules": [[2, "submodules"]], "Welcome to overlappogram\u2019s documentation!": [[11, "welcome-to-overlappogram-s-documentation"]], "execution section": [[7, "execution-section"]], "inversion section": [[7, "inversion-section"]], "model section": [[7, "model-section"]], "output section": [[7, "output-section"]], "overlappogram": [[2, "module-overlappogram"]], "overlappogram.cli": [[1, "module-overlappogram.cli"]], "overlappogram.inversion": [[3, "module-overlappogram.inversion"]], "overlappogram.io": [[4, "module-overlappogram.io"]], "overlappogram.response": [[5, "module-overlappogram.response"]], "overlappogram.spectral": [[6, "module-overlappogram.spectral"]], "paths section": [[7, "paths-section"]]}, "docnames": ["autoapi/index", "autoapi/overlappogram/cli/index", "autoapi/overlappogram/index", "autoapi/overlappogram/inversion/index", "autoapi/overlappogram/io/index", "autoapi/overlappogram/response/index", "autoapi/overlappogram/spectral/index", "configuration", "development", "examples", "help", "index", "overview"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi/index.rst", "autoapi/overlappogram/cli/index.rst", "autoapi/overlappogram/index.rst", "autoapi/overlappogram/inversion/index.rst", "autoapi/overlappogram/io/index.rst", "autoapi/overlappogram/response/index.rst", "autoapi/overlappogram/spectral/index.rst", "configuration.rst", "development.rst", "examples.rst", "help.rst", "index.rst", "overview.rst"], "indexentries": {"_collect_results() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._collect_results", false]], "_collect_results() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._collect_results", false]], "_collect_results() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._collect_results", false]], "_initialize_with_overlappogram() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._initialize_with_overlappogram", false]], "_initialize_with_overlappogram() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._initialize_with_overlappogram", false]], "_initialize_with_overlappogram() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._initialize_with_overlappogram", false]], "_invert_image_row() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._invert_image_row", false]], "_invert_image_row() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._invert_image_row", false]], "_invert_image_row() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._invert_image_row", false]], "_progress_indicator() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._progress_indicator", false]], "_progress_indicator() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._progress_indicator", false]], "_progress_indicator() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._progress_indicator", false]], "_start_chunk_inversion() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._start_chunk_inversion", false]], "_start_chunk_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._start_chunk_inversion", false]], "_start_chunk_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._start_chunk_inversion", false]], "_start_row_inversion() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._start_row_inversion", false]], "_start_row_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._start_row_inversion", false]], "_start_row_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._start_row_inversion", false]], "_switch_to_row_inversion() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter._switch_to_row_inversion", false]], "_switch_to_row_inversion() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter._switch_to_row_inversion", false]], "_switch_to_row_inversion() (overlappogram.inverter method)": [[2, "overlappogram.Inverter._switch_to_row_inversion", false]], "create_spectrally_pure_images() (in module overlappogram.cli)": [[1, "overlappogram.cli.create_spectrally_pure_images", false]], "create_spectrally_pure_images() (in module overlappogram.spectral)": [[6, "overlappogram.spectral.create_spectrally_pure_images", false]], "invert() (overlappogram.cli.inverter method)": [[1, "overlappogram.cli.Inverter.invert", false]], "invert() (overlappogram.inversion.inverter method)": [[3, "overlappogram.inversion.Inverter.invert", false]], "invert() (overlappogram.inverter method)": [[2, "overlappogram.Inverter.invert", false]], "inverter (class in overlappogram)": [[2, "overlappogram.Inverter", false]], "inverter (class in overlappogram.cli)": [[1, "overlappogram.cli.Inverter", false]], "inverter (class in overlappogram.inversion)": [[3, "overlappogram.inversion.Inverter", false]], "is_inverted (overlappogram.cli.inverter property)": [[1, "overlappogram.cli.Inverter.is_inverted", false]], "is_inverted (overlappogram.inversion.inverter property)": [[3, "overlappogram.inversion.Inverter.is_inverted", false]], "is_inverted (overlappogram.inverter property)": [[2, "overlappogram.Inverter.is_inverted", false]], "load_overlappogram() (in module overlappogram)": [[2, "overlappogram.load_overlappogram", false]], "load_overlappogram() (in module overlappogram.cli)": [[1, "overlappogram.cli.load_overlappogram", false]], "load_overlappogram() (in module overlappogram.io)": [[4, "overlappogram.io.load_overlappogram", false]], "load_response_cube() (in module overlappogram)": [[2, "overlappogram.load_response_cube", false]], "load_response_cube() (in module overlappogram.cli)": [[1, "overlappogram.cli.load_response_cube", false]], "load_response_cube() (in module overlappogram.io)": [[4, "overlappogram.io.load_response_cube", false]], "mode_mapping (in module overlappogram.cli)": [[1, "overlappogram.cli.MODE_MAPPING", false]], "module": [[1, "module-overlappogram.cli", false], [2, "module-overlappogram", false], [3, "module-overlappogram.inversion", false], [4, "module-overlappogram.io", false], [5, "module-overlappogram.response", false], [6, "module-overlappogram.spectral", false]], "numpy_thread_count (in module overlappogram.cli)": [[1, "overlappogram.cli.NUMPY_THREAD_COUNT", false]], "overlappogram": [[2, "module-overlappogram", false]], "overlappogram.cli": [[1, "module-overlappogram.cli", false]], "overlappogram.inversion": [[3, "module-overlappogram.inversion", false]], "overlappogram.io": [[4, "module-overlappogram.io", false]], "overlappogram.response": [[5, "module-overlappogram.response", false]], "overlappogram.spectral": [[6, "module-overlappogram.spectral", false]], "prepare_response_function() (in module overlappogram.response)": [[5, "overlappogram.response.prepare_response_function", false]], "save_em_cube() (in module overlappogram.cli)": [[1, "overlappogram.cli.save_em_cube", false]], "save_em_cube() (in module overlappogram.io)": [[4, "overlappogram.io.save_em_cube", false]], "save_prediction() (in module overlappogram.cli)": [[1, "overlappogram.cli.save_prediction", false]], "save_prediction() (in module overlappogram.io)": [[4, "overlappogram.io.save_prediction", false]], "save_spectral_cube() (in module overlappogram.cli)": [[1, "overlappogram.cli.save_spectral_cube", false]], "save_spectral_cube() (in module overlappogram.io)": [[4, "overlappogram.io.save_spectral_cube", false]], "unfold() (in module overlappogram.cli)": [[1, "overlappogram.cli.unfold", false]]}, "objects": {"": [[2, 0, 0, "-", "overlappogram"]], "overlappogram": [[2, 1, 1, "", "Inverter"], [1, 0, 0, "-", "cli"], [3, 0, 0, "-", "inversion"], [4, 0, 0, "-", "io"], [2, 5, 1, "", "load_overlappogram"], [2, 5, 1, "", "load_response_cube"], [5, 0, 0, "-", "response"], [6, 0, 0, "-", "spectral"]], "overlappogram.Inverter": [[2, 2, 1, "", "_collect_results"], [2, 2, 1, "", "_initialize_with_overlappogram"], [2, 2, 1, "", "_invert_image_row"], [2, 2, 1, "", "_progress_indicator"], [2, 2, 1, "", "_start_chunk_inversion"], [2, 2, 1, "", "_start_row_inversion"], [2, 2, 1, "", "_switch_to_row_inversion"], [2, 2, 1, "", "invert"], [2, 3, 1, "", "is_inverted"]], "overlappogram.cli": [[1, 1, 1, "", "Inverter"], [1, 4, 1, "", "MODE_MAPPING"], [1, 4, 1, "", "NUMPY_THREAD_COUNT"], [1, 5, 1, "", "create_spectrally_pure_images"], [1, 5, 1, "", "load_overlappogram"], [1, 5, 1, "", "load_response_cube"], [1, 5, 1, "", "save_em_cube"], [1, 5, 1, "", "save_prediction"], [1, 5, 1, "", "save_spectral_cube"], [1, 5, 1, "", "unfold"]], "overlappogram.cli.Inverter": [[1, 2, 1, "", "_collect_results"], [1, 2, 1, "", "_initialize_with_overlappogram"], [1, 2, 1, "", "_invert_image_row"], [1, 2, 1, "", "_progress_indicator"], [1, 2, 1, "", "_start_chunk_inversion"], [1, 2, 1, "", "_start_row_inversion"], [1, 2, 1, "", "_switch_to_row_inversion"], [1, 2, 1, "", "invert"], [1, 3, 1, "", "is_inverted"]], "overlappogram.inversion": [[3, 1, 1, "", "Inverter"]], "overlappogram.inversion.Inverter": [[3, 2, 1, "", "_collect_results"], [3, 2, 1, "", "_initialize_with_overlappogram"], [3, 2, 1, "", "_invert_image_row"], [3, 2, 1, "", "_progress_indicator"], [3, 2, 1, "", "_start_chunk_inversion"], [3, 2, 1, "", "_start_row_inversion"], [3, 2, 1, "", "_switch_to_row_inversion"], [3, 2, 1, "", "invert"], [3, 3, 1, "", "is_inverted"]], "overlappogram.io": [[4, 5, 1, "", "load_overlappogram"], [4, 5, 1, "", "load_response_cube"], [4, 5, 1, "", "save_em_cube"], [4, 5, 1, "", "save_prediction"], [4, 5, 1, "", "save_spectral_cube"]], "overlappogram.response": [[5, 5, 1, "", "prepare_response_function"]], "overlappogram.spectral": [[6, 5, 1, "", "create_spectrally_pure_images"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "data", "Python data"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:data", "5": "py:function"}, "terms": {"": [7, 10, 12], "0": [1, 2, 3], "1": [0, 1, 2, 3], "10": 7, "2": [5, 7], "35": 7, "50": [1, 2, 3], "A": 7, "For": 7, "If": [7, 8, 10], "In": [7, 12], "It": [8, 12], "The": [7, 8, 12], "Then": 8, "There": [7, 12], "These": 12, "To": [8, 12], "_collect_result": [1, 2, 3], "_initialize_with_overlappogram": [1, 2, 3], "_invert_image_row": [1, 2, 3], "_progress_ind": [1, 2, 3], "_start_chunk_invers": [1, 2, 3], "_start_row_invers": [1, 2, 3], "_switch_to_row_invers": [1, 2, 3], "accept": 12, "accompani": 7, "accord": 12, "activ": 8, "adjac": 12, "all": [7, 8, 10], "allow": 12, "alpha": [1, 2, 3, 7], "alreadi": 7, "an": [1, 7, 10, 12], "angl": 7, "ani": 8, "api": 11, "appear": 12, "ar": [7, 8, 12], "arc": 7, "artifact": 12, "atom": 7, "auto": 0, "autoapi": 0, "avoid": 12, "base": [8, 12], "becaus": 12, "begin": [7, 12], "benefit": 10, "between": 7, "bin": 8, "bool": [1, 2, 3], "boolean": 7, "boundari": 12, "bug": 10, "build": 11, "built": 8, "can": [7, 8, 10, 12], "captur": 12, "carri": 12, "case": 7, "check": 8, "chianti": 7, "chunk": 7, "chunk_index": [1, 2, 3], "cli": [0, 2], "code": [8, 10], "coeffici": 7, "combin": 12, "come": 9, "commit": 11, "complet": 12, "comput": 7, "confid": 12, "config": [1, 12], "configur": [1, 11, 12], "consequ": 12, "consist": 8, "constant": 7, "contact": 8, "contain": [0, 7], "contigu": 12, "contribut": 8, "correspond": [7, 12], "could": 12, "cpu": 12, "creat": [0, 8, 12], "create_spectrally_pure_imag": [1, 6], "cube": [1, 4, 12], "cubixss": 11, "current": 7, "cyclic": 7, "default": 7, "defin": [7, 12], "depend": [1, 2, 3, 7], "describ": 7, "descript": 7, "detector": 7, "detector_row_rang": [1, 2, 3, 7], "dev": 8, "develop": 11, "differ": 7, "direct": 12, "directori": [7, 8], "discontinu": 12, "discuss": 10, "divid": [7, 12], "do": [7, 8, 12], "doc": 11, "document": [0, 7, 8, 12], "doesn": 12, "done": 12, "e": 8, "each": [7, 12], "eccco": [1, 11], "effect": 7, "either": 7, "elasticnet": [7, 12], "els": 10, "email": 10, "emiss": 12, "encount": 10, "encourag": [8, 10], "environ": 8, "everi": [7, 8], "everyon": 10, "exampl": [7, 11], "execut": [11, 12], "exhaust": 7, "exist": 7, "expect": 7, "fail": 7, "featur": [7, 12], "few": 12, "fewer": 12, "field": 7, "field_angle_rang": [1, 2, 3, 5, 7], "file": [1, 7, 12], "find": 7, "finish": 12, "first": [8, 10], "float": 7, "follow": 8, "format": [1, 7], "four": 7, "fov_width": 5, "friendli": 10, "from": [7, 10], "function": 7, "futur": [1, 2, 3], "g": 7, "gener": [0, 12], "get": [8, 12], "github": [1, 10], "given": [1, 12], "gnt": 7, "gnt_path": [1, 6], "ground": 12, "guid": 8, "guidelin": 8, "ha": 7, "happen": 12, "harder": 12, "have": 12, "help": 11, "here": [7, 8], "how": 7, "html": [1, 8], "http": 1, "hybrid": [1, 2, 3, 7], "i": [7, 8, 10, 11, 12], "imag": [7, 12], "image_list": [1, 6], "image_path": [1, 2, 4], "includ": 7, "independ": 12, "index": 11, "indic": 7, "input": 7, "inquiri": 10, "instal": [8, 11], "instead": 12, "instrument": [7, 12], "int": [1, 2, 3], "integ": 7, "invers": [0, 1, 2, 11, 12], "inversionmod": [1, 2, 3], "invert": [1, 2, 3, 7, 11, 12], "io": [0, 1, 2], "is_invert": [1, 2, 3], "issu": [8, 10], "iter": 7, "its": 12, "l1_ratio": 7, "learn": 7, "left": 12, "less": 7, "like": [7, 10], "linear": 12, "link": 7, "list": [1, 2, 3, 6, 7], "ll": 8, "load_overlappogram": [1, 2, 4], "load_response_cub": [1, 2, 4], "logarithm": 7, "logt": 7, "loop": 7, "m": 8, "made": 7, "magix": 11, "mai": 12, "make": [7, 8, 10], "make_spectr": 7, "map": 12, "matrix": 12, "max_it": 7, "maximum": 7, "measur": 12, "method": 7, "mission": 1, "mode": [1, 2, 3, 7, 11], "mode_map": 1, "mode_switch_thread_count": [1, 2, 3, 7, 12], "model": [11, 12], "model_config": [1, 2, 3], "modul": 11, "more": [7, 12], "most": 12, "multipl": 12, "multipli": 7, "multithread": [1, 2, 3], "must": 8, "n": 7, "navig": 8, "ndcube": [1, 2, 3, 4, 5], "need": [8, 10], "newcom": 12, "next": 12, "non": 12, "none": [1, 2, 3, 4, 5], "note": 7, "notic": [10, 12], "now": [7, 8], "num_row_thread": [1, 2, 3], "num_thread": [1, 2, 3, 7, 12], "number": [7, 12], "numpy_thread_count": 1, "observ": [11, 12], "one": 12, "onli": [7, 12], "open": 10, "oper": 7, "optim": [7, 11], "option": 7, "other": [8, 10, 12], "otherwis": 7, "our": 8, "out": 12, "output": [11, 12], "over": 7, "overlap": 12, "overlappogram": [0, 7, 12], "overview": 11, "overwrit": [1, 4, 7], "overwritten": 7, "own": 12, "packag": [8, 10, 11], "page": [0, 11], "paramet": [7, 12], "path": [1, 2, 4, 11], "penalti": 7, "perform": 12, "physic": 7, "pip": [8, 12], "pixel": 7, "pleas": [8, 10], "point": [7, 12], "possibl": [10, 12], "pre": 11, "predict": [1, 4], "prefix": 7, "prepare_response_funct": 5, "previou": 12, "program": [7, 12], "progress": [1, 2, 3], "properti": [1, 2, 3, 7], "provid": 7, "pure": [7, 12], "pytest": 8, "python": [8, 11], "r": 8, "random": 7, "rang": 7, "rather": [7, 10], "re": 10, "recommend": [8, 12], "recov": 12, "refer": 11, "regress": 12, "remain": [7, 12], "repositori": 8, "requir": [7, 8], "respons": [0, 2, 7, 12], "response_cub": [1, 2, 3, 5], "response_dependency_list": [1, 2, 3, 5, 7], "response_dependency_nam": 7, "result": 12, "rho": [1, 2, 3, 7], "row": 7, "row_index": [1, 2, 3], "rsp_dep_list": [1, 6], "run": [7, 11], "same": 12, "save_em_cub": [1, 4], "save_predict": [1, 4], "save_spectral_cub": [1, 4], "scikit": 7, "search": 11, "second": 7, "section": [11, 12], "see": [1, 7, 8], "select": 7, "sequenti": [7, 12], "set": [7, 11, 12], "should": 7, "simplest": 12, "simpli": 12, "singl": 12, "six": 7, "sklearn": 7, "slitless": 12, "smooth": 7, "smooth_ov": [1, 2, 3, 7], "so": 10, "solut": [7, 12], "solution_fov_width": [1, 2, 3, 7], "some": 12, "someon": 10, "sometim": 12, "soon": 9, "sourc": 8, "speak": 10, "specif": 7, "spectral": [0, 2, 7, 12], "spectral_cub": [1, 4], "spectrogram": 12, "sphinx": [0, 8], "start": [7, 10, 12], "stop": 12, "str": [1, 2, 3, 6], "string": 7, "style": 8, "suggest": 7, "sun": [11, 12], "support": [7, 10], "switch": [7, 12], "t": [7, 12], "take": 12, "temperatur": 7, "tend": 12, "term": 7, "termin": 12, "test": 11, "than": [7, 10, 12], "thank": 10, "them": 8, "thi": [0, 7, 8, 10, 12], "thread": [7, 12], "three": [7, 12], "thu": 12, "time": [8, 12], "tol": 7, "toler": 7, "toml": [1, 7, 12], "too": 10, "track": [1, 2, 3], "train": 7, "true": [1, 4, 7, 12], "truth": 12, "turn": 12, "two": 7, "u": [8, 12], "understand": 12, "unfold": [1, 7, 12], "unit": 7, "unless": 12, "up": [10, 11], "updat": 7, "us": [1, 2, 3, 7, 8, 10, 12], "user": 10, "util": 12, "valid": 12, "valu": 7, "variou": 7, "venv": 8, "verifi": 12, "view": 7, "virtual": 8, "wai": 12, "wait": 12, "want": 10, "warm": [7, 12], "warm_start": [7, 12], "we": [7, 8, 10, 12], "weight": 7, "weights_path": [1, 2, 4], "what": 7, "when": [7, 8, 12], "where": [7, 12], "whether": 7, "which": 12, "width": 7, "work": [8, 12], "would": [7, 12], "write": 7, "written": 7, "yet": 12, "you": [7, 8, 10, 12], "your": 10}, "titles": ["API Reference", "overlappogram.cli", "overlappogram", "overlappogram.inversion", "overlappogram.io", "overlappogram.response", "overlappogram.spectral", "Configuration", "Development", "Examples", "Help", "Welcome to overlappogram\u2019s documentation!", "Overview"], "titleterms": {"": 11, "api": 0, "attribut": 1, "build": 8, "chunk": 12, "class": [1, 2, 3], "cli": 1, "commit": 8, "configur": 7, "content": [1, 2, 3, 4, 5, 6, 11], "develop": 8, "doc": 8, "document": 11, "exampl": 9, "execut": 7, "function": [1, 2, 4, 5, 6], "help": 10, "hybrid": 12, "indic": 11, "instal": 12, "invers": [3, 7], "io": 4, "mode": 12, "model": 7, "modul": [1, 3, 4, 5, 6], "optim": 12, "output": 7, "overlappogram": [1, 2, 3, 4, 5, 6, 11], "overview": 12, "packag": 2, "path": 7, "pre": 8, "refer": 0, "respons": 5, "row": 12, "run": [8, 12], "section": 7, "set": 8, "spectral": 6, "submodul": 2, "tabl": 11, "test": 8, "up": 8, "welcom": 11}}) \ No newline at end of file