|
@@ -8,7 +8,7 @@
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
- <title>ipfml.filters.kernels — ipfml v0.4.6 documentation</title>
|
|
|
+ <title>ipfml.filters.kernels — ipfml v0.4.7 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
@@ -58,7 +58,7 @@
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
|
- 0.4.6
|
|
|
+ 0.4.7
|
|
|
</div>
|
|
|
|
|
|
|
|
@@ -179,50 +179,76 @@
|
|
|
<col width="90%" />
|
|
|
</colgroup>
|
|
|
<tbody valign="top">
|
|
|
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.filters.kernels.bilateral_diff" title="ipfml.filters.kernels.bilateral_diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bilateral_diff</span></code></a>(window[, func])</td>
|
|
|
-<td>Bilaeral difference kernel to use with convolution process on image</td>
|
|
|
+<tr class="row-odd"><td><a class="reference internal" href="#ipfml.filters.kernels.max_bilateral_diff" title="ipfml.filters.kernels.max_bilateral_diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">max_bilateral_diff</span></code></a>(window)</td>
|
|
|
+<td>Bilateral difference kernel to use with convolution process on image</td>
|
|
|
</tr>
|
|
|
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_max_error" title="ipfml.filters.kernels.plane_max_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_max_error</span></code></a>(window)</td>
|
|
|
+<tr class="row-even"><td><a class="reference internal" href="#ipfml.filters.kernels.min_bilateral_diff" title="ipfml.filters.kernels.min_bilateral_diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">min_bilateral_diff</span></code></a>(window)</td>
|
|
|
+<td>Bilateral difference kernel to use with convolution process on image</td>
|
|
|
+</tr>
|
|
|
+<tr class="row-odd"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_max_error" title="ipfml.filters.kernels.plane_max_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_max_error</span></code></a>(window)</td>
|
|
|
<td>Plane max error kernel to use with convolution process on image</td>
|
|
|
</tr>
|
|
|
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_mean" title="ipfml.filters.kernels.plane_mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_mean</span></code></a>(window)</td>
|
|
|
+<tr class="row-even"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_mean" title="ipfml.filters.kernels.plane_mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_mean</span></code></a>(window)</td>
|
|
|
<td>Plane mean kernel to use with convolution process on image</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<dl class="function">
|
|
|
-<dt id="ipfml.filters.kernels.bilateral_diff">
|
|
|
-<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">bilateral_diff</code><span class="sig-paren">(</span><em>window</em>, <em>func=<built-in function max></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#bilateral_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.bilateral_diff" title="Permalink to this definition">¶</a></dt>
|
|
|
+<dt id="ipfml.filters.kernels.max_bilateral_diff">
|
|
|
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">max_bilateral_diff</code><span class="sig-paren">(</span><em>window</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#max_bilateral_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.max_bilateral_diff" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><dl class="docutils">
|
|
|
-<dt>Bilaeral difference kernel to use with convolution process on image</dt>
|
|
|
-<dd>Apply difference pixel to pixel and keep max on min difference before applying mean</dd>
|
|
|
+<dt>Bilateral difference kernel to use with convolution process on image</dt>
|
|
|
+<dd>Apply difference pixel to pixel and keep max difference before applying mean</dd>
|
|
|
</dl>
|
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|
|
<col class="field-name" />
|
|
|
<col class="field-body" />
|
|
|
<tbody valign="top">
|
|
|
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|
|
-<li><strong>window</strong> – the window part to use from image</li>
|
|
|
-<li><strong>func</strong> – max or min function to get difference between pixels</li>
|
|
|
-</ul>
|
|
|
-</td>
|
|
|
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>window</strong> – the window part to use from image</td>
|
|
|
</tr>
|
|
|
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">mean of max or min difference of pixels</p>
|
|
|
-</td>
|
|
|
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">mean of max difference of pixels</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p>Example:</p>
|
|
|
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">bilateral_diff</span>
|
|
|
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">max_bilateral_diff</span>
|
|
|
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
|
|
<span class="gp">>>> </span><span class="n">window</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
|
|
|
-<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">bilateral_diff</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
|
|
|
+<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">max_bilateral_diff</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
|
|
|
<span class="gp">>>> </span><span class="n">result</span>
|
|
|
<span class="go">3.0</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
+<dl class="function">
|
|
|
+<dt id="ipfml.filters.kernels.min_bilateral_diff">
|
|
|
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">min_bilateral_diff</code><span class="sig-paren">(</span><em>window</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#min_bilateral_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.min_bilateral_diff" title="Permalink to this definition">¶</a></dt>
|
|
|
+<dd><dl class="docutils">
|
|
|
+<dt>Bilateral difference kernel to use with convolution process on image</dt>
|
|
|
+<dd>Apply difference pixel to pixel and keep min difference before applying mean</dd>
|
|
|
+</dl>
|
|
|
+<table class="docutils field-list" frame="void" rules="none">
|
|
|
+<col class="field-name" />
|
|
|
+<col class="field-body" />
|
|
|
+<tbody valign="top">
|
|
|
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>window</strong> – the window part to use from image</td>
|
|
|
+</tr>
|
|
|
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">mean of min difference of pixels</td>
|
|
|
+</tr>
|
|
|
+</tbody>
|
|
|
+</table>
|
|
|
+<p>Example:</p>
|
|
|
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">min_bilateral_diff</span>
|
|
|
+<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
|
|
+<span class="gp">>>> </span><span class="n">window</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
|
|
|
+<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">min_bilateral_diff</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
|
|
|
+<span class="gp">>>> </span><span class="n">result</span>
|
|
|
+<span class="go">1.0</span>
|
|
|
+</pre></div>
|
|
|
+</div>
|
|
|
+</dd></dl>
|
|
|
+
|
|
|
<dl class="function">
|
|
|
<dt id="ipfml.filters.kernels.plane_max_error">
|
|
|
<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">plane_max_error</code><span class="sig-paren">(</span><em>window</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#plane_max_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.plane_max_error" title="Permalink to this definition">¶</a></dt>
|