123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 |
- <!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.convolution — ipfml v0.4.5 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" />
-
- <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.5
- </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>
- <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation</a></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="../../index.html">Module code</a> »</li>
-
- <li>ipfml.filters.convolution</li>
-
-
- <li class="wy-breadcrumbs-aside">
-
- </li>
-
- </ul>
-
- <hr/>
- </div>
- <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
- <div itemprop="articleBody">
-
- <h1>Source code for ipfml.filters.convolution</h1><div class="highlight"><pre>
- <span></span><span class="sd">"""</span>
- <span class="sd">Convolution functions to apply on images</span>
- <span class="sd">"""</span>
- <span class="c1"># main imports</span>
- <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
- <div class="viewcode-block" id="convolution2D"><a class="viewcode-back" href="../../../ipfml/ipfml.filters.convolution.html#ipfml.filters.convolution.convolution2D">[docs]</a><span class="k">def</span> <span class="nf">convolution2D</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">kernel</span><span class="p">,</span> <span class="n">kernel_size</span><span class="o">=</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">5</span><span class="p">)):</span>
- <span class="sd">"""Apply 2D convolution on image using specific kernel from `ipfml.filters.kernels`</span>
- <span class="sd"> Args:</span>
- <span class="sd"> image: 2D image to apply convolution on</span>
- <span class="sd"> kernel: specific kernel from `ipfml.filters.kernels` to use</span>
- <span class="sd"> kernel_size: window size to use (default (5, 5))</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> 2D numpy array obtained from image using kernel</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.filters.convolution import convolution2D</span>
- <span class="sd"> >>> from ipfml.filters.kernels import plane_mean</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> image = np.arange(81).reshape([9, 9])</span>
- <span class="sd"> >>> convolved_image = convolution2D(image, plane_mean, (3, 3)) </span>
- <span class="sd"> >>> convolved_image.shape</span>
- <span class="sd"> (7, 7)</span>
- <span class="sd"> """</span>
- <span class="n">img</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
- <span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">img</span><span class="o">.</span><span class="n">shape</span>
- <span class="n">kernel_width</span><span class="p">,</span> <span class="n">kernel_height</span> <span class="o">=</span> <span class="n">kernel_size</span>
- <span class="k">if</span> <span class="n">kernel_width</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">kernel_height</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
- <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Invalid kernel size, need to be of odd size"</span><span class="p">)</span>
- <span class="n">padding_height</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel_width</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="mi">2</span>
- <span class="n">padding_width</span> <span class="o">=</span> <span class="p">(</span><span class="n">kernel_width</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="mi">2</span>
- <span class="n">img_diff</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">width</span><span class="p">):</span>
- <span class="k">if</span> <span class="n">i</span> <span class="o">>=</span> <span class="n">padding_width</span> <span class="ow">and</span> <span class="n">i</span> <span class="o"><</span> <span class="p">(</span><span class="n">width</span> <span class="o">-</span> <span class="n">padding_width</span><span class="p">):</span>
- <span class="n">row_diff</span> <span class="o">=</span> <span class="p">[]</span>
- <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">height</span><span class="p">):</span>
- <span class="k">if</span> <span class="n">j</span> <span class="o">>=</span> <span class="n">padding_height</span> <span class="ow">and</span> <span class="n">j</span> <span class="o"><</span> <span class="p">(</span><span class="n">height</span> <span class="o">-</span> <span class="n">padding_height</span><span class="p">):</span>
- <span class="c1"># pixel in the center of kernel window size, need to extract window from img</span>
- <span class="n">window</span> <span class="o">=</span> <span class="n">img</span><span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span> <span class="o">-</span> <span class="n">padding_width</span><span class="p">):</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="n">padding_width</span> <span class="o">+</span>
- <span class="mi">1</span><span class="p">),</span>
- <span class="nb">int</span><span class="p">(</span><span class="n">j</span> <span class="o">-</span> <span class="n">padding_height</span>
- <span class="p">):</span><span class="nb">int</span><span class="p">(</span><span class="n">j</span> <span class="o">+</span> <span class="n">padding_height</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)]</span>
- <span class="n">diff</span> <span class="o">=</span> <span class="n">kernel</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
- <span class="n">row_diff</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">diff</span><span class="p">)</span>
- <span class="n">img_diff</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">row_diff</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">img_diff</span><span class="p">)</span></div>
- </pre></div>
- </div>
-
- </div>
- <footer>
-
- <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>
|