utils.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  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.utils &mdash; IPFML v0.3.1 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. <script src="../../_static/js/modernizr.min.js"></script>
  13. </head>
  14. <body class="wy-body-for-nav">
  15. <div class="wy-grid-for-nav">
  16. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  17. <div class="wy-side-scroll">
  18. <div class="wy-side-nav-search">
  19. <a href="../../index.html" class="icon icon-home"> IPFML
  20. </a>
  21. <div class="version">
  22. 0.3.1
  23. </div>
  24. <div role="search">
  25. <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
  26. <input type="text" name="q" placeholder="Search docs" />
  27. <input type="hidden" name="check_keywords" value="yes" />
  28. <input type="hidden" name="area" value="default" />
  29. </form>
  30. </div>
  31. </div>
  32. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  33. <p class="caption"><span class="caption-text">Contents:</span></p>
  34. <ul>
  35. <li class="toctree-l1"><a class="reference internal" href="../../description.html">Description</a></li>
  36. <li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation</a></li>
  37. <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
  38. <li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
  39. </ul>
  40. </div>
  41. </div>
  42. </nav>
  43. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  44. <nav class="wy-nav-top" aria-label="top navigation">
  45. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  46. <a href="../../index.html">IPFML</a>
  47. </nav>
  48. <div class="wy-nav-content">
  49. <div class="rst-content">
  50. <div role="navigation" aria-label="breadcrumbs navigation">
  51. <ul class="wy-breadcrumbs">
  52. <li><a href="../../index.html">Docs</a> &raquo;</li>
  53. <li><a href="../index.html">Module code</a> &raquo;</li>
  54. <li>ipfml.utils</li>
  55. <li class="wy-breadcrumbs-aside">
  56. </li>
  57. </ul>
  58. <hr/>
  59. </div>
  60. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  61. <div itemprop="articleBody">
  62. <h1>Source code for ipfml.utils</h1><div class="highlight"><pre>
  63. <span></span><span class="sd">&quot;&quot;&quot;</span>
  64. <span class="sd">Utils functions of ipfml package (array normalization)</span>
  65. <span class="sd">&quot;&quot;&quot;</span>
  66. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  67. <div class="viewcode-block" id="normalize_arr"><a class="viewcode-back" href="../../ipfml/ipfml.utils.html#ipfml.utils.normalize_arr">[docs]</a><span class="k">def</span> <span class="nf">normalize_arr</span><span class="p">(</span><span class="n">arr</span><span class="p">):</span>
  68. <span class="sd">&#39;&#39;&#39;Normalize data of 1D array shape</span>
  69. <span class="sd"> Args:</span>
  70. <span class="sd"> arr: array data of 1D shape</span>
  71. <span class="sd"> Returns:</span>
  72. <span class="sd"> Normalized 1D array</span>
  73. <span class="sd"> Example:</span>
  74. <span class="sd"> &gt;&gt;&gt; from ipfml import utils</span>
  75. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  76. <span class="sd"> &gt;&gt;&gt; arr = np.arange(11)</span>
  77. <span class="sd"> &gt;&gt;&gt; arr_normalized = utils.normalize_arr(arr)</span>
  78. <span class="sd"> &gt;&gt;&gt; arr_normalized[1]</span>
  79. <span class="sd"> 0.1</span>
  80. <span class="sd"> &#39;&#39;&#39;</span>
  81. <span class="n">output_arr</span> <span class="o">=</span> <span class="p">[]</span>
  82. <span class="n">max_value</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">arr</span><span class="p">)</span>
  83. <span class="n">min_value</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">arr</span><span class="p">)</span>
  84. <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">arr</span><span class="p">:</span>
  85. <span class="n">output_arr</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">v</span> <span class="o">-</span> <span class="n">min_value</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">max_value</span> <span class="o">-</span> <span class="n">min_value</span><span class="p">))</span>
  86. <span class="k">return</span> <span class="n">output_arr</span></div>
  87. <div class="viewcode-block" id="normalize_arr_with_range"><a class="viewcode-back" href="../../ipfml/ipfml.utils.html#ipfml.utils.normalize_arr_with_range">[docs]</a><span class="k">def</span> <span class="nf">normalize_arr_with_range</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="nb">min</span><span class="p">,</span> <span class="nb">max</span><span class="p">):</span>
  88. <span class="sd">&#39;&#39;&#39;Normalize data of 1D array shape</span>
  89. <span class="sd"> Args:</span>
  90. <span class="sd"> arr: array data of 1D shape</span>
  91. <span class="sd"> Returns:</span>
  92. <span class="sd"> Normalized 1D Numpy array</span>
  93. <span class="sd"> Example:</span>
  94. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  95. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  96. <span class="sd"> &gt;&gt;&gt; arr = np.arange(11)</span>
  97. <span class="sd"> &gt;&gt;&gt; arr_normalized = processing.normalize_arr_with_range(arr, 0, 20)</span>
  98. <span class="sd"> &gt;&gt;&gt; arr_normalized[1]</span>
  99. <span class="sd"> 0.05</span>
  100. <span class="sd"> &#39;&#39;&#39;</span>
  101. <span class="n">output_arr</span> <span class="o">=</span> <span class="p">[]</span>
  102. <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">arr</span><span class="p">:</span>
  103. <span class="n">output_arr</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">v</span> <span class="o">-</span> <span class="nb">min</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="nb">max</span> <span class="o">-</span> <span class="nb">min</span><span class="p">))</span>
  104. <span class="k">return</span> <span class="n">output_arr</span></div>
  105. <div class="viewcode-block" id="normalize_2D_arr"><a class="viewcode-back" href="../../ipfml/ipfml.utils.html#ipfml.utils.normalize_2D_arr">[docs]</a><span class="k">def</span> <span class="nf">normalize_2D_arr</span><span class="p">(</span><span class="n">arr</span><span class="p">):</span>
  106. <span class="sd">&quot;&quot;&quot;Return array normalize from its min and max values</span>
  107. <span class="sd"> Args:</span>
  108. <span class="sd"> arr: 2D Numpy array</span>
  109. <span class="sd"> Returns:</span>
  110. <span class="sd"> Normalized 2D Numpy array</span>
  111. <span class="sd"> Example:</span>
  112. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  113. <span class="sd"> &gt;&gt;&gt; from ipfml import utils, processing</span>
  114. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  115. <span class="sd"> &gt;&gt;&gt; img_mscn = processing.rgb_to_mscn(img)</span>
  116. <span class="sd"> &gt;&gt;&gt; img_normalized = utils.normalize_2D_arr(img_mscn)</span>
  117. <span class="sd"> &gt;&gt;&gt; img_normalized.shape</span>
  118. <span class="sd"> (200, 200)</span>
  119. <span class="sd"> &quot;&quot;&quot;</span>
  120. <span class="c1"># getting min and max value from 2D array</span>
  121. <span class="n">max_value</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">max</span><span class="p">(</span><span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">max</span><span class="p">()</span>
  122. <span class="n">min_value</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">min</span><span class="p">(</span><span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">min</span><span class="p">()</span>
  123. <span class="c1"># normalize each row</span>
  124. <span class="n">output_array</span> <span class="o">=</span> <span class="p">[]</span>
  125. <span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">shape</span>
  126. <span class="k">for</span> <span class="n">row_index</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">height</span><span class="p">):</span>
  127. <span class="n">values</span> <span class="o">=</span> <span class="n">arr</span><span class="p">[</span><span class="n">row_index</span><span class="p">,</span> <span class="p">:]</span>
  128. <span class="n">output_array</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  129. <span class="n">normalize_arr_with_range</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">min_value</span><span class="p">,</span> <span class="n">max_value</span><span class="p">))</span>
  130. <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">output_array</span><span class="p">)</span></div>
  131. </pre></div>
  132. </div>
  133. </div>
  134. <footer>
  135. <hr/>
  136. <div role="contentinfo">
  137. <p>
  138. &copy; Copyright 2019, Jérôme BUISINE
  139. </p>
  140. </div>
  141. 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>.
  142. </footer>
  143. </div>
  144. </div>
  145. </section>
  146. </div>
  147. <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
  148. <script type="text/javascript" src="../../_static/jquery.js"></script>
  149. <script type="text/javascript" src="../../_static/underscore.js"></script>
  150. <script type="text/javascript" src="../../_static/doctools.js"></script>
  151. <script type="text/javascript" src="../../_static/language_data.js"></script>
  152. <script type="text/javascript" src="../../_static/js/theme.js"></script>
  153. <script type="text/javascript">
  154. jQuery(function () {
  155. SphinxRtdTheme.Navigation.enable(true);
  156. });
  157. </script>
  158. </body>
  159. </html>