ipfml.filters.kernels.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>ipfml.filters.kernels &mdash; ipfml v0.4.4 documentation</title>
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="../genindex.html" />
  11. <link rel="search" title="Search" href="../search.html" />
  12. <link rel="next" title="ipfml.filters.noise" href="ipfml.filters.noise.html" />
  13. <link rel="prev" title="ipfml.filters.convolution" href="ipfml.filters.convolution.html" />
  14. <script src="../_static/js/modernizr.min.js"></script>
  15. </head>
  16. <body class="wy-body-for-nav">
  17. <div class="wy-grid-for-nav">
  18. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  19. <div class="wy-side-scroll">
  20. <div class="wy-side-nav-search">
  21. <a href="../index.html" class="icon icon-home"> ipfml
  22. </a>
  23. <div class="version">
  24. 0.4.4
  25. </div>
  26. <div role="search">
  27. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  28. <input type="text" name="q" placeholder="Search docs" />
  29. <input type="hidden" name="check_keywords" value="yes" />
  30. <input type="hidden" name="area" value="default" />
  31. </form>
  32. </div>
  33. </div>
  34. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  35. <p class="caption"><span class="caption-text">Contents:</span></p>
  36. <ul class="current">
  37. <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
  38. <li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
  39. <li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
  42. <li class="toctree-l2 current"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a><ul class="current">
  43. <li class="toctree-l3"><a class="reference internal" href="ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
  44. <li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.filters.kernels</a></li>
  45. <li class="toctree-l3"><a class="reference internal" href="ipfml.filters.noise.html">ipfml.filters.noise</a></li>
  46. </ul>
  47. </li>
  48. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  54. </ul>
  55. </div>
  56. </div>
  57. </nav>
  58. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  59. <nav class="wy-nav-top" aria-label="top navigation">
  60. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  61. <a href="../index.html">ipfml</a>
  62. </nav>
  63. <div class="wy-nav-content">
  64. <div class="rst-content">
  65. <div role="navigation" aria-label="breadcrumbs navigation">
  66. <ul class="wy-breadcrumbs">
  67. <li><a href="../index.html">Docs</a> &raquo;</li>
  68. <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
  69. <li>ipfml.filters.kernels</li>
  70. <li class="wy-breadcrumbs-aside">
  71. <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>
  72. </li>
  73. </ul>
  74. <hr/>
  75. </div>
  76. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  77. <div itemprop="articleBody">
  78. <div class="section" id="module-ipfml.filters.kernels">
  79. <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>
  80. <p>Kernel to apply on images using convolution</p>
  81. <p class="rubric">Functions</p>
  82. <table border="1" class="longtable docutils">
  83. <colgroup>
  84. <col width="10%" />
  85. <col width="90%" />
  86. </colgroup>
  87. <tbody valign="top">
  88. <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[,&nbsp;func])</td>
  89. <td>Bilaeral difference kernel to use with convolution process on image</td>
  90. </tr>
  91. <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>
  92. <td>Plane max error kernel to use with convolution process on image</td>
  93. </tr>
  94. <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>
  95. <td>Plane mean kernel to use with convolution process on image</td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <dl class="function">
  100. <dt id="ipfml.filters.kernels.bilateral_diff">
  101. <code class="descclassname">ipfml.filters.kernels.</code><code class="descname">bilateral_diff</code><span class="sig-paren">(</span><em>window</em>, <em>func=&lt;built-in function max&gt;</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>
  102. <dd><dl class="docutils">
  103. <dt>Bilaeral difference kernel to use with convolution process on image</dt>
  104. <dd>Apply difference pixel to pixel and keep max on min difference before applying mean</dd>
  105. </dl>
  106. <table class="docutils field-list" frame="void" rules="none">
  107. <col class="field-name" />
  108. <col class="field-body" />
  109. <tbody valign="top">
  110. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  111. <li><strong>window</strong> – the window part to use from image</li>
  112. <li><strong>func</strong> – max or min function to get difference between pixels</li>
  113. </ul>
  114. </td>
  115. </tr>
  116. <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>
  117. </td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. <p>Example:</p>
  122. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">bilateral_diff</span>
  123. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  124. <span class="gp">&gt;&gt;&gt; </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>
  125. <span class="gp">&gt;&gt;&gt; </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>
  126. <span class="gp">&gt;&gt;&gt; </span><span class="n">result</span>
  127. <span class="go">3.0</span>
  128. </pre></div>
  129. </div>
  130. </dd></dl>
  131. <dl class="function">
  132. <dt id="ipfml.filters.kernels.plane_max_error">
  133. <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>
  134. <dd><p>Plane max error kernel to use with convolution process on image</p>
  135. <table class="docutils field-list" frame="void" rules="none">
  136. <col class="field-name" />
  137. <col class="field-body" />
  138. <tbody valign="top">
  139. <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>
  140. </tr>
  141. <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>
  142. </tr>
  143. </tbody>
  144. </table>
  145. <p>Example:</p>
  146. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </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>
  147. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  148. <span class="gp">&gt;&gt;&gt; </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>
  149. <span class="gp">&gt;&gt;&gt; </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>
  150. <span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">result</span> <span class="o">&lt;</span> <span class="mf">0.0001</span><span class="p">)</span>
  151. <span class="go">True</span>
  152. </pre></div>
  153. </div>
  154. </dd></dl>
  155. <dl class="function">
  156. <dt id="ipfml.filters.kernels.plane_mean">
  157. <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>
  158. <dd><p>Plane mean kernel to use with convolution process on image</p>
  159. <table class="docutils field-list" frame="void" rules="none">
  160. <col class="field-name" />
  161. <col class="field-body" />
  162. <tbody valign="top">
  163. <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>
  164. </tr>
  165. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Normalized residual error from mean plane</td>
  166. </tr>
  167. </tbody>
  168. </table>
  169. <p>Example:</p>
  170. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">plane_mean</span>
  171. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  172. <span class="gp">&gt;&gt;&gt; </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>
  173. <span class="gp">&gt;&gt;&gt; </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>
  174. <span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">result</span> <span class="o">&lt;</span> <span class="mf">0.0001</span><span class="p">)</span>
  175. <span class="go">True</span>
  176. </pre></div>
  177. </div>
  178. </dd></dl>
  179. </div>
  180. </div>
  181. </div>
  182. <footer>
  183. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  184. <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>
  185. <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>
  186. </div>
  187. <hr/>
  188. <div role="contentinfo">
  189. <p>
  190. &copy; Copyright 2019, Jérôme BUISINE
  191. </p>
  192. </div>
  193. 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>.
  194. </footer>
  195. </div>
  196. </div>
  197. </section>
  198. </div>
  199. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  200. <script type="text/javascript" src="../_static/jquery.js"></script>
  201. <script type="text/javascript" src="../_static/underscore.js"></script>
  202. <script type="text/javascript" src="../_static/doctools.js"></script>
  203. <script type="text/javascript" src="../_static/language_data.js"></script>
  204. <script type="text/javascript" src="../_static/js/theme.js"></script>
  205. <script type="text/javascript">
  206. jQuery(function () {
  207. SphinxRtdTheme.Navigation.enable(true);
  208. });
  209. </script>
  210. </body>
  211. </html>