ipfml.processing.transform.html 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  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.transform &mdash; ipfml v0.4.8 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="Examples" href="../examples.html" />
  13. <link rel="prev" title="ipfml.processing.segmentation" href="ipfml.processing.segmentation.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.8
  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"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
  44. <li class="toctree-l2 current"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a><ul class="current">
  45. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.compression.html">ipfml.processing.compression</a></li>
  46. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.movement.html">ipfml.processing.movement</a></li>
  47. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
  48. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
  49. <li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.processing.transform</a></li>
  50. </ul>
  51. </li>
  52. </ul>
  53. </li>
  54. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  56. </ul>
  57. </div>
  58. </div>
  59. </nav>
  60. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  61. <nav class="wy-nav-top" aria-label="top navigation">
  62. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  63. <a href="../index.html">ipfml</a>
  64. </nav>
  65. <div class="wy-nav-content">
  66. <div class="rst-content">
  67. <div role="navigation" aria-label="breadcrumbs navigation">
  68. <ul class="wy-breadcrumbs">
  69. <li><a href="../index.html">Docs</a> &raquo;</li>
  70. <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
  71. <li>ipfml.processing.transform</li>
  72. <li class="wy-breadcrumbs-aside">
  73. <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.processing.transform.rst" class="fa fa-github"> Edit on GitHub</a>
  74. </li>
  75. </ul>
  76. <hr/>
  77. </div>
  78. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  79. <div itemprop="articleBody">
  80. <div class="section" id="module-ipfml.processing.transform">
  81. <span id="ipfml-processing-transform"></span><h1>ipfml.processing.transform<a class="headerlink" href="#module-ipfml.processing.transform" title="Permalink to this headline">¶</a></h1>
  82. <p>Functions which can be used to extract information from image or reduce it</p>
  83. <p class="rubric">Functions</p>
  84. <table border="1" class="longtable docutils">
  85. <colgroup>
  86. <col width="10%" />
  87. <col width="90%" />
  88. </colgroup>
  89. <tbody valign="top">
  90. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB" title="ipfml.processing.transform.get_LAB"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB</span></code></a>(image)</td>
  91. <td>Transforms RGB Image into Lab</td>
  92. </tr>
  93. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_L" title="ipfml.processing.transform.get_LAB_L"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L</span></code></a>(image)</td>
  94. <td>Transforms RGB Image into Lab and returns L</td>
  95. </tr>
  96. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_L_SVD" title="ipfml.processing.transform.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>
  97. <td>Returns Singular values from LAB L Image information</td>
  98. </tr>
  99. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_L_SVD_U" title="ipfml.processing.transform.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>
  100. <td>Returns U SVD from L of LAB Image information</td>
  101. </tr>
  102. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_L_SVD_V" title="ipfml.processing.transform.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>
  103. <td>Returns V SVD from L of LAB Image information</td>
  104. </tr>
  105. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_L_SVD_s" title="ipfml.processing.transform.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>
  106. <td>Returns s (Singular values) SVD from L of LAB Image information</td>
  107. </tr>
  108. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_a" title="ipfml.processing.transform.get_LAB_a"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_a</span></code></a>(image)</td>
  109. <td>Transforms RGB Image into LAB and returns a</td>
  110. </tr>
  111. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_LAB_b" title="ipfml.processing.transform.get_LAB_b"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_b</span></code></a>(image)</td>
  112. <td>Transforms RGB Image into LAB and returns b</td>
  113. </tr>
  114. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_XYZ" title="ipfml.processing.transform.get_XYZ"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ</span></code></a>(image)</td>
  115. <td>Transforms RGB Image into XYZ</td>
  116. </tr>
  117. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_XYZ_X" title="ipfml.processing.transform.get_XYZ_X"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_X</span></code></a>(image)</td>
  118. <td>Transforms RGB Image into XYZ and returns X</td>
  119. </tr>
  120. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_XYZ_Y" title="ipfml.processing.transform.get_XYZ_Y"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_Y</span></code></a>(image)</td>
  121. <td>Transforms RGB Image into XYZ and returns Y</td>
  122. </tr>
  123. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_XYZ_Z" title="ipfml.processing.transform.get_XYZ_Z"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_Z</span></code></a>(image)</td>
  124. <td>Transforms RGB Image into XYZ and returns Z</td>
  125. </tr>
  126. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_bits_img" title="ipfml.processing.transform.get_bits_img"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_bits_img</span></code></a>(image,&nbsp;interval)</td>
  127. <td>Returns only bits specified into the interval</td>
  128. </tr>
  129. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.get_low_bits_img" title="ipfml.processing.transform.get_low_bits_img"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_low_bits_img</span></code></a>(image[,&nbsp;nb_bits])</td>
  130. <td>Returns Image or Numpy array with data information reduced using only low bits</td>
  131. </tr>
  132. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.get_mscn_coefficients" title="ipfml.processing.transform.get_mscn_coefficients"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_mscn_coefficients</span></code></a>(image)</td>
  133. <td>Compute the Mean Substracted Constrast Normalized coefficients of an image</td>
  134. </tr>
  135. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.gray_to_mscn" title="ipfml.processing.transform.gray_to_mscn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gray_to_mscn</span></code></a>(image)</td>
  136. <td>Convert Grayscale Image into Mean Subtracted Contrast Normalized (MSCN)</td>
  137. </tr>
  138. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.rgb_to_LAB_L_bits" title="ipfml.processing.transform.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>
  139. <td>Returns only bits from LAB L canal specified into the interval</td>
  140. </tr>
  141. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.rgb_to_LAB_L_low_bits" title="ipfml.processing.transform.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>
  142. <td>Convert RGB Image into Lab L channel image using only 4 low bits values</td>
  143. </tr>
  144. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.transform.rgb_to_grey_low_bits" title="ipfml.processing.transform.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>
  145. <td>Convert RGB Image into grey image using only 4 low bits values</td>
  146. </tr>
  147. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.transform.rgb_to_mscn" title="ipfml.processing.transform.rgb_to_mscn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rgb_to_mscn</span></code></a>(image)</td>
  148. <td>Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <dl class="function">
  153. <dt id="ipfml.processing.transform.get_LAB">
  154. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_LAB</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_LAB"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB" title="Permalink to this definition">¶</a></dt>
  155. <dd><p>Transforms RGB Image into Lab</p>
  156. <table class="docutils field-list" frame="void" rules="none">
  157. <col class="field-name" />
  158. <col class="field-body" />
  159. <tbody valign="top">
  160. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  161. </tr>
  162. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Lab information</td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <p>Usage:</p>
  167. <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>
  168. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  169. <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>
  170. <span class="gp">&gt;&gt;&gt; </span><span class="n">Lab</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_LAB</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  171. <span class="gp">&gt;&gt;&gt; </span><span class="n">Lab</span><span class="o">.</span><span class="n">shape</span>
  172. <span class="go">(200, 200, 3)</span>
  173. </pre></div>
  174. </div>
  175. </dd></dl>
  176. <dl class="function">
  177. <dt id="ipfml.processing.transform.get_LAB_L">
  178. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_LAB_L</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_LAB_L"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_L" title="Permalink to this definition">¶</a></dt>
  179. <dd><p>Transforms RGB Image into Lab and returns L</p>
  180. <table class="docutils field-list" frame="void" rules="none">
  181. <col class="field-name" />
  182. <col class="field-body" />
  183. <tbody valign="top">
  184. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  185. </tr>
  186. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The L chanel from Lab information</td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <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>
  191. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  192. <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>
  193. <span class="gp">&gt;&gt;&gt; </span><span class="n">L</span> <span class="o">=</span> <span class="n">transform</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>
  194. <span class="gp">&gt;&gt;&gt; </span><span class="n">L</span><span class="o">.</span><span class="n">shape</span>
  195. <span class="go">(200, 200)</span>
  196. </pre></div>
  197. </div>
  198. </dd></dl>
  199. <dl class="function">
  200. <dt id="ipfml.processing.transform.get_LAB_L_SVD">
  201. <code class="descclassname">ipfml.processing.transform.</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/transform.html#get_LAB_L_SVD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_L_SVD" title="Permalink to this definition">¶</a></dt>
  202. <dd><p>Returns Singular values from LAB L Image information</p>
  203. <table class="docutils field-list" frame="void" rules="none">
  204. <col class="field-name" />
  205. <col class="field-body" />
  206. <tbody valign="top">
  207. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  208. </tr>
  209. <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>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <p>Example:</p>
  214. <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>
  215. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  216. <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>
  217. <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">transform</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>
  218. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
  219. <span class="go">(200, 200)</span>
  220. <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>
  221. <span class="go">200</span>
  222. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
  223. <span class="go">(200, 200)</span>
  224. </pre></div>
  225. </div>
  226. </dd></dl>
  227. <dl class="function">
  228. <dt id="ipfml.processing.transform.get_LAB_L_SVD_U">
  229. <code class="descclassname">ipfml.processing.transform.</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/transform.html#get_LAB_L_SVD_U"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_L_SVD_U" title="Permalink to this definition">¶</a></dt>
  230. <dd><p>Returns U SVD from L of LAB Image information</p>
  231. <table class="docutils field-list" frame="void" rules="none">
  232. <col class="field-name" />
  233. <col class="field-body" />
  234. <tbody valign="top">
  235. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  236. </tr>
  237. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U matrix of SVD compression</td>
  238. </tr>
  239. </tbody>
  240. </table>
  241. <p>Example:</p>
  242. <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>
  243. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  244. <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>
  245. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span> <span class="o">=</span> <span class="n">transform</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>
  246. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
  247. <span class="go">(200, 200)</span>
  248. </pre></div>
  249. </div>
  250. </dd></dl>
  251. <dl class="function">
  252. <dt id="ipfml.processing.transform.get_LAB_L_SVD_V">
  253. <code class="descclassname">ipfml.processing.transform.</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/transform.html#get_LAB_L_SVD_V"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_L_SVD_V" title="Permalink to this definition">¶</a></dt>
  254. <dd><p>Returns V SVD from L of LAB Image information</p>
  255. <table class="docutils field-list" frame="void" rules="none">
  256. <col class="field-name" />
  257. <col class="field-body" />
  258. <tbody valign="top">
  259. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  260. </tr>
  261. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">V matrix of SVD compression</td>
  262. </tr>
  263. </tbody>
  264. </table>
  265. <p>Example:</p>
  266. <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>
  267. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  268. <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>
  269. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span> <span class="o">=</span> <span class="n">transform</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>
  270. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
  271. <span class="go">(200, 200)</span>
  272. </pre></div>
  273. </div>
  274. </dd></dl>
  275. <dl class="function">
  276. <dt id="ipfml.processing.transform.get_LAB_L_SVD_s">
  277. <code class="descclassname">ipfml.processing.transform.</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/transform.html#get_LAB_L_SVD_s"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_L_SVD_s" title="Permalink to this definition">¶</a></dt>
  278. <dd><p>Returns s (Singular values) SVD from L of LAB Image information</p>
  279. <table class="docutils field-list" frame="void" rules="none">
  280. <col class="field-name" />
  281. <col class="field-body" />
  282. <tbody valign="top">
  283. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
  284. </tr>
  285. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">vector of singular values</td>
  286. </tr>
  287. </tbody>
  288. </table>
  289. <p>Example:</p>
  290. <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>
  291. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  292. <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>
  293. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">transform</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>
  294. <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>
  295. <span class="go">200</span>
  296. </pre></div>
  297. </div>
  298. </dd></dl>
  299. <dl class="function">
  300. <dt id="ipfml.processing.transform.get_LAB_a">
  301. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_LAB_a</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_LAB_a"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_a" title="Permalink to this definition">¶</a></dt>
  302. <dd><p>Transforms RGB Image into LAB and returns a</p>
  303. <table class="docutils field-list" frame="void" rules="none">
  304. <col class="field-name" />
  305. <col class="field-body" />
  306. <tbody valign="top">
  307. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  308. </tr>
  309. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The a chanel from Lab information</td>
  310. </tr>
  311. </tbody>
  312. </table>
  313. <p>Usage:</p>
  314. <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>
  315. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  316. <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>
  317. <span class="gp">&gt;&gt;&gt; </span><span class="n">a</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_LAB_a</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  318. <span class="gp">&gt;&gt;&gt; </span><span class="n">a</span><span class="o">.</span><span class="n">shape</span>
  319. <span class="go">(200, 200)</span>
  320. </pre></div>
  321. </div>
  322. </dd></dl>
  323. <dl class="function">
  324. <dt id="ipfml.processing.transform.get_LAB_b">
  325. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_LAB_b</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_LAB_b"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_LAB_b" title="Permalink to this definition">¶</a></dt>
  326. <dd><p>Transforms RGB Image into LAB and returns b</p>
  327. <table class="docutils field-list" frame="void" rules="none">
  328. <col class="field-name" />
  329. <col class="field-body" />
  330. <tbody valign="top">
  331. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  332. </tr>
  333. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The b chanel from Lab information</td>
  334. </tr>
  335. </tbody>
  336. </table>
  337. <p>Usage :</p>
  338. <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>
  339. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  340. <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>
  341. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_LAB_b</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  342. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="o">.</span><span class="n">shape</span>
  343. <span class="go">(200, 200)</span>
  344. </pre></div>
  345. </div>
  346. </dd></dl>
  347. <dl class="function">
  348. <dt id="ipfml.processing.transform.get_XYZ">
  349. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_XYZ</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_XYZ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_XYZ" title="Permalink to this definition">¶</a></dt>
  350. <dd><p>Transforms RGB Image into XYZ</p>
  351. <table class="docutils field-list" frame="void" rules="none">
  352. <col class="field-name" />
  353. <col class="field-body" />
  354. <tbody valign="top">
  355. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  356. </tr>
  357. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">XYZ information obtained from transformation</td>
  358. </tr>
  359. </tbody>
  360. </table>
  361. <p>Usage:</p>
  362. <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>
  363. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  364. <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>
  365. <span class="gp">&gt;&gt;&gt; </span><span class="n">transform</span><span class="o">.</span><span class="n">get_XYZ</span><span class="p">(</span><span class="n">img</span><span class="p">)</span><span class="o">.</span><span class="n">shape</span>
  366. <span class="go">(200, 200, 3)</span>
  367. </pre></div>
  368. </div>
  369. </dd></dl>
  370. <dl class="function">
  371. <dt id="ipfml.processing.transform.get_XYZ_X">
  372. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_XYZ_X</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_XYZ_X"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_XYZ_X" title="Permalink to this definition">¶</a></dt>
  373. <dd><p>Transforms RGB Image into XYZ and returns X</p>
  374. <table class="docutils field-list" frame="void" rules="none">
  375. <col class="field-name" />
  376. <col class="field-body" />
  377. <tbody valign="top">
  378. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  379. </tr>
  380. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The X chanel from XYZ information</td>
  381. </tr>
  382. </tbody>
  383. </table>
  384. <p>Usage:</p>
  385. <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>
  386. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  387. <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>
  388. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_XYZ_X</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  389. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">shape</span>
  390. <span class="go">(200, 200)</span>
  391. </pre></div>
  392. </div>
  393. </dd></dl>
  394. <dl class="function">
  395. <dt id="ipfml.processing.transform.get_XYZ_Y">
  396. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_XYZ_Y</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_XYZ_Y"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_XYZ_Y" title="Permalink to this definition">¶</a></dt>
  397. <dd><p>Transforms RGB Image into XYZ and returns Y</p>
  398. <table class="docutils field-list" frame="void" rules="none">
  399. <col class="field-name" />
  400. <col class="field-body" />
  401. <tbody valign="top">
  402. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  403. </tr>
  404. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Y chanel from XYZ information</td>
  405. </tr>
  406. </tbody>
  407. </table>
  408. <p>Usage:</p>
  409. <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>
  410. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  411. <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>
  412. <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_XYZ_Y</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  413. <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span><span class="o">.</span><span class="n">shape</span>
  414. <span class="go">(200, 200)</span>
  415. </pre></div>
  416. </div>
  417. </dd></dl>
  418. <dl class="function">
  419. <dt id="ipfml.processing.transform.get_XYZ_Z">
  420. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_XYZ_Z</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#get_XYZ_Z"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_XYZ_Z" title="Permalink to this definition">¶</a></dt>
  421. <dd><p>Transforms RGB Image into XYZ and returns Z</p>
  422. <table class="docutils field-list" frame="void" rules="none">
  423. <col class="field-name" />
  424. <col class="field-body" />
  425. <tbody valign="top">
  426. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
  427. </tr>
  428. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Z chanel from XYZ information</td>
  429. </tr>
  430. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If <cite>nb_bits</cite> has unexpected value. <cite>nb_bits</cite> needs to be in interval [1, 8].</td>
  431. </tr>
  432. </tbody>
  433. </table>
  434. <p>Usage:</p>
  435. <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>
  436. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  437. <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>
  438. <span class="gp">&gt;&gt;&gt; </span><span class="n">z</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_XYZ_Z</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  439. <span class="gp">&gt;&gt;&gt; </span><span class="n">z</span><span class="o">.</span><span class="n">shape</span>
  440. <span class="go">(200, 200)</span>
  441. </pre></div>
  442. </div>
  443. </dd></dl>
  444. <dl class="function">
  445. <dt id="ipfml.processing.transform.get_bits_img">
  446. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_bits_img</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/transform.html#get_bits_img"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_bits_img" title="Permalink to this definition">¶</a></dt>
  447. <dd><p>Returns only bits specified into the interval</p>
  448. <table class="docutils field-list" frame="void" rules="none">
  449. <col class="field-name" />
  450. <col class="field-body" />
  451. <tbody valign="top">
  452. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  453. <li><strong>image</strong> – image to convert using this interval of bits value to keep</li>
  454. <li><strong>interval</strong> – (begin, end) of bits values</li>
  455. </ul>
  456. </td>
  457. </tr>
  458. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Numpy array with reduced values</p>
  459. </td>
  460. </tr>
  461. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
  462. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If min value from interval is not &gt;= 1.</li>
  463. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If max value from interval is not &lt;= 8.</li>
  464. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If min value from interval &gt;= max value.</li>
  465. </ul>
  466. </td>
  467. </tr>
  468. </tbody>
  469. </table>
  470. <p>Usage:</p>
  471. <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>
  472. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  473. <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>
  474. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_img</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_bits_img</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">5</span><span class="p">))</span>
  475. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_img</span><span class="o">.</span><span class="n">shape</span>
  476. <span class="go">(200, 200, 3)</span>
  477. </pre></div>
  478. </div>
  479. </dd></dl>
  480. <dl class="function">
  481. <dt id="ipfml.processing.transform.get_low_bits_img">
  482. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">get_low_bits_img</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/transform.html#get_low_bits_img"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_low_bits_img" title="Permalink to this definition">¶</a></dt>
  483. <dd><p>Returns Image or Numpy array with data information reduced using only low bits</p>
  484. <table class="docutils field-list" frame="void" rules="none">
  485. <col class="field-name" />
  486. <col class="field-body" />
  487. <tbody valign="top">
  488. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  489. <li><strong>image</strong> – image to convert</li>
  490. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep</li>
  491. </ul>
  492. </td>
  493. </tr>
  494. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Numpy array with reduced values</p>
  495. </td>
  496. </tr>
  497. </tbody>
  498. </table>
  499. <p>Usage:</p>
  500. <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>
  501. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  502. <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>
  503. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_img</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">get_low_bits_img</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
  504. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_img</span><span class="o">.</span><span class="n">shape</span>
  505. <span class="go">(200, 200, 3)</span>
  506. </pre></div>
  507. </div>
  508. </dd></dl>
  509. <dl class="function">
  510. <dt id="ipfml.processing.transform.get_mscn_coefficients">
  511. <code class="descclassname">ipfml.processing.transform.</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/transform.html#get_mscn_coefficients"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.get_mscn_coefficients" title="Permalink to this definition">¶</a></dt>
  512. <dd><p>Compute the Mean Substracted Constrast Normalized coefficients of an image</p>
  513. <table class="docutils field-list" frame="void" rules="none">
  514. <col class="field-name" />
  515. <col class="field-body" />
  516. <tbody valign="top">
  517. <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>
  518. </td>
  519. </tr>
  520. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">MSCN coefficients</p>
  521. </td>
  522. </tr>
  523. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
  524. <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>
  525. <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>
  526. </ul>
  527. </td>
  528. </tr>
  529. </tbody>
  530. </table>
  531. <p>Example:</p>
  532. <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>
  533. <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>
  534. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  535. <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>
  536. <span class="gp">&gt;&gt;&gt; </span><span class="n">mscn_coefficients</span> <span class="o">=</span> <span class="n">transform</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>
  537. <span class="gp">&gt;&gt;&gt; </span><span class="n">mscn_coefficients</span><span class="o">.</span><span class="n">shape</span>
  538. <span class="go">(200, 200)</span>
  539. </pre></div>
  540. </div>
  541. </dd></dl>
  542. <dl class="function">
  543. <dt id="ipfml.processing.transform.gray_to_mscn">
  544. <code class="descclassname">ipfml.processing.transform.</code><code class="descname">gray_to_mscn</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/transform.html#gray_to_mscn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.gray_to_mscn" title="Permalink to this definition">¶</a></dt>
  545. <dd><p>Convert Grayscale Image into Mean Subtracted Contrast Normalized (MSCN)</p>
  546. <table class="docutils field-list" frame="void" rules="none">
  547. <col class="field-name" />
  548. <col class="field-body" />
  549. <tbody valign="top">
  550. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – grayscale image</td>
  551. </tr>
  552. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">MSCN matrix obtained from transformation</td>
  553. </tr>
  554. </tbody>
  555. </table>
  556. <p>Usage:</p>
  557. <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>
  558. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  559. <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>
  560. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">transform</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>
  561. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">transform</span><span class="o">.</span><span class="n">gray_to_mscn</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  562. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span><span class="o">.</span><span class="n">shape</span>
  563. <span class="go">(200, 200)</span>
  564. </pre></div>
  565. </div>
  566. </dd></dl>
  567. <dl class="function">
  568. <dt id="ipfml.processing.transform.rgb_to_LAB_L_bits">
  569. <code class="descclassname">ipfml.processing.transform.</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/transform.html#rgb_to_LAB_L_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.rgb_to_LAB_L_bits" title="Permalink to this definition">¶</a></dt>
  570. <dd><p>Returns only bits from LAB L canal specified into the interval</p>
  571. <table class="docutils field-list" frame="void" rules="none">
  572. <col class="field-name" />
  573. <col class="field-body" />
  574. <tbody valign="top">
  575. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  576. <li><strong>image</strong> – image to convert using this interval of bits value to keep</li>
  577. <li><strong>interval</strong> – (begin, end) of bits values</li>
  578. </ul>
  579. </td>
  580. </tr>
  581. <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>
  582. </td>
  583. </tr>
  584. </tbody>
  585. </table>
  586. <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>
  587. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  588. <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>
  589. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span> <span class="o">=</span> <span class="n">transform</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>
  590. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span><span class="o">.</span><span class="n">shape</span>
  591. <span class="go">(200, 200)</span>
  592. </pre></div>
  593. </div>
  594. </dd></dl>
  595. <dl class="function">
  596. <dt id="ipfml.processing.transform.rgb_to_LAB_L_low_bits">
  597. <code class="descclassname">ipfml.processing.transform.</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/transform.html#rgb_to_LAB_L_low_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.rgb_to_LAB_L_low_bits" title="Permalink to this definition">¶</a></dt>
  598. <dd><p>Convert RGB Image into Lab L channel image using only 4 low bits values</p>
  599. <table class="docutils field-list" frame="void" rules="none">
  600. <col class="field-name" />
  601. <col class="field-body" />
  602. <tbody valign="top">
  603. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  604. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
  605. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
  606. </ul>
  607. </td>
  608. </tr>
  609. <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>
  610. </td>
  611. </tr>
  612. </tbody>
  613. </table>
  614. <p>Example:</p>
  615. <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>
  616. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  617. <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>
  618. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_Lab_l_img</span> <span class="o">=</span> <span class="n">transform</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>
  619. <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>
  620. <span class="go">(200, 200)</span>
  621. </pre></div>
  622. </div>
  623. </dd></dl>
  624. <dl class="function">
  625. <dt id="ipfml.processing.transform.rgb_to_grey_low_bits">
  626. <code class="descclassname">ipfml.processing.transform.</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/transform.html#rgb_to_grey_low_bits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.rgb_to_grey_low_bits" title="Permalink to this definition">¶</a></dt>
  627. <dd><p>Convert RGB Image into grey image using only 4 low bits values</p>
  628. <table class="docutils field-list" frame="void" rules="none">
  629. <col class="field-name" />
  630. <col class="field-body" />
  631. <tbody valign="top">
  632. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  633. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
  634. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
  635. </ul>
  636. </td>
  637. </tr>
  638. <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>
  639. </td>
  640. </tr>
  641. </tbody>
  642. </table>
  643. <p>Example:</p>
  644. <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>
  645. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  646. <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>
  647. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_img</span> <span class="o">=</span> <span class="n">transform</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>
  648. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_img</span><span class="o">.</span><span class="n">shape</span>
  649. <span class="go">(200, 200)</span>
  650. </pre></div>
  651. </div>
  652. </dd></dl>
  653. <dl class="function">
  654. <dt id="ipfml.processing.transform.rgb_to_mscn">
  655. <code class="descclassname">ipfml.processing.transform.</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/transform.html#rgb_to_mscn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.transform.rgb_to_mscn" title="Permalink to this definition">¶</a></dt>
  656. <dd><p>Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</p>
  657. <table class="docutils field-list" frame="void" rules="none">
  658. <col class="field-name" />
  659. <col class="field-body" />
  660. <tbody valign="top">
  661. <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>
  662. </tr>
  663. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">2D Numpy array with MSCN information</td>
  664. </tr>
  665. </tbody>
  666. </table>
  667. <p>Example:</p>
  668. <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>
  669. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
  670. <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>
  671. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">transform</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>
  672. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span><span class="o">.</span><span class="n">shape</span>
  673. <span class="go">(200, 200)</span>
  674. </pre></div>
  675. </div>
  676. </dd></dl>
  677. </div>
  678. </div>
  679. </div>
  680. <footer>
  681. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  682. <a href="../examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  683. <a href="ipfml.processing.segmentation.html" class="btn btn-neutral" title="ipfml.processing.segmentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  684. </div>
  685. <hr/>
  686. <div role="contentinfo">
  687. <p>
  688. &copy; Copyright 2019, Jérôme BUISINE
  689. </p>
  690. </div>
  691. 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>.
  692. </footer>
  693. </div>
  694. </div>
  695. </section>
  696. </div>
  697. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  698. <script type="text/javascript" src="../_static/jquery.js"></script>
  699. <script type="text/javascript" src="../_static/underscore.js"></script>
  700. <script type="text/javascript" src="../_static/doctools.js"></script>
  701. <script type="text/javascript" src="../_static/language_data.js"></script>
  702. <script type="text/javascript" src="../_static/js/theme.js"></script>
  703. <script type="text/javascript">
  704. jQuery(function () {
  705. SphinxRtdTheme.Navigation.enable(true);
  706. });
  707. </script>
  708. </body>
  709. </html>