examples.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  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>Examples &mdash; IPFML v0.2.3 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="Contributing" href="contributing.html" />
  13. <link rel="prev" title="Documentation" href="ipfml.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.2.3
  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"><a class="reference internal" href="ipfml.html">Documentation</a></li>
  39. <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul>
  40. <li class="toctree-l2"><a class="reference internal" href="#metrics-example">Metrics example</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="#processing-example">Processing example</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="#noise-filter-example">Noise filter example</a></li>
  43. </ul>
  44. </li>
  45. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
  46. </ul>
  47. </div>
  48. </div>
  49. </nav>
  50. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  51. <nav class="wy-nav-top" aria-label="top navigation">
  52. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  53. <a href="index.html">IPFML</a>
  54. </nav>
  55. <div class="wy-nav-content">
  56. <div class="rst-content">
  57. <div role="navigation" aria-label="breadcrumbs navigation">
  58. <ul class="wy-breadcrumbs">
  59. <li><a href="index.html">Docs</a> &raquo;</li>
  60. <li>Examples</li>
  61. <li class="wy-breadcrumbs-aside">
  62. <a href="_sources/examples.rst.txt" rel="nofollow"> View page source</a>
  63. </li>
  64. </ul>
  65. <hr/>
  66. </div>
  67. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  68. <div itemprop="articleBody">
  69. <div class="section" id="examples">
  70. <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
  71. <p>Some examples are already available into documentation. You can find here some others and results of use of IPFML package.</p>
  72. <p>All examples below will use this picture.</p>
  73. <img alt="_images/nature.jpg" src="_images/nature.jpg" />
  74. <div class="section" id="metrics-example">
  75. <h2>Metrics example<a class="headerlink" href="#metrics-example" title="Permalink to this headline">¶</a></h2>
  76. <p>Using <strong>metrics</strong> module you can convert image into Lab, XYZ, SVD…</p>
  77. <div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  78. <span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
  79. <span class="n">img_path</span> <span class="o">=</span> <span class="s1">&#39;path/to/image_nature.jpg&#39;</span>
  80. <span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span>
  81. <span class="n">s</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  82. <span class="c1"># convert result into PIL Image</span>
  83. <span class="n">output</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
  84. <span class="n">output</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
  85. </pre></div>
  86. </div>
  87. <p>This is the generated output using only L chanel from Lab.</p>
  88. <img alt="_images/nature_lab_l.png" src="_images/nature_lab_l.png" />
  89. </div>
  90. <div class="section" id="processing-example">
  91. <h2>Processing example<a class="headerlink" href="#processing-example" title="Permalink to this headline">¶</a></h2>
  92. <div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  93. <span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  94. <span class="n">img_path</span> <span class="o">=</span> <span class="s1">&#39;path/to/image_nature.jpg&#39;</span>
  95. <span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span>
  96. <span class="n">low_bits_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_grey_low_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span>
  97. <span class="n">output</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">low_bits_img</span><span class="p">)</span>
  98. <span class="n">output</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
  99. </pre></div>
  100. </div>
  101. <p>Now we have picture information with only the 6 low bits values.</p>
  102. <img alt="_images/nature_low_bits_6.png" src="_images/nature_low_bits_6.png" />
  103. </div>
  104. <div class="section" id="noise-filter-example">
  105. <h2>Noise filter example<a class="headerlink" href="#noise-filter-example" title="Permalink to this headline">¶</a></h2>
  106. <div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  107. <span class="kn">from</span> <span class="nn">ipfml.filters</span> <span class="k">import</span> <span class="n">noise</span> <span class="k">as</span> <span class="n">nf</span>
  108. <span class="n">img_path</span> <span class="o">=</span> <span class="s1">&#39;path/to/image_nature.jpg&#39;</span>
  109. <span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">img_path</span><span class="p">)</span>
  110. <span class="c1"># set noise impact to 30</span>
  111. <span class="n">noisy_image</span> <span class="o">=</span> <span class="n">nf</span><span class="o">.</span><span class="n">gaussian_noise</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">30</span><span class="p">)</span>
  112. <span class="n">output</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">noisy_image</span><span class="p">)</span>
  113. <span class="n">output</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
  114. </pre></div>
  115. </div>
  116. <p>Image result after applying gaussian noise on nature image.</p>
  117. <img alt="_images/nature_gaussian_noise.png" src="_images/nature_gaussian_noise.png" />
  118. </div>
  119. </div>
  120. </div>
  121. </div>
  122. <footer>
  123. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  124. <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  125. <a href="ipfml.html" class="btn btn-neutral" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  126. </div>
  127. <hr/>
  128. <div role="contentinfo">
  129. <p>
  130. &copy; Copyright 2019, Jérôme BUISINE
  131. </p>
  132. </div>
  133. 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>.
  134. </footer>
  135. </div>
  136. </div>
  137. </section>
  138. </div>
  139. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  140. <script type="text/javascript" src="_static/jquery.js"></script>
  141. <script type="text/javascript" src="_static/underscore.js"></script>
  142. <script type="text/javascript" src="_static/doctools.js"></script>
  143. <script type="text/javascript" src="_static/language_data.js"></script>
  144. <script type="text/javascript" src="_static/js/theme.js"></script>
  145. <script type="text/javascript">
  146. jQuery(function () {
  147. SphinxRtdTheme.Navigation.enable(true);
  148. });
  149. </script>
  150. </body>
  151. </html>