Skip to content

Commit 0f3f951

Browse files
PierreRaybautPierreRaybaut
committed
Update documentation
1 parent 02ff82b commit 0f3f951

File tree

380 files changed

+1056
-981
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

380 files changed

+1056
-981
lines changed

‎en/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 4a80e34c9d05c2ced4af75bec7bb676c
3+
config: dd0947fd8c1bfa1ef8e5bf720b0d35ee
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎en/.doctrees/api/algorithms.doctree

1.7 KB
Binary file not shown.

‎en/.doctrees/api/computation.doctree

179 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/actionhandler.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/docks.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/h5io.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/main.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/objectview.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/panel.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/plothandler.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/processor.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/core.gui/roieditor.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/obj.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/param.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/api/proxy.doctree

-84 Bytes
Binary file not shown.

‎en/.doctrees/contributing/changelog.doctree

14 KB
Binary file not shown.

‎en/.doctrees/contributing/contribute_code.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/contributing/guidelines.doctree

-55 Bytes
Binary file not shown.

‎en/.doctrees/contributing/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/contributing/roadmap.doctree

4.49 KB
Binary file not shown.

‎en/.doctrees/environment.pickle

7.62 KB
Binary file not shown.

‎en/.doctrees/features/general/command.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/h5browser.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/instviewer.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/logviewer.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/macros.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/model.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/plugins.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/remote.doctree

-2 Bytes
Binary file not shown.

‎en/.doctrees/features/general/settings.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/general/workspace.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/2d_peak_detection.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/contour_detection.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_analysis.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_edit.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_file.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_operations.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_processing.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/image/menu_view.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_analysis.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_edit.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_file.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_operations.doctree

63 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_processing.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/signal/menu_view.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/validation/functional.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/features/validation/status.doctree

1.78 KB
Binary file not shown.

‎en/.doctrees/features/validation/technical.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/installation.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/introduction.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/keyfeatures.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/blobs.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/custom_func.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/fabry_perot.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/index.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/laser_beam.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/spectrum.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/videos/p1_quick_demo.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/videos/p2_extensibility.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/intro/tutorials/work_with_spyder.doctree

0 Bytes
Binary file not shown.

‎en/.doctrees/requirements.doctree

0 Bytes
Binary file not shown.

‎en/_images/i_beautiful.png

85 Bytes

‎en/_images/i_edit.png

0 Bytes

‎en/_images/i_file.png

-2 Bytes

‎en/_images/i_operation.png

-1 Bytes

‎en/_images/i_processing.png

-6 Bytes

‎en/_images/i_view.png

1 Byte

‎en/_images/s_analysis.png

-1 Bytes

‎en/_images/s_app_at_startup.png

-3 Bytes

‎en/_images/s_beautiful.png

-13 Bytes

‎en/_images/s_edit.png

0 Bytes

‎en/_images/s_file.png

-1 Bytes

‎en/_images/s_operation.png

-2 Bytes

‎en/_images/s_processing.png

-2 Bytes

‎en/_images/s_view.png

2 Bytes

‎en/_modules/cdl/algorithms/coordinates.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
5050
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
5151

52-
<script src="../../../_static/documentation_options.js?v=ba2e7b09"></script>
52+
<script src="../../../_static/documentation_options.js?v=1e56ff10"></script>
5353
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
5454
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5555
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -146,7 +146,7 @@
146146
<script>document.write(`<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark" alt=""/>`);</script>
147147

148148

149-
<p class="title logo__title">v0.18.0</p>
149+
<p class="title logo__title">v0.18.1</p>
150150

151151
</a></div>
152152

‎en/_modules/cdl/algorithms/datatypes.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
5050
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
5151

52-
<script src="../../../_static/documentation_options.js?v=ba2e7b09"></script>
52+
<script src="../../../_static/documentation_options.js?v=1e56ff10"></script>
5353
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
5454
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5555
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -146,7 +146,7 @@
146146
<script>document.write(`<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark" alt=""/>`);</script>
147147

148148

149-
<p class="title logo__title">v0.18.0</p>
149+
<p class="title logo__title">v0.18.1</p>
150150

151151
</a></div>
152152

‎en/_modules/cdl/algorithms/image.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
5050
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
5151

52-
<script src="../../../_static/documentation_options.js?v=ba2e7b09"></script>
52+
<script src="../../../_static/documentation_options.js?v=1e56ff10"></script>
5353
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
5454
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5555
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -146,7 +146,7 @@
146146
<script>document.write(`<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark" alt=""/>`);</script>
147147

148148

149-
<p class="title logo__title">v0.18.0</p>
149+
<p class="title logo__title">v0.18.1</p>
150150

151151
</a></div>
152152

‎en/_modules/cdl/algorithms/signal.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
5050
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
5151

52-
<script src="../../../_static/documentation_options.js?v=ba2e7b09"></script>
52+
<script src="../../../_static/documentation_options.js?v=1e56ff10"></script>
5353
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
5454
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5555
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -146,7 +146,7 @@
146146
<script>document.write(`<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark" alt=""/>`);</script>
147147

148148

149-
<p class="title logo__title">v0.18.0</p>
149+
<p class="title logo__title">v0.18.1</p>
150150

151151
</a></div>
152152

@@ -1105,14 +1105,16 @@ <h1>Source code for cdl.algorithms.signal</h1><div class="highlight"><pre>
11051105
<span class="sd"> value: Value to find</span>
11061106

11071107
<span class="sd"> Returns:</span>
1108-
<span class="sd"> X value where the Y value is the closest to the given value</span>
1108+
<span class="sd"> An array of x values where the y value is the closest to the given value</span>
1109+
<span class="sd"> (empty array if no zero crossing is found)</span>
11091110
<span class="sd"> &quot;&quot;&quot;</span>
11101111
<span class="n">leveled_y</span> <span class="o">=</span> <span class="n">y</span> <span class="o">-</span> <span class="n">value</span>
11111112
<span class="n">xi_before</span> <span class="o">=</span> <span class="n">find_nearest_zero_point_idx</span><span class="p">(</span><span class="n">leveled_y</span><span class="p">)</span>
11121113
<span class="n">xi_after</span> <span class="o">=</span> <span class="n">xi_before</span> <span class="o">+</span> <span class="mi">1</span>
11131114

11141115
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">xi_before</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
1115-
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.0</span><span class="p">])</span>
1116+
<span class="c1"># Return an empty array if no zero crossing is found</span>
1117+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([])</span>
11161118

11171119
<span class="c1"># linear interpolation</span>
11181120
<span class="n">p</span> <span class="o">=</span> <span class="p">(</span><span class="n">leveled_y</span><span class="p">[</span><span class="n">xi_after</span><span class="p">]</span> <span class="o">-</span> <span class="n">leveled_y</span><span class="p">[</span><span class="n">xi_before</span><span class="p">])</span> <span class="o">/</span> <span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="n">xi_after</span><span class="p">]</span> <span class="o">-</span> <span class="n">x</span><span class="p">[</span><span class="n">xi_before</span><span class="p">])</span>
@@ -1124,7 +1126,9 @@ <h1>Source code for cdl.algorithms.signal</h1><div class="highlight"><pre>
11241126

11251127
<div class="viewcode-block" id="bandwidth">
11261128
<a class="viewcode-back" href="../../../api/algorithms.html#cdl.algorithms.signal.bandwidth">[docs]</a>
1127-
<span class="k">def</span> <span class="nf">bandwidth</span><span class="p">(</span><span class="n">data</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">level</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">3.0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
1129+
<span class="k">def</span> <span class="nf">bandwidth</span><span class="p">(</span>
1130+
<span class="n">data</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">level</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">3.0</span>
1131+
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
11281132
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute the bandwidth of the signal at a given level.</span>
11291133

11301134
<span class="sd"> Args:</span>
@@ -1462,8 +1466,10 @@ <h1>Source code for cdl.algorithms.signal</h1><div class="highlight"><pre>
14621466
<span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="s2">&quot;zero-crossing&quot;</span><span class="p">:</span>
14631467
<span class="n">hmax</span> <span class="o">=</span> <span class="n">dy</span> <span class="o">*</span> <span class="mf">0.5</span> <span class="o">+</span> <span class="n">np</span><span class="o">.</span><span class="n">min</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
14641468
<span class="n">fx</span> <span class="o">=</span> <span class="n">find_x_at_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">hmax</span><span class="p">)</span>
1465-
<span class="k">if</span> <span class="n">fx</span><span class="o">.</span><span class="n">size</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
1469+
<span class="k">if</span> <span class="n">fx</span><span class="o">.</span><span class="n">size</span> <span class="o">&gt;</span> <span class="mi">2</span><span class="p">:</span>
14661470
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Ambiguous zero-crossing points (found </span><span class="si">{</span><span class="n">fx</span><span class="o">.</span><span class="n">size</span><span class="si">}</span><span class="s2"> points)&quot;</span><span class="p">)</span>
1471+
<span class="k">elif</span> <span class="n">fx</span><span class="o">.</span><span class="n">size</span> <span class="o">&lt;</span> <span class="mi">2</span><span class="p">:</span>
1472+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;No zero-crossing points found&quot;</span><span class="p">)</span>
14671473
<span class="k">return</span> <span class="n">fx</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">hmax</span><span class="p">,</span> <span class="n">fx</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">hmax</span>
14681474

14691475
<span class="k">try</span><span class="p">:</span>

‎en/_modules/cdl/computation/base.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
5050
<script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
5151

52-
<script src="../../../_static/documentation_options.js?v=ba2e7b09"></script>
52+
<script src="../../../_static/documentation_options.js?v=1e56ff10"></script>
5353
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
5454
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5555
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -146,7 +146,7 @@
146146
<script>document.write(`<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark" alt=""/>`);</script>
147147

148148

149-
<p class="title logo__title">v0.18.0</p>
149+
<p class="title logo__title">v0.18.1</p>
150150

151151
</a></div>
152152

0 commit comments

Comments
 (0)