Update documentation

Author: PierreRaybaut

en/.doctrees/api/computation.doctree

@@ -485,7 +485,7 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 
 
 <div class="viewcode-block" id="ThresholdParam">
-<a class="viewcode-back" href="../../../../api/param.html#cdl.param.ThresholdParam">[docs]</a>
+<a class="viewcode-back" href="../../../../api/param.html#cdl.computation.image.threshold.ThresholdParam">[docs]</a>
 <span class="k">class</span> <span class="nc">ThresholdParam</span><span class="p">(</span><span class="n">gds</span><span class="o">.</span><span class="n">DataSet</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Histogram threshold parameters&quot;&quot;&quot;</span>
 
@@ -519,6 +519,8 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 
 
 
+<div class="viewcode-block" id="compute_threshold">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">,</span> <span class="n">p</span><span class="p">:</span> <span class="n">ThresholdParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold.</span>
 
@@ -544,9 +546,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
     <span class="n">dst</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">skimage</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">img_as_ubyte</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
     <span class="n">dst</span><span class="o">.</span><span class="n">zscalemin</span><span class="p">,</span> <span class="n">dst</span><span class="o">.</span><span class="n">zscalemax</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">255</span>  <span class="c1"># LUT range</span>
     <span class="n">dst</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s2">&quot;colormap&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;gray&quot;</span>
-    <span class="k">return</span> <span class="n">dst</span>
+    <span class="k">return</span> <span class="n">dst</span></div>
 
 
+
+<div class="viewcode-block" id="compute_threshold_isodata">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_isodata">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_isodata</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Isodata algorithm with default parameters.</span>
 
@@ -556,9 +561,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;isodata&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;isodata&quot;</span><span class="p">))</span></div>
+
 
 
+<div class="viewcode-block" id="compute_threshold_li">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_li">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_li</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Li algorithm with default parameters.</span>
 
@@ -568,9 +576,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;li&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;li&quot;</span><span class="p">))</span></div>
 
 
+
+<div class="viewcode-block" id="compute_threshold_mean">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_mean">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_mean</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Mean algorithm.</span>
 
@@ -580,9 +591,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;mean&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;mean&quot;</span><span class="p">))</span></div>
+
 
 
+<div class="viewcode-block" id="compute_threshold_minimum">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_minimum">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_minimum</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Minimum algorithm with default parameters.</span>
 
@@ -592,9 +606,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;minimum&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;minimum&quot;</span><span class="p">))</span></div>
 
 
+
+<div class="viewcode-block" id="compute_threshold_otsu">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_otsu">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_otsu</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Otsu algorithm with default parameters.</span>
 
@@ -604,9 +621,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;otsu&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;otsu&quot;</span><span class="p">))</span></div>
+
 
 
+<div class="viewcode-block" id="compute_threshold_triangle">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_triangle">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_triangle</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Triangle algorithm with default parameters.</span>
 
@@ -616,9 +636,12 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;triangle&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;triangle&quot;</span><span class="p">))</span></div>
 
 
+
+<div class="viewcode-block" id="compute_threshold_yen">
+<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.threshold.compute_threshold_yen">[docs]</a>
 <span class="k">def</span> <span class="nf">compute_threshold_yen</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="n">ImageObj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ImageObj</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Compute the threshold using the Yen algorithm with default parameters.</span>
 
@@ -628,7 +651,8 @@ <h1>Source code for cdl.computation.image.threshold</h1><div class="highlight"><
 <span class="sd">    Returns:</span>
 <span class="sd">        Output image object</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;yen&quot;</span><span class="p">))</span>
+    <span class="k">return</span> <span class="n">compute_threshold</span><span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">ThresholdParam</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">&quot;yen&quot;</span><span class="p">))</span></div>
+
 </pre></div>
 
                 </article>

en/.doctrees/api/proxy.doctree

@@ -465,6 +465,9 @@ <h1>Source code for cdl.proxy</h1><div class="highlight"><pre>
 <span class="sd">The :mod:`cdl.proxy` module provides a way to access DataLab features from a proxy</span>
 <span class="sd">class.</span>
 
+<span class="sd">The list of compute methods accessible from the proxy objects is available in the</span>
+<span class="sd">:ref:`processor_methods` section.</span>
+
 <span class="sd">Remote proxy</span>
 <span class="sd">^^^^^^^^^^^^</span>
 
@@ -505,6 +508,46 @@ <h1>Source code for cdl.proxy</h1><div class="highlight"><pre>
 <span class="sd">    between local and remote proxy, keeping the same code inside the context.</span>
 
 <span class="sd">.. autofunction:: proxy_context</span>
+
+<span class="sd">.. _processor_methods:</span>
+
+<span class="sd">List of compute methods</span>
+<span class="sd">^^^^^^^^^^^^^^^^^^^^^^^</span>
+
+<span class="sd">All the proxy objects provide access to the DataLab computing methods exposed by</span>
+<span class="sd">the processor classes:</span>
+
+<span class="sd">- :class:`cdl.core.gui.processor.signal.SignalProcessor`</span>
+<span class="sd">- :class:`cdl.core.gui.processor.image.ImageProcessor`</span>
+
+<span class="sd">Number of compute methods</span>
+<span class="sd">*************************</span>
+
+<span class="sd">.. csv-table:: Number of compute methods</span>
+<span class="sd">   :file: ../doc/processor_methods_nb.csv</span>
+<span class="sd">   :header: Signal, Image, Total</span>
+
+<span class="sd">Signal processing</span>
+<span class="sd">*****************</span>
+
+<span class="sd">The following table lists the signal processor methods - it is automatically</span>
+<span class="sd">generated from the source code:</span>
+
+<span class="sd">.. csv-table:: Signal processor methods</span>
+<span class="sd">   :file: ../doc/processor_methods_signal.csv</span>
+<span class="sd">   :header: Compute method, Description</span>
+<span class="sd">   :widths: 40, 60</span>
+
+<span class="sd">Image processing</span>
+<span class="sd">****************</span>
+
+<span class="sd">The following table lists the image processor methods - it is automatically</span>
+<span class="sd">generated from the source code:</span>
+
+<span class="sd">.. csv-table:: Image processor methods</span>
+<span class="sd">    :file: ../doc/processor_methods_image.csv</span>
+<span class="sd">    :header: Compute method, Description</span>
+<span class="sd">    :widths: 40, 60</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
@@ -540,9 +583,8 @@ <h1>Source code for cdl.proxy</h1><div class="highlight"><pre>
 
 <span class="sd">    .. note::</span>
 
-<span class="sd">        The proxy object also allows to access DataLab computing functions operating</span>
-<span class="sd">        on signals and images (</span>
-<span class="sd">          :mod:`cdl.computation`).</span>
+<span class="sd">        The proxy object also allows to access DataLab computing methods exposed by</span>
+<span class="sd">        the processor classes (see :ref:`processor_methods`).</span>
 
 <span class="sd">    Examples:</span>
 <span class="sd">        Here is a simple example of how to use RemoteProxy in a Python script</span>
@@ -584,6 +626,11 @@ <h1>Source code for cdl.proxy</h1><div class="highlight"><pre>
 
 <span class="sd">    Args:</span>
 <span class="sd">        cdl (CDLMainWindow): CDLMainWindow instance.</span>
+
+<span class="sd">    .. note::</span>
+
+<span class="sd">        The proxy object also allows to access DataLab computing methods exposed by</span>
+<span class="sd">        the processor classes (see :ref:`processor_methods`).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
 <div class="viewcode-block" id="LocalProxy.add_signal">

en/.doctrees/contributing/changelog.doctree

@@ -39,15 +39,21 @@ what we call scientific validation, see :ref:`scientific_validation`).
 Signal Compute Functions
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
+The table below shows the validation status of signal compute functions in DataLab.
+It is automatically generated from the source code.
+
 .. csv-table:: Validation status of signal compute functions
    :file: ../../validation_status_signal.csv
-   :header: Function, Description, Test function
-   :widths: 20, 40, 40
+   :header: Compute function, Description, Test function
+   :widths: 30, 40, 30
 
 Image Compute Functions
 ^^^^^^^^^^^^^^^^^^^^^^^
 
+The table below shows the validation status of image compute functions in DataLab.
+It is automatically generated from the source code.
+
 .. csv-table:: Validation status of image compute functions
     :file: ../../validation_status_image.csv
-    :header: Function, Description, Test function
-    :widths: 20, 40, 40
+    :header: Compute function, Description, Test function
+    :widths: 30, 40, 30