|
@@ -0,0 +1,337 @@
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+<!DOCTYPE html>
|
|
|
|
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
|
|
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
|
|
+<head>
|
|
|
|
+ <meta charset="utf-8">
|
|
|
|
+
|
|
|
|
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
+
|
|
|
|
+ <title>ipfml.filters.kernels — ipfml v0.4.4 documentation</title>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
|
|
|
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
+ <link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
+ <link rel="search" title="Search" href="../search.html" />
|
|
|
|
+ <link rel="next" title="ipfml.filters.noise" href="ipfml.filters.noise.html" />
|
|
|
|
+ <link rel="prev" title="ipfml.filters.convolution" href="ipfml.filters.convolution.html" />
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <script src="../_static/js/modernizr.min.js"></script>
|
|
|
|
+
|
|
|
|
+</head>
|
|
|
|
+
|
|
|
|
+<body class="wy-body-for-nav">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <div class="wy-grid-for-nav">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
|
|
+ <div class="wy-side-scroll">
|
|
|
|
+ <div class="wy-side-nav-search">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <a href="../index.html" class="icon icon-home"> ipfml
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ </a>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <div class="version">
|
|
|
|
+ 0.4.4
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+<div role="search">
|
|
|
|
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
|
|
+ <input type="text" name="q" placeholder="Search docs" />
|
|
|
|
+ <input type="hidden" name="check_keywords" value="yes" />
|
|
|
|
+ <input type="hidden" name="area" value="default" />
|
|
|
|
+ </form>
|
|
|
|
+</div>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <p class="caption"><span class="caption-text">Contents:</span></p>
|
|
|
|
+<ul class="current">
|
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
|
|
|
|
+<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
|
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
|
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
|
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
|
|
|
|
+<li class="toctree-l2 current"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a><ul class="current">
|
|
|
|
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
|
|
|
|
+<li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.filters.kernels</a></li>
|
|
|
|
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.noise.html">ipfml.filters.noise</a></li>
|
|
|
|
+</ul>
|
|
|
|
+</li>
|
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
|
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
|
|
|
|
+</ul>
|
|
|
|
+</li>
|
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
|
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
|
|
|
+</ul>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+ </div>
|
|
|
|
+ </nav>
|
|
|
|
+
|
|
|
|
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
+
|
|
|
|
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
|
|
+ <a href="../index.html">ipfml</a>
|
|
|
|
+
|
|
|
|
+ </nav>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <div class="wy-nav-content">
|
|
|
|
+
|
|
|
|
+ <div class="rst-content">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
+
|
|
|
|
+ <ul class="wy-breadcrumbs">
|
|
|
|
+
|
|
|
|
+ <li><a href="../index.html">Docs</a> »</li>
|
|
|
|
+
|
|
|
|
+ <li><a href="../ipfml.html">Documentation</a> »</li>
|
|
|
|
+
|
|
|
|
+ <li>ipfml.filters.kernels</li>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <li class="wy-breadcrumbs-aside">
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.filters.kernels.rst" class="fa fa-github"> Edit on GitHub</a>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ </li>
|
|
|
|
+
|
|
|
|
+ </ul>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <hr/>
|
|
|
|
+</div>
|
|
|
|
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
|
+ <div itemprop="articleBody">
|
|
|
|
+
|
|
|
|
+ <div class="section" id="module-ipfml.filters.kernels">
|
|
|
|
+<span id="ipfml-filters-kernels"></span><h1>ipfml.filters.kernels<a class="headerlink" href="#module-ipfml.filters.kernels" title="Permalink to this headline">¶</a></h1>
|
|
|
|
+<p>Kernel to apply on images using convolution</p>
|
|
|
|
+<p class="rubric">Functions</p>
|
|
|
|
+<table border="1" class="longtable docutils">
|
|
|
|
+<colgroup>
|
|
|
|
+<col width="10%" />
|
|
|
|
+<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>
|
|
|
|
+<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>
|
|
|
|
+<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>
|
|
|
|
+<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>
|
|
|
|
+<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>
|
|
|
|
+</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>
|
|
|
|
+<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>
|
|
|
|
+</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>
|
|
|
|
+<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="go">3.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>
|
|
|
|
+<dd><p>Plane max error kernel to use with convolution process on image</p>
|
|
|
|
+<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">Difference between max and min error from mean plane</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">plane_max_error</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">plane_max_error</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
|
|
|
|
+<span class="gp">>>> </span><span class="p">(</span><span class="n">result</span> <span class="o"><</span> <span class="mf">0.0001</span><span class="p">)</span>
|
|
|
|
+<span class="go">True</span>
|
|
|
|
+</pre></div>
|
|
|
|
+</div>
|
|
|
|
+</dd></dl>
|
|
|
|
+
|
|
|
|
+<dl class="function">
|
|
|
|
+<dt id="ipfml.filters.kernels.plane_mean">
|
|
|
|
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">plane_mean</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_mean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.plane_mean" title="Permalink to this definition">¶</a></dt>
|
|
|
|
+<dd><p>Plane mean kernel to use with convolution process on image</p>
|
|
|
|
+<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">Normalized residual error from mean plane</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">plane_mean</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">plane_mean</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
|
|
|
|
+<span class="gp">>>> </span><span class="p">(</span><span class="n">result</span> <span class="o"><</span> <span class="mf">0.0001</span><span class="p">)</span>
|
|
|
|
+<span class="go">True</span>
|
|
|
|
+</pre></div>
|
|
|
|
+</div>
|
|
|
|
+</dd></dl>
|
|
|
|
+
|
|
|
|
+</div>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+ <footer>
|
|
|
|
+
|
|
|
|
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
+
|
|
|
|
+ <a href="ipfml.filters.noise.html" class="btn btn-neutral float-right" title="ipfml.filters.noise" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <a href="ipfml.filters.convolution.html" class="btn btn-neutral" title="ipfml.filters.convolution" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <hr/>
|
|
|
|
+
|
|
|
|
+ <div role="contentinfo">
|
|
|
|
+ <p>
|
|
|
|
+ © Copyright 2019, Jérôme BUISINE
|
|
|
|
+
|
|
|
|
+ </p>
|
|
|
|
+ </div>
|
|
|
|
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
+
|
|
|
|
+</footer>
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+ </section>
|
|
|
|
+
|
|
|
|
+ </div>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
|
+ <script type="text/javascript" src="../_static/jquery.js"></script>
|
|
|
|
+ <script type="text/javascript" src="../_static/underscore.js"></script>
|
|
|
|
+ <script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
|
+ <script type="text/javascript" src="../_static/language_data.js"></script>
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
+
|
|
|
|
+ <script type="text/javascript">
|
|
|
|
+ jQuery(function () {
|
|
|
|
+ SphinxRtdTheme.Navigation.enable(true);
|
|
|
|
+ });
|
|
|
|
+ </script>
|
|
|
|
+
|
|
|
|
+</body>
|
|
|
|
+</html>
|