Skip to content

Commit 13734ff

Browse files
PierreRaybautPierreRaybaut
committed
Update documentation
1 parent 638dc3a commit 13734ff

Some content is hidden

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

45 files changed

+1584
-1552
lines changed

‎en/.doctrees/api/computation.doctree

-212 Bytes
Binary file not shown.

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

-286 Bytes
Binary file not shown.

‎en/.doctrees/api/proxy.doctree

-326 Bytes
Binary file not shown.

‎en/.doctrees/contributing/changelog.doctree

-1.01 KB
Binary file not shown.

‎en/.doctrees/environment.pickle

-1.56 KB
Binary file not shown.

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

-286 Bytes
Binary file not shown.

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

-282 Bytes
Binary file not shown.

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

Lines changed: 34 additions & 34 deletions
Large diffs are not rendered by default.

‎en/_modules/cdl/computation/image/detection.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
525525
<span class="n">image</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">Peak2DDetectionParam</span>
526526
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
527527
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute 2D peak detection</span>
528-
<span class="sd"> using :py:func:`cdl.algorithms.image.get_2d_peaks_coords`</span>
528+
<span class="sd"> with :py:func:`cdl.algorithms.image.get_2d_peaks_coords`</span>
529529

530530
<span class="sd"> Args:</span>
531531
<span class="sd"> imageOutput: input image</span>
@@ -566,7 +566,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
566566
<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.detection.compute_contour_shape">[docs]</a>
567567
<span class="k">def</span> <span class="nf">compute_contour_shape</span><span class="p">(</span><span class="n">image</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">ContourShapeParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
568568
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute contour shape fit</span>
569-
<span class="sd"> using :py:func:`cdl.algorithms.image.get_contour_shapes`&quot;&quot;&quot;</span>
569+
<span class="sd"> with :py:func:`cdl.algorithms.image.get_contour_shapes`&quot;&quot;&quot;</span>
570570
<span class="k">return</span> <span class="n">calc_resultshape</span><span class="p">(</span>
571571
<span class="s2">&quot;contour&quot;</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">alg</span><span class="o">.</span><span class="n">get_contour_shapes</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">threshold</span>
572572
<span class="p">)</span></div>
@@ -637,7 +637,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
637637
<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.detection.compute_blob_dog">[docs]</a>
638638
<span class="k">def</span> <span class="nf">compute_blob_dog</span><span class="p">(</span><span class="n">image</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">BlobDOGParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
639639
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute blobs using Difference of Gaussian method</span>
640-
<span class="sd"> using :py:func:`cdl.algorithms.image.find_blobs_dog`</span>
640+
<span class="sd"> with :py:func:`cdl.algorithms.image.find_blobs_dog`</span>
641641

642642
<span class="sd"> Args:</span>
643643
<span class="sd"> imageOutput: input image</span>
@@ -681,7 +681,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
681681
<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.detection.compute_blob_doh">[docs]</a>
682682
<span class="k">def</span> <span class="nf">compute_blob_doh</span><span class="p">(</span><span class="n">image</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">BlobDOHParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
683683
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute blobs using Determinant of Hessian method</span>
684-
<span class="sd"> using :py:func:`cdl.algorithms.image.find_blobs_doh`</span>
684+
<span class="sd"> with :py:func:`cdl.algorithms.image.find_blobs_doh`</span>
685685

686686
<span class="sd"> Args:</span>
687687
<span class="sd"> imageOutput: input image</span>
@@ -721,7 +721,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
721721
<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.detection.compute_blob_log">[docs]</a>
722722
<span class="k">def</span> <span class="nf">compute_blob_log</span><span class="p">(</span><span class="n">image</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">BlobLOGParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
723723
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute blobs using Laplacian of Gaussian method</span>
724-
<span class="sd"> using :py:func:`cdl.algorithms.image.find_blobs_log`</span>
724+
<span class="sd"> with :py:func:`cdl.algorithms.image.find_blobs_log`</span>
725725

726726
<span class="sd"> Args:</span>
727727
<span class="sd"> imageOutput: input image</span>
@@ -889,7 +889,7 @@ <h1>Source code for cdl.computation.image.detection</h1><div class="highlight"><
889889
<a class="viewcode-back" href="../../../../api/computation.html#cdl.computation.image.detection.compute_blob_opencv">[docs]</a>
890890
<span class="k">def</span> <span class="nf">compute_blob_opencv</span><span class="p">(</span><span class="n">image</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">BlobOpenCVParam</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ResultShape</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
891891
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Compute blobs using OpenCV</span>
892-
<span class="sd"> using :py:func:`cdl.algorithms.image.find_blobs_opencv`</span>
892+
<span class="sd"> with :py:func:`cdl.algorithms.image.find_blobs_opencv`</span>
893893

894894
<span class="sd"> Args:</span>
895895
<span class="sd"> imageOutput: input image</span>

0 commit comments

Comments
 (0)