Skip to content

Commit 96c9f0a

Browse files
committed
Update documentation
1 parent b0d4dd0 commit 96c9f0a

File tree

362 files changed

+4967
-1542
lines changed

Some content is hidden

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

362 files changed

+4967
-1542
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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2277c505c2564f3548ac038828f7112f
3+
config: 30040e6d9d7431a212fbf5d5ab22b434
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

en/.doctrees/api/algorithms.doctree

34.3 KB
Binary file not shown.

en/.doctrees/api/computation.doctree

72 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
8.37 KB
Binary file not shown.
0 Bytes
Binary file not shown.
192 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
22.1 KB
Binary file not shown.
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

44.2 KB
Binary file not shown.

en/.doctrees/api/proxy.doctree

10.8 KB
Binary file not shown.
20.2 KB
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/environment.pickle

43.8 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
31.5 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/features/index.doctree

0 Bytes
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
9.12 KB
Binary file not shown.
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.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
528 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

en/.doctrees/requirements.doctree

0 Bytes
Binary file not shown.

en/_images/s_analysis.png

879 Bytes

en/_images/s_processing.png

544 Bytes

en/_modules/cdl/algorithms/coordinates.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5353
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5454

55-
<script src="../../../_static/documentation_options.js?v=587b3f23"></script>
55+
<script src="../../../_static/documentation_options.js?v=b52c616d"></script>
5656
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
5757
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5858
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
138138
<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark pst-js-only" alt=""/>
139139

140140

141-
<p class="title logo__title">v0.19.2</p>
141+
<p class="title logo__title">v0.20.0</p>
142142

143143
</a></div>
144144

en/_modules/cdl/algorithms/datatypes.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5353
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5454

55-
<script src="../../../_static/documentation_options.js?v=587b3f23"></script>
55+
<script src="../../../_static/documentation_options.js?v=b52c616d"></script>
5656
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
5757
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5858
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
138138
<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark pst-js-only" alt=""/>
139139

140140

141-
<p class="title logo__title">v0.19.2</p>
141+
<p class="title logo__title">v0.20.0</p>
142142

143143
</a></div>
144144

en/_modules/cdl/algorithms/image.html

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
5353
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
5454

55-
<script src="../../../_static/documentation_options.js?v=587b3f23"></script>
55+
<script src="../../../_static/documentation_options.js?v=b52c616d"></script>
5656
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
5757
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
5858
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -138,7 +138,7 @@
138138
<img src="../../../_static/DataLab-Title.svg" class="logo__image only-dark pst-js-only" alt=""/>
139139

140140

141-
<p class="title logo__title">v0.19.2</p>
141+
<p class="title logo__title">v0.20.0</p>
142142

143143
</a></div>
144144

@@ -521,6 +521,50 @@ <h1>Source code for cdl.algorithms.image</h1><div class="highlight"><pre>
521521
<span class="c1"># MARK: Fourier analysis ---------------------------------------------------------------</span>
522522

523523

524+
<div class="viewcode-block" id="zero_padding">
525+
<a class="viewcode-back" href="../../../api/algorithms.html#cdl.algorithms.image.zero_padding">[docs]</a>
526+
<span class="k">def</span> <span class="nf">zero_padding</span><span class="p">(</span>
527+
<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>
528+
<span class="n">rows</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
529+
<span class="n">cols</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
530+
<span class="n">position</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;bottom-right&quot;</span><span class="p">,</span> <span class="s2">&quot;center&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;bottom-right&quot;</span><span class="p">,</span>
531+
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
532+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
533+
<span class="sd"> Zero-pad a 2D image by adding rows and/or columns.</span>
534+
535+
<span class="sd"> Args:</span>
536+
<span class="sd"> image: 2D input image (grayscale)</span>
537+
<span class="sd"> rows: Number of rows to add in total (default: 0)</span>
538+
<span class="sd"> cols: Number of columns to add in total (default: 0)</span>
539+
<span class="sd"> position: Padding placement strategy:</span>
540+
<span class="sd"> - &quot;bottom-right&quot;: all padding is added to the bottom and right</span>
541+
<span class="sd"> - &quot;center&quot;: padding is split equally on top/bottom and left/right</span>
542+
543+
<span class="sd"> Returns:</span>
544+
<span class="sd"> The padded 2D image as a NumPy array.</span>
545+
546+
<span class="sd"> Raises:</span>
547+
<span class="sd"> ValueError: If the input is not a 2D array or if padding values are negative.</span>
548+
<span class="sd"> &quot;&quot;&quot;</span>
549+
<span class="k">if</span> <span class="n">rows</span> <span class="o">&lt;</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">cols</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
550+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Padding values must be non-negative&quot;</span><span class="p">)</span>
551+
<span class="k">if</span> <span class="n">image</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
552+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Only 2D grayscale images are supported&quot;</span><span class="p">)</span>
553+
554+
<span class="k">if</span> <span class="n">position</span> <span class="o">==</span> <span class="s2">&quot;bottom-right&quot;</span><span class="p">:</span>
555+
<span class="n">pad_width</span> <span class="o">=</span> <span class="p">((</span><span class="mi">0</span><span class="p">,</span> <span class="n">rows</span><span class="p">),</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">cols</span><span class="p">))</span>
556+
<span class="k">elif</span> <span class="n">position</span> <span class="o">==</span> <span class="s2">&quot;center&quot;</span><span class="p">:</span>
557+
<span class="n">pad_width</span> <span class="o">=</span> <span class="p">(</span>
558+
<span class="p">(</span><span class="n">rows</span> <span class="o">//</span> <span class="mi">2</span><span class="p">,</span> <span class="n">rows</span> <span class="o">-</span> <span class="n">rows</span> <span class="o">//</span> <span class="mi">2</span><span class="p">),</span>
559+
<span class="p">(</span><span class="n">cols</span> <span class="o">//</span> <span class="mi">2</span><span class="p">,</span> <span class="n">cols</span> <span class="o">-</span> <span class="n">cols</span> <span class="o">//</span> <span class="mi">2</span><span class="p">),</span>
560+
<span class="p">)</span>
561+
<span class="k">else</span><span class="p">:</span>
562+
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported padding_position: </span><span class="si">{</span><span class="n">position</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
563+
564+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">pad</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">pad_width</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;constant&quot;</span><span class="p">)</span></div>
565+
566+
567+
524568
<div class="viewcode-block" id="fft2d">
525569
<a class="viewcode-back" href="../../../api/algorithms.html#cdl.algorithms.image.fft2d">[docs]</a>
526570
<span class="k">def</span> <span class="nf">fft2d</span><span class="p">(</span><span class="n">z</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">shift</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>

0 commit comments

Comments
 (0)