Update documentation

OpenCOMPES · Jan 19, 2025 · 163f2d8 · 163f2d8
1 parent 3641abd
commit 163f2d8
Show file tree

Hide file tree

Showing 32 changed files with 1,030 additions and 760 deletions.
diff --git a/specsanalyzer/develop/_modules/index.html b/specsanalyzer/develop/_modules/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; specsanalyzer 0.4.2.dev40+g8ed2f0c documentation</title>
+    <title>Overview: module code &#8212; specsanalyzer 0.5.2.dev10+g554f714 documentation</title>
 
 
 
@@ -29,15 +29,15 @@
   <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=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
 
   <!-- 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=a485e8e6"></script>
+    <script src="../_static/documentation_options.js?v=c58a65cb"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></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>
@@ -46,15 +46,15 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/specsanalyzer/switcher.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.4.2.dev40+g8ed2f0c';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.2.dev10+g554f714';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             true;
         </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"/>
-  <meta name="docsearch:version" content="0.4.2.dev40+g8ed2f0c" />
+  <meta name="docsearch:version" content="0.5.2.dev10+g554f714" />
   </head>
 
 
@@ -116,7 +116,7 @@
 
 
 
-    <p class="title logo__title">specsanalyzer 0.4.2.dev40+g8ed2f0c documentation</p>
+    <p class="title logo__title">specsanalyzer 0.5.2.dev10+g554f714 documentation</p>
 
 </a></div>
 

diff --git a/specsanalyzer/develop/_modules/specsanalyzer/config.html b/specsanalyzer/develop/_modules/specsanalyzer/config.html
diff --git a/specsanalyzer/develop/_modules/specsanalyzer/convert.html b/specsanalyzer/develop/_modules/specsanalyzer/convert.html
diff --git a/specsanalyzer/develop/_modules/specsanalyzer/core.html b/specsanalyzer/develop/_modules/specsanalyzer/core.html
diff --git a/specsanalyzer/develop/_modules/specsanalyzer/img_tools.html b/specsanalyzer/develop/_modules/specsanalyzer/img_tools.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>specsanalyzer.img_tools &#8212; specsanalyzer 0.4.2.dev40+g8ed2f0c documentation</title>
+    <title>specsanalyzer.img_tools &#8212; specsanalyzer 0.5.2.dev10+g554f714 documentation</title>
 
 
 
@@ -29,15 +29,15 @@
   <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=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
 
   <!-- 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=a485e8e6"></script>
+    <script src="../../_static/documentation_options.js?v=c58a65cb"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></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>
@@ -46,15 +46,15 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/specsanalyzer/switcher.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.4.2.dev40+g8ed2f0c';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.2.dev10+g554f714';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             true;
         </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"/>
-  <meta name="docsearch:version" content="0.4.2.dev40+g8ed2f0c" />
+  <meta name="docsearch:version" content="0.5.2.dev10+g554f714" />
   </head>
 
 
@@ -116,7 +116,7 @@
 
 
 
-    <p class="title logo__title">specsanalyzer 0.4.2.dev40+g8ed2f0c documentation</p>
+    <p class="title logo__title">specsanalyzer 0.5.2.dev10+g554f714 documentation</p>
 
 </a></div>
 
@@ -551,17 +551,17 @@
 
   <h1>Source code for specsanalyzer.img_tools</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;This module contains image manipulation tools for the specsanalyzer package&quot;&quot;&quot;</span>
-<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Sequence</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Sequence</span>
 
-<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
-<span class="kn">import</span> <span class="nn">xarray</span> <span class="k">as</span> <span class="nn">xr</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
+<span class="kn">import</span><span class="w"> </span><span class="nn">xarray</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">xr</span>
 
 
 <div class="viewcode-block" id="gauss2d">
 <a class="viewcode-back" href="../../specsanalyzer/img_tools.html#specsanalyzer.img_tools.gauss2d">[docs]</a>
-<span class="k">def</span> <span class="nf">gauss2d</span><span class="p">(</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">gauss2d</span><span class="p">(</span>
     <span class="n">x</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
     <span class="n">y</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
     <span class="n">mx</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
@@ -592,7 +592,7 @@ <h1>Source code for specsanalyzer.img_tools</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="fourier_filter_2d">
 <a class="viewcode-back" href="../../specsanalyzer/img_tools.html#specsanalyzer.img_tools.fourier_filter_2d">[docs]</a>
-<span class="k">def</span> <span class="nf">fourier_filter_2d</span><span class="p">(</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">fourier_filter_2d</span><span class="p">(</span>
     <span class="n">image</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
     <span class="n">peaks</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">dict</span><span class="p">],</span>
     <span class="n">ret</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;filtered&quot;</span><span class="p">,</span>
@@ -641,7 +641,7 @@ <h1>Source code for specsanalyzer.img_tools</h1><div class="highlight"><pre>
             <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span>
                 <span class="sa">f</span><span class="s2">&quot;The peaks input is supposed to be a list of dicts with the &quot;</span>
                 <span class="s2">&quot;following structure: pos_x, pos_y, sigma_x, sigma_y, amplitude.&quot;</span><span class="p">,</span>
-            <span class="p">)</span> <span class="kn">from</span> <span class="nn">exc</span>
+            <span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
 
     <span class="c1"># apply mask to the FFT, and transform back</span>
     <span class="n">filtered</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">irfft2</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">fft</span><span class="o">.</span><span class="n">ifftshift</span><span class="p">(</span><span class="n">image_fft</span> <span class="o">*</span> <span class="n">mask</span><span class="p">,</span> <span class="n">axes</span><span class="o">=</span><span class="mi">0</span><span class="p">))</span>
@@ -661,7 +661,7 @@ <h1>Source code for specsanalyzer.img_tools</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="crop_xarray">
 <a class="viewcode-back" href="../../specsanalyzer/img_tools.html#specsanalyzer.img_tools.crop_xarray">[docs]</a>
-<span class="k">def</span> <span class="nf">crop_xarray</span><span class="p">(</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">crop_xarray</span><span class="p">(</span>
     <span class="n">data_array</span><span class="p">:</span> <span class="n">xr</span><span class="o">.</span><span class="n">DataArray</span><span class="p">,</span>
     <span class="n">x_min</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
     <span class="n">x_max</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>