ipfml.processing.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644
  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.processing &mdash; IPFML v0.3.6 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.utils" href="ipfml.utils.html" />
  13. <link rel="prev" title="ipfml.metrics" href="ipfml.metrics.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.3.6
  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 current"><a class="current reference internal" href="#">ipfml.processing</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
  45. </ul>
  46. </li>
  47. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </nav>
  53. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  54. <nav class="wy-nav-top" aria-label="top navigation">
  55. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  56. <a href="../index.html">IPFML</a>
  57. </nav>
  58. <div class="wy-nav-content">
  59. <div class="rst-content">
  60. <div role="navigation" aria-label="breadcrumbs navigation">
  61. <ul class="wy-breadcrumbs">
  62. <li><a href="../index.html">Docs</a> &raquo;</li>
  63. <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
  64. <li>ipfml.processing</li>
  65. <li class="wy-breadcrumbs-aside">
  66. <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml/ipfml.processing.rst" class="fa fa-github"> Edit on GitHub</a>
  67. </li>
  68. </ul>
  69. <hr/>
  70. </div>
  71. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  72. <div itemprop="articleBody">
  73. <div class="section" id="module-ipfml.processing">
  74. <span id="ipfml-processing"></span><h1>ipfml.processing<a class="headerlink" href="#module-ipfml.processing" title="Permalink to this headline">¶</a></h1>
  75. <p>Functions to quickly extract reduced information from image</p>
  76. <p class="rubric">Functions</p>
  77. <table border="1" class="longtable docutils">
  78. <colgroup>
  79. <col width="10%" />
  80. <col width="90%" />
  81. </colgroup>
  82. <tbody valign="top">
  83. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.divide_in_blocks" title="ipfml.processing.divide_in_blocks"><code class="xref py py-obj docutils literal notranslate"><span class="pre">divide_in_blocks</span></code></a>(image,&nbsp;block_size[,&nbsp;pil])</td>
  84. <td>Divide image into equal size blocks</td>
  85. </tr>
  86. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.fusion_images" title="ipfml.processing.fusion_images"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fusion_images</span></code></a>(images[,&nbsp;pil])</td>
  87. <td>Fusion array of images into single image</td>
  88. </tr>
  89. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.get_LAB_L_SVD" title="ipfml.processing.get_LAB_L_SVD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L_SVD</span></code></a>(image)</td>
  90. <td>Returns Singular values from LAB L Image information</td>
  91. </tr>
  92. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.get_LAB_L_SVD_U" title="ipfml.processing.get_LAB_L_SVD_U"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L_SVD_U</span></code></a>(image)</td>
  93. <td>Returns U SVD from L of LAB Image information</td>
  94. </tr>
  95. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.get_LAB_L_SVD_V" title="ipfml.processing.get_LAB_L_SVD_V"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L_SVD_V</span></code></a>(image)</td>
  96. <td>Returns V SVD from L of LAB Image information</td>
  97. </tr>
  98. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.get_LAB_L_SVD_s" title="ipfml.processing.get_LAB_L_SVD_s"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L_SVD_s</span></code></a>(image)</td>
  99. <td>Returns s (Singular values) SVD from L of LAB Image information</td>
  100. </tr>
  101. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.get_mscn_coefficients" title="ipfml.processing.get_mscn_coefficients"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_mscn_coefficients</span></code></a>(image)</td>
  102. <td>Compute the Mean Substracted Constrast Normalized coefficients of an image</td>
  103. </tr>
  104. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.rgb_to_LAB_L_bits" title="ipfml.processing.rgb_to_LAB_L_bits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rgb_to_LAB_L_bits</span></code></a>(image,&nbsp;interval)</td>
  105. <td>Returns only bits from LAB L canal specified into the interval</td>
  106. </tr>
  107. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.rgb_to_LAB_L_low_bits" title="ipfml.processing.rgb_to_LAB_L_low_bits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rgb_to_LAB_L_low_bits</span></code></a>(image[,&nbsp;nb_bits])</td>
  108. <td>Convert RGB Image into Lab L channel image using only 4 low bits values</td>
  109. </tr>
  110. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.rgb_to_grey_low_bits" title="ipfml.processing.rgb_to_grey_low_bits"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rgb_to_grey_low_bits</span></code></a>(image[,&nbsp;nb_bits])</td>
  111. <td>Convert RGB Image into grey image using only 4 low bits values</td>
  112. </tr>
  113. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.rgb_to_mscn" title="ipfml.processing.rgb_to_mscn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rgb_to_mscn</span></code></a>(image)</td>
  114. <td>Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</td>
  115. </tr>
  116. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.rotate_image" title="ipfml.processing.rotate_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rotate_image</span></code></a>(image[,&nbsp;angle,&nbsp;pil])</td>
  117. <td>Rotate image using specific angle</td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. <dl class="function">
  122. <dt id="ipfml.processing.divide_in_blocks">
  123. <code class="descclassname">ipfml.processing.</code><code class="descname">divide_in_blocks</code><span class="sig-paren">(</span><em>image</em>, <em>block_size</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#divide_in_blocks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.divide_in_blocks" title="Permalink to this definition">¶</a></dt>
  124. <dd><p>Divide image into equal size blocks</p>
  125. <table class="docutils field-list" frame="void" rules="none">
  126. <col class="field-name" />
  127. <col class="field-body" />
  128. <tbody valign="top">
  129. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  130. <li><strong>image</strong> – PIL Image or Numpy array</li>
  131. <li><strong>block</strong> – tuple (width, height) representing the size of each dimension of the block</li>
  132. <li><strong>pil</strong> – block type returned as PIL Image (default True)</li>
  133. </ul>
  134. </td>
  135. </tr>
  136. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list containing all 2D Numpy blocks (in RGB or not)</p>
  137. </td>
  138. </tr>
  139. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If <cite>image_width</cite> or <cite>image_height</cite> are not compatible to produce correct block sizes</p>
  140. </td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <p>Example:</p>
  145. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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>
  146. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  147. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  148. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
  149. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
  150. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span> <span class="o">=</span> <span class="n">divide_in_blocks</span><span class="p">(</span><span class="n">image_values</span><span class="p">,</span> <span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">20</span><span class="p">))</span>
  151. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">blocks</span><span class="p">)</span>
  152. <span class="go">1600</span>
  153. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">width</span>
  154. <span class="go">20</span>
  155. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">height</span>
  156. <span class="go">20</span>
  157. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_l</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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  158. <span class="gp">&gt;&gt;&gt; </span><span class="n">L</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_l</span><span class="p">)</span>
  159. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks_L</span> <span class="o">=</span> <span class="n">divide_in_blocks</span><span class="p">(</span><span class="n">L</span><span class="p">,</span> <span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
  160. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">blocks_L</span><span class="p">)</span>
  161. <span class="go">4</span>
  162. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks_L</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">width</span>
  163. <span class="go">100</span>
  164. </pre></div>
  165. </div>
  166. </dd></dl>
  167. <dl class="function">
  168. <dt id="ipfml.processing.fusion_images">
  169. <code class="descclassname">ipfml.processing.</code><code class="descname">fusion_images</code><span class="sig-paren">(</span><em>images</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#fusion_images"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.fusion_images" title="Permalink to this definition">¶</a></dt>
  170. <dd><p>Fusion array of images into single image</p>
  171. <table class="docutils field-list" frame="void" rules="none">
  172. <col class="field-name" />
  173. <col class="field-body" />
  174. <tbody valign="top">
  175. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  176. <li><strong>images</strong> – array of images (PIL Image or Numpy array)</li>
  177. <li><strong>pil</strong> – block type returned as PIL Image (default True)</li>
  178. </ul>
  179. </td>
  180. </tr>
  181. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">merged image from array of images</p>
  182. </td>
  183. </tr>
  184. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
  185. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if <cite>images</cite> is not an array or is empty</li>
  186. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">NumpyShapeComparisonException</span></code> – if <cite>images</cite> array contains images with different shapes</li>
  187. </ul>
  188. </td>
  189. </tr>
  190. </tbody>
  191. </table>
  192. <p>Example:</p>
  193. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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>
  194. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  195. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values_1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
  196. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values_2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
  197. <span class="gp">&gt;&gt;&gt; </span><span class="n">merged_image</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">fusion_images</span><span class="p">([</span><span class="n">image_values_1</span><span class="p">,</span> <span class="n">image_values_2</span><span class="p">],</span> <span class="n">pil</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  198. <span class="gp">&gt;&gt;&gt; </span><span class="n">merged_image</span><span class="o">.</span><span class="n">shape</span>
  199. <span class="go">(800, 800, 3)</span>
  200. </pre></div>
  201. </div>
  202. </dd></dl>
  203. <dl class="function">
  204. <dt id="ipfml.processing.get_LAB_L_SVD">
  205. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#get_LAB_L_SVD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD" title="Permalink to this definition">¶</a></dt>
  206. <dd><p>Returns Singular values from LAB L Image information</p>
  207. <table class="docutils field-list" frame="void" rules="none">
  208. <col class="field-name" />
  209. <col class="field-body" />
  210. <tbody valign="top">
  211. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  212. </tr>
  213. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U, s, V information obtained from SVD compression using Lab</td>
  214. </tr>
  215. </tbody>
  216. </table>
  217. <p>Example:</p>
  218. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  219. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  220. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  221. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">V</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  222. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
  223. <span class="go">(200, 200)</span>
  224. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
  225. <span class="go">200</span>
  226. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
  227. <span class="go">(200, 200)</span>
  228. </pre></div>
  229. </div>
  230. </dd></dl>
  231. <dl class="function">
  232. <dt id="ipfml.processing.get_LAB_L_SVD_U">
  233. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_U</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#get_LAB_L_SVD_U"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_U" title="Permalink to this definition">¶</a></dt>
  234. <dd><p>Returns U SVD from L of LAB Image information</p>
  235. <table class="docutils field-list" frame="void" rules="none">
  236. <col class="field-name" />
  237. <col class="field-body" />
  238. <tbody valign="top">
  239. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  240. </tr>
  241. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U matrix of SVD compression</td>
  242. </tr>
  243. </tbody>
  244. </table>
  245. <p>Example:</p>
  246. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  247. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  248. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  249. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_U</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  250. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
  251. <span class="go">(200, 200)</span>
  252. </pre></div>
  253. </div>
  254. </dd></dl>
  255. <dl class="function">
  256. <dt id="ipfml.processing.get_LAB_L_SVD_V">
  257. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_V</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#get_LAB_L_SVD_V"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_V" title="Permalink to this definition">¶</a></dt>
  258. <dd><p>Returns V SVD from L of LAB Image information</p>
  259. <table class="docutils field-list" frame="void" rules="none">
  260. <col class="field-name" />
  261. <col class="field-body" />
  262. <tbody valign="top">
  263. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  264. </tr>
  265. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">V matrix of SVD compression</td>
  266. </tr>
  267. </tbody>
  268. </table>
  269. <p>Example:</p>
  270. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  271. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  272. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  273. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_V</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  274. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
  275. <span class="go">(200, 200)</span>
  276. </pre></div>
  277. </div>
  278. </dd></dl>
  279. <dl class="function">
  280. <dt id="ipfml.processing.get_LAB_L_SVD_s">
  281. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_s</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#get_LAB_L_SVD_s"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_s" title="Permalink to this definition">¶</a></dt>
  282. <dd><p>Returns s (Singular values) SVD from L of LAB Image information</p>
  283. <table class="docutils field-list" frame="void" rules="none">
  284. <col class="field-name" />
  285. <col class="field-body" />
  286. <tbody valign="top">
  287. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  288. </tr>
  289. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">vector of singular values</td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <p>Example:</p>
  294. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  295. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  296. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  297. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_s</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  298. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
  299. <span class="go">200</span>
  300. </pre></div>
  301. </div>
  302. </dd></dl>
  303. <dl class="function">
  304. <dt id="ipfml.processing.get_mscn_coefficients">
  305. <code class="descclassname">ipfml.processing.</code><code class="descname">get_mscn_coefficients</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#get_mscn_coefficients"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.get_mscn_coefficients" title="Permalink to this definition">¶</a></dt>
  306. <dd><p>Compute the Mean Substracted Constrast Normalized coefficients of an image</p>
  307. <table class="docutils field-list" frame="void" rules="none">
  308. <col class="field-name" />
  309. <col class="field-body" />
  310. <tbody valign="top">
  311. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>image</strong> – PIL Image, Numpy array or path of image</p>
  312. </td>
  313. </tr>
  314. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">MSCN coefficients</p>
  315. </td>
  316. </tr>
  317. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
  318. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code> – If <cite>image</cite> is set as str path and image was not found</li>
  319. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If <cite>image</cite> numpy shape are not correct</li>
  320. </ul>
  321. </td>
  322. </tr>
  323. </tbody>
  324. </table>
  325. <p>Example:</p>
  326. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  327. <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>
  328. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  329. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values</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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  330. <span class="gp">&gt;&gt;&gt; </span><span class="n">mscn_coefficients</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_mscn_coefficients</span><span class="p">(</span><span class="n">image_values</span><span class="p">)</span>
  331. <span class="gp">&gt;&gt;&gt; </span><span class="n">mscn_coefficients</span><span class="o">.</span><span class="n">shape</span>
  332. <span class="go">(200, 200)</span>
  333. </pre></div>
  334. </div>
  335. </dd></dl>
  336. <dl class="function">
  337. <dt id="ipfml.processing.rgb_to_LAB_L_bits">
  338. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_LAB_L_bits</code><span class="sig-paren">(</span><em>image</em>, <em>interval</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#rgb_to_LAB_L_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.rgb_to_LAB_L_bits" title="Permalink to this definition">¶</a></dt>
  339. <dd><p>Returns only bits from LAB L canal specified into the interval</p>
  340. <table class="docutils field-list" frame="void" rules="none">
  341. <col class="field-name" />
  342. <col class="field-body" />
  343. <tbody valign="top">
  344. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  345. <li><strong>image</strong> – image to convert using this interval of bits value to keep</li>
  346. <li><strong>interval</strong> – (begin, end) of bits values</li>
  347. </ul>
  348. </td>
  349. </tr>
  350. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with reduced values</p>
  351. </td>
  352. </tr>
  353. </tbody>
  354. </table>
  355. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  356. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  357. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  358. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_LAB_L_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">6</span><span class="p">))</span>
  359. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span><span class="o">.</span><span class="n">shape</span>
  360. <span class="go">(200, 200)</span>
  361. </pre></div>
  362. </div>
  363. </dd></dl>
  364. <dl class="function">
  365. <dt id="ipfml.processing.rgb_to_LAB_L_low_bits">
  366. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_LAB_L_low_bits</code><span class="sig-paren">(</span><em>image</em>, <em>nb_bits=4</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#rgb_to_LAB_L_low_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.rgb_to_LAB_L_low_bits" title="Permalink to this definition">¶</a></dt>
  367. <dd><p>Convert RGB Image into Lab L channel image using only 4 low bits values</p>
  368. <table class="docutils field-list" frame="void" rules="none">
  369. <col class="field-name" />
  370. <col class="field-body" />
  371. <tbody valign="top">
  372. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  373. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
  374. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
  375. </ul>
  376. </td>
  377. </tr>
  378. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with low bits information kept</p>
  379. </td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <p>Example:</p>
  384. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  385. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  386. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  387. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_Lab_l_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_LAB_L_low_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
  388. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_Lab_l_img</span><span class="o">.</span><span class="n">shape</span>
  389. <span class="go">(200, 200)</span>
  390. </pre></div>
  391. </div>
  392. </dd></dl>
  393. <dl class="function">
  394. <dt id="ipfml.processing.rgb_to_grey_low_bits">
  395. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_grey_low_bits</code><span class="sig-paren">(</span><em>image</em>, <em>nb_bits=4</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#rgb_to_grey_low_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.rgb_to_grey_low_bits" title="Permalink to this definition">¶</a></dt>
  396. <dd><p>Convert RGB Image into grey image using only 4 low bits values</p>
  397. <table class="docutils field-list" frame="void" rules="none">
  398. <col class="field-name" />
  399. <col class="field-body" />
  400. <tbody valign="top">
  401. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  402. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
  403. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
  404. </ul>
  405. </td>
  406. </tr>
  407. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with low bits information kept</p>
  408. </td>
  409. </tr>
  410. </tbody>
  411. </table>
  412. <p>Example:</p>
  413. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  414. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  415. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  416. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_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">5</span><span class="p">)</span>
  417. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_img</span><span class="o">.</span><span class="n">shape</span>
  418. <span class="go">(200, 200)</span>
  419. </pre></div>
  420. </div>
  421. </dd></dl>
  422. <dl class="function">
  423. <dt id="ipfml.processing.rgb_to_mscn">
  424. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_mscn</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#rgb_to_mscn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.rgb_to_mscn" title="Permalink to this definition">¶</a></dt>
  425. <dd><p>Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</p>
  426. <table class="docutils field-list" frame="void" rules="none">
  427. <col class="field-name" />
  428. <col class="field-body" />
  429. <tbody valign="top">
  430. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</td>
  431. </tr>
  432. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">2D Numpy array with MSCN information</td>
  433. </tr>
  434. </tbody>
  435. </table>
  436. <p>Example:</p>
  437. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  438. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  439. <span class="gp">&gt;&gt;&gt; </span><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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  440. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_mscn</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  441. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span><span class="o">.</span><span class="n">shape</span>
  442. <span class="go">(200, 200)</span>
  443. </pre></div>
  444. </div>
  445. </dd></dl>
  446. <dl class="function">
  447. <dt id="ipfml.processing.rotate_image">
  448. <code class="descclassname">ipfml.processing.</code><code class="descname">rotate_image</code><span class="sig-paren">(</span><em>image</em>, <em>angle=90</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing.html#rotate_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.rotate_image" title="Permalink to this definition">¶</a></dt>
  449. <dd><p>Rotate image using specific angle</p>
  450. <table class="docutils field-list" frame="void" rules="none">
  451. <col class="field-name" />
  452. <col class="field-body" />
  453. <tbody valign="top">
  454. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  455. <li><strong>image</strong> – PIL Image or Numpy array</li>
  456. <li><strong>angle</strong> – Angle value of the rotation</li>
  457. <li><strong>pil</strong> – block type returned as PIL Image (default True)</li>
  458. </ul>
  459. </td>
  460. </tr>
  461. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Image with rotation applied</p>
  462. </td>
  463. </tr>
  464. </tbody>
  465. </table>
  466. <p>Example:</p>
  467. <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">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  468. <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>
  469. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  470. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values</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="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  471. <span class="gp">&gt;&gt;&gt; </span><span class="n">rotated_image</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rotate_image</span><span class="p">(</span><span class="n">image_values</span><span class="p">,</span> <span class="mi">90</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  472. <span class="gp">&gt;&gt;&gt; </span><span class="n">rotated_image</span><span class="o">.</span><span class="n">shape</span>
  473. <span class="go">(200, 200, 3)</span>
  474. </pre></div>
  475. </div>
  476. </dd></dl>
  477. </div>
  478. </div>
  479. </div>
  480. <footer>
  481. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  482. <a href="ipfml.utils.html" class="btn btn-neutral float-right" title="ipfml.utils" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  483. <a href="ipfml.metrics.html" class="btn btn-neutral" title="ipfml.metrics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  484. </div>
  485. <hr/>
  486. <div role="contentinfo">
  487. <p>
  488. &copy; Copyright 2019, Jérôme BUISINE
  489. </p>
  490. </div>
  491. 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>.
  492. </footer>
  493. </div>
  494. </div>
  495. </section>
  496. </div>
  497. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  498. <script type="text/javascript" src="../_static/jquery.js"></script>
  499. <script type="text/javascript" src="../_static/underscore.js"></script>
  500. <script type="text/javascript" src="../_static/doctools.js"></script>
  501. <script type="text/javascript" src="../_static/language_data.js"></script>
  502. <script type="text/javascript" src="../_static/js/theme.js"></script>
  503. <script type="text/javascript">
  504. jQuery(function () {
  505. SphinxRtdTheme.Navigation.enable(true);
  506. });
  507. </script>
  508. </body>
  509. </html>