metrics.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605
  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.metrics &mdash; IPFML v0.3.7 documentation</title>
  8. <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="../../genindex.html" />
  11. <link rel="search" title="Search" href="../../search.html" />
  12. <script src="../../_static/js/modernizr.min.js"></script>
  13. </head>
  14. <body class="wy-body-for-nav">
  15. <div class="wy-grid-for-nav">
  16. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  17. <div class="wy-side-scroll">
  18. <div class="wy-side-nav-search">
  19. <a href="../../index.html" class="icon icon-home"> IPFML
  20. </a>
  21. <div class="version">
  22. 0.3.7
  23. </div>
  24. <div role="search">
  25. <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
  26. <input type="text" name="q" placeholder="Search docs" />
  27. <input type="hidden" name="check_keywords" value="yes" />
  28. <input type="hidden" name="area" value="default" />
  29. </form>
  30. </div>
  31. </div>
  32. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  33. <p class="caption"><span class="caption-text">Contents:</span></p>
  34. <ul>
  35. <li class="toctree-l1"><a class="reference internal" href="../../description.html">Description</a></li>
  36. <li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation</a></li>
  37. <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
  38. <li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
  39. </ul>
  40. </div>
  41. </div>
  42. </nav>
  43. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  44. <nav class="wy-nav-top" aria-label="top navigation">
  45. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  46. <a href="../../index.html">IPFML</a>
  47. </nav>
  48. <div class="wy-nav-content">
  49. <div class="rst-content">
  50. <div role="navigation" aria-label="breadcrumbs navigation">
  51. <ul class="wy-breadcrumbs">
  52. <li><a href="../../index.html">Docs</a> &raquo;</li>
  53. <li><a href="../index.html">Module code</a> &raquo;</li>
  54. <li>ipfml.metrics</li>
  55. <li class="wy-breadcrumbs-aside">
  56. </li>
  57. </ul>
  58. <hr/>
  59. </div>
  60. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  61. <div itemprop="articleBody">
  62. <h1>Source code for ipfml.metrics</h1><div class="highlight"><pre>
  63. <span></span><span class="sd">&quot;&quot;&quot;</span>
  64. <span class="sd">Functions which can be used to extract information from image</span>
  65. <span class="sd">&quot;&quot;&quot;</span>
  66. <span class="kn">from</span> <span class="nn">numpy.linalg</span> <span class="k">import</span> <span class="n">svd</span>
  67. <span class="kn">from</span> <span class="nn">scipy</span> <span class="k">import</span> <span class="n">misc</span>
  68. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  69. <span class="kn">from</span> <span class="nn">sklearn</span> <span class="k">import</span> <span class="n">preprocessing</span>
  70. <span class="kn">from</span> <span class="nn">skimage</span> <span class="k">import</span> <span class="n">io</span><span class="p">,</span> <span class="n">color</span>
  71. <span class="kn">import</span> <span class="nn">cv2</span>
  72. <div class="viewcode-block" id="get_SVD"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD">[docs]</a><span class="k">def</span> <span class="nf">get_SVD</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  73. <span class="sd">&quot;&quot;&quot;Transforms Image using SVD compression</span>
  74. <span class="sd"> Args:</span>
  75. <span class="sd"> image: image to convert into SVD compression</span>
  76. <span class="sd"> Return:</span>
  77. <span class="sd"> U, s, V obtained from SVD compression</span>
  78. <span class="sd"> Usage:</span>
  79. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  80. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  81. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  82. <span class="sd"> &gt;&gt;&gt; U, s, V = metrics.get_SVD(img)</span>
  83. <span class="sd"> &gt;&gt;&gt; U.shape</span>
  84. <span class="sd"> (200, 200, 3)</span>
  85. <span class="sd"> &gt;&gt;&gt; len(s)</span>
  86. <span class="sd"> 200</span>
  87. <span class="sd"> &gt;&gt;&gt; V.shape</span>
  88. <span class="sd"> (200, 3, 3)</span>
  89. <span class="sd"> &quot;&quot;&quot;</span>
  90. <span class="k">return</span> <span class="n">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
  91. <div class="viewcode-block" id="get_SVD_s"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_s">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_s</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  92. <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;s&#39; part</span>
  93. <span class="sd"> Args:</span>
  94. <span class="sd"> image: image to convert</span>
  95. <span class="sd"> Returns:</span>
  96. <span class="sd"> vector of singular values obtained from SVD compression</span>
  97. <span class="sd"> Usage:</span>
  98. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  99. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  100. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  101. <span class="sd"> &gt;&gt;&gt; s = metrics.get_SVD_s(img)</span>
  102. <span class="sd"> &gt;&gt;&gt; len(s)</span>
  103. <span class="sd"> 200</span>
  104. <span class="sd"> &quot;&quot;&quot;</span>
  105. <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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  106. <span class="k">return</span> <span class="n">s</span></div>
  107. <div class="viewcode-block" id="get_SVD_U"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_U">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_U</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  108. <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;U&#39; part</span>
  109. <span class="sd"> Args:</span>
  110. <span class="sd"> image: image to convert</span>
  111. <span class="sd"> Returns:</span>
  112. <span class="sd"> U matrix from SVD compression</span>
  113. <span class="sd"> Usage:</span>
  114. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  115. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  116. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  117. <span class="sd"> &gt;&gt;&gt; U = metrics.get_SVD_U(img)</span>
  118. <span class="sd"> &gt;&gt;&gt; U.shape</span>
  119. <span class="sd"> (200, 200, 3)</span>
  120. <span class="sd"> &quot;&quot;&quot;</span>
  121. <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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  122. <span class="k">return</span> <span class="n">U</span></div>
  123. <div class="viewcode-block" id="get_SVD_V"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_V">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_V</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  124. <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;V&#39; part</span>
  125. <span class="sd"> Args:</span>
  126. <span class="sd"> image: image to convert</span>
  127. <span class="sd"> Returns:</span>
  128. <span class="sd"> V matrix obtained from SVD compression</span>
  129. <span class="sd"> Usage :</span>
  130. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  131. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  132. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  133. <span class="sd"> &gt;&gt;&gt; V = metrics.get_SVD_V(img)</span>
  134. <span class="sd"> &gt;&gt;&gt; V.shape</span>
  135. <span class="sd"> (200, 3, 3)</span>
  136. <span class="sd"> &quot;&quot;&quot;</span>
  137. <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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  138. <span class="k">return</span> <span class="n">V</span></div>
  139. <div class="viewcode-block" id="get_LAB"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB">[docs]</a><span class="k">def</span> <span class="nf">get_LAB</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  140. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into Lab</span>
  141. <span class="sd"> Args:</span>
  142. <span class="sd"> image: image to convert</span>
  143. <span class="sd"> Returns:</span>
  144. <span class="sd"> Lab information</span>
  145. <span class="sd"> Usage:</span>
  146. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  147. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  148. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  149. <span class="sd"> &gt;&gt;&gt; Lab = metrics.get_LAB(img)</span>
  150. <span class="sd"> &gt;&gt;&gt; Lab.shape</span>
  151. <span class="sd"> (200, 200, 3)</span>
  152. <span class="sd"> &quot;&quot;&quot;</span>
  153. <span class="k">return</span> <span class="n">color</span><span class="o">.</span><span class="n">rgb2lab</span><span class="p">(</span><span class="n">image</span><span class="p">)</span></div>
  154. <div class="viewcode-block" id="get_LAB_L"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_L">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  155. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into Lab and returns L</span>
  156. <span class="sd"> Args:</span>
  157. <span class="sd"> image: image to convert</span>
  158. <span class="sd"> Returns:</span>
  159. <span class="sd"> The L chanel from Lab information</span>
  160. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  161. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  162. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  163. <span class="sd"> &gt;&gt;&gt; L = metrics.get_LAB_L(img)</span>
  164. <span class="sd"> &gt;&gt;&gt; L.shape</span>
  165. <span class="sd"> (200, 200)</span>
  166. <span class="sd"> &quot;&quot;&quot;</span>
  167. <span class="n">lab</span> <span class="o">=</span> <span class="n">get_LAB</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  168. <span class="k">return</span> <span class="n">lab</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">0</span><span class="p">]</span></div>
  169. <div class="viewcode-block" id="get_LAB_a"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_a">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_a</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  170. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into LAB and returns a</span>
  171. <span class="sd"> Args:</span>
  172. <span class="sd"> image: image to convert</span>
  173. <span class="sd"> Returns:</span>
  174. <span class="sd"> The a chanel from Lab information</span>
  175. <span class="sd"> Usage:</span>
  176. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  177. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  178. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  179. <span class="sd"> &gt;&gt;&gt; a = metrics.get_LAB_a(img)</span>
  180. <span class="sd"> &gt;&gt;&gt; a.shape</span>
  181. <span class="sd"> (200, 200)</span>
  182. <span class="sd"> &quot;&quot;&quot;</span>
  183. <span class="n">lab</span> <span class="o">=</span> <span class="n">get_LAB</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  184. <span class="k">return</span> <span class="n">lab</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">1</span><span class="p">]</span></div>
  185. <div class="viewcode-block" id="get_LAB_b"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_b">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_b</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  186. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into LAB and returns b</span>
  187. <span class="sd"> Args:</span>
  188. <span class="sd"> image: image to convert</span>
  189. <span class="sd"> Returns:</span>
  190. <span class="sd"> The b chanel from Lab information</span>
  191. <span class="sd"> Usage :</span>
  192. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  193. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  194. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  195. <span class="sd"> &gt;&gt;&gt; b = metrics.get_LAB_b(img)</span>
  196. <span class="sd"> &gt;&gt;&gt; b.shape</span>
  197. <span class="sd"> (200, 200)</span>
  198. <span class="sd"> &quot;&quot;&quot;</span>
  199. <span class="n">lab</span> <span class="o">=</span> <span class="n">get_LAB</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  200. <span class="k">return</span> <span class="n">lab</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">2</span><span class="p">]</span></div>
  201. <div class="viewcode-block" id="get_XYZ"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ">[docs]</a><span class="k">def</span> <span class="nf">get_XYZ</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  202. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into XYZ</span>
  203. <span class="sd"> Args:</span>
  204. <span class="sd"> image: image to convert</span>
  205. <span class="sd"> Returns:</span>
  206. <span class="sd"> XYZ information obtained from transformation</span>
  207. <span class="sd"> Usage:</span>
  208. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  209. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  210. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  211. <span class="sd"> &gt;&gt;&gt; metrics.get_XYZ(img).shape</span>
  212. <span class="sd"> (200, 200, 3)</span>
  213. <span class="sd"> &quot;&quot;&quot;</span>
  214. <span class="k">return</span> <span class="n">color</span><span class="o">.</span><span class="n">rgb2xyz</span><span class="p">(</span><span class="n">image</span><span class="p">)</span></div>
  215. <div class="viewcode-block" id="get_XYZ_X"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_X">[docs]</a><span class="k">def</span> <span class="nf">get_XYZ_X</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  216. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into XYZ and returns X</span>
  217. <span class="sd"> Args:</span>
  218. <span class="sd"> image: image to convert</span>
  219. <span class="sd"> Returns:</span>
  220. <span class="sd"> The X chanel from XYZ information</span>
  221. <span class="sd"> Usage:</span>
  222. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  223. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  224. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  225. <span class="sd"> &gt;&gt;&gt; x = metrics.get_XYZ_X(img)</span>
  226. <span class="sd"> &gt;&gt;&gt; x.shape</span>
  227. <span class="sd"> (200, 200)</span>
  228. <span class="sd"> &quot;&quot;&quot;</span>
  229. <span class="n">xyz</span> <span class="o">=</span> <span class="n">color</span><span class="o">.</span><span class="n">rgb2xyz</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  230. <span class="k">return</span> <span class="n">xyz</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">0</span><span class="p">]</span></div>
  231. <div class="viewcode-block" id="get_XYZ_Y"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Y">[docs]</a><span class="k">def</span> <span class="nf">get_XYZ_Y</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  232. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into XYZ and returns Y</span>
  233. <span class="sd"> Args:</span>
  234. <span class="sd"> image: image to convert</span>
  235. <span class="sd"> Returns:</span>
  236. <span class="sd"> The Y chanel from XYZ information</span>
  237. <span class="sd"> Usage:</span>
  238. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  239. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  240. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  241. <span class="sd"> &gt;&gt;&gt; y = metrics.get_XYZ_Y(img)</span>
  242. <span class="sd"> &gt;&gt;&gt; y.shape</span>
  243. <span class="sd"> (200, 200)</span>
  244. <span class="sd"> &quot;&quot;&quot;</span>
  245. <span class="n">xyz</span> <span class="o">=</span> <span class="n">color</span><span class="o">.</span><span class="n">rgb2xyz</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  246. <span class="k">return</span> <span class="n">xyz</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">1</span><span class="p">]</span></div>
  247. <div class="viewcode-block" id="get_XYZ_Z"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Z">[docs]</a><span class="k">def</span> <span class="nf">get_XYZ_Z</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  248. <span class="sd">&quot;&quot;&quot;Transforms RGB Image into XYZ and returns Z</span>
  249. <span class="sd"> Args:</span>
  250. <span class="sd"> image: image to convert</span>
  251. <span class="sd"> Returns:</span>
  252. <span class="sd"> The Z chanel from XYZ information</span>
  253. <span class="sd"> Raises:</span>
  254. <span class="sd"> ValueError: If `nb_bits` has unexpected value. `nb_bits` needs to be in interval [1, 8].</span>
  255. <span class="sd"> Usage:</span>
  256. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  257. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  258. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  259. <span class="sd"> &gt;&gt;&gt; z = metrics.get_XYZ_Z(img)</span>
  260. <span class="sd"> &gt;&gt;&gt; z.shape</span>
  261. <span class="sd"> (200, 200)</span>
  262. <span class="sd"> &quot;&quot;&quot;</span>
  263. <span class="n">xyz</span> <span class="o">=</span> <span class="n">color</span><span class="o">.</span><span class="n">rgb2xyz</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  264. <span class="k">return</span> <span class="n">xyz</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">2</span><span class="p">]</span></div>
  265. <div class="viewcode-block" id="get_low_bits_img"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_low_bits_img">[docs]</a><span class="k">def</span> <span class="nf">get_low_bits_img</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">nb_bits</span><span class="o">=</span><span class="mi">4</span><span class="p">):</span>
  266. <span class="sd">&quot;&quot;&quot;Returns Image or Numpy array with data information reduced using only low bits</span>
  267. <span class="sd"> Args:</span>
  268. <span class="sd"> image: image to convert</span>
  269. <span class="sd"> nb_bits: optional parameter which indicates the number of bits to keep</span>
  270. <span class="sd"> Returns:</span>
  271. <span class="sd"> Numpy array with reduced values</span>
  272. <span class="sd"> Usage:</span>
  273. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  274. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  275. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  276. <span class="sd"> &gt;&gt;&gt; low_bits_img = metrics.get_low_bits_img(img, 5)</span>
  277. <span class="sd"> &gt;&gt;&gt; low_bits_img.shape</span>
  278. <span class="sd"> (200, 200, 3)</span>
  279. <span class="sd"> &quot;&quot;&quot;</span>
  280. <span class="k">if</span> <span class="n">nb_bits</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
  281. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
  282. <span class="s2">&quot;unexpected value of number of bits to keep. @nb_bits needs to be positive and greater than 0.&quot;</span>
  283. <span class="p">)</span>
  284. <span class="k">if</span> <span class="n">nb_bits</span> <span class="o">&gt;</span> <span class="mi">8</span><span class="p">:</span>
  285. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
  286. <span class="s2">&quot;Unexpected value of number of bits to keep. @nb_bits needs to be in interval [1, 8].&quot;</span>
  287. <span class="p">)</span>
  288. <span class="n">img_arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  289. <span class="n">bits_values</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">([</span><span class="nb">pow</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">i</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">nb_bits</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)])</span>
  290. <span class="k">return</span> <span class="n">img_arr</span> <span class="o">&amp;</span> <span class="n">bits_values</span></div>
  291. <div class="viewcode-block" id="get_bits_img"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.get_bits_img">[docs]</a><span class="k">def</span> <span class="nf">get_bits_img</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
  292. <span class="sd">&quot;&quot;&quot;Returns only bits specified into the interval</span>
  293. <span class="sd"> Args:</span>
  294. <span class="sd"> image: image to convert using this interval of bits value to keep</span>
  295. <span class="sd"> interval: (begin, end) of bits values</span>
  296. <span class="sd"> Returns:</span>
  297. <span class="sd"> Numpy array with reduced values</span>
  298. <span class="sd"> Raises:</span>
  299. <span class="sd"> ValueError: If min value from interval is not &gt;= 1.</span>
  300. <span class="sd"> ValueError: If max value from interval is not &lt;= 8.</span>
  301. <span class="sd"> ValueError: If min value from interval &gt;= max value.</span>
  302. <span class="sd"> Usage:</span>
  303. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  304. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  305. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  306. <span class="sd"> &gt;&gt;&gt; bits_img = metrics.get_bits_img(img, (2, 5))</span>
  307. <span class="sd"> &gt;&gt;&gt; bits_img.shape</span>
  308. <span class="sd"> (200, 200, 3)</span>
  309. <span class="sd"> &quot;&quot;&quot;</span>
  310. <span class="n">img_arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  311. <span class="n">begin</span><span class="p">,</span> <span class="n">end</span> <span class="o">=</span> <span class="n">interval</span>
  312. <span class="k">if</span> <span class="n">begin</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
  313. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
  314. <span class="s2">&quot;Unexpected value of interval. Interval min value needs to be &gt;= 1.&quot;</span>
  315. <span class="p">)</span>
  316. <span class="k">if</span> <span class="n">end</span> <span class="o">&gt;</span> <span class="mi">8</span><span class="p">:</span>
  317. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
  318. <span class="s2">&quot;Unexpected value of interval. Interval min value needs to be &lt;= 8.&quot;</span>
  319. <span class="p">)</span>
  320. <span class="k">if</span> <span class="n">begin</span> <span class="o">&gt;=</span> <span class="n">end</span><span class="p">:</span>
  321. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Unexpected interval values order.&quot;</span><span class="p">)</span>
  322. <span class="n">bits_values</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">([</span><span class="nb">pow</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">i</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">begin</span><span class="p">,</span> <span class="n">end</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)])</span>
  323. <span class="k">return</span> <span class="n">img_arr</span> <span class="o">&amp;</span> <span class="n">bits_values</span></div>
  324. <div class="viewcode-block" id="gray_to_mscn"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.gray_to_mscn">[docs]</a><span class="k">def</span> <span class="nf">gray_to_mscn</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  325. <span class="sd">&quot;&quot;&quot;Convert Grayscale Image into Mean Subtracted Contrast Normalized (MSCN)</span>
  326. <span class="sd"> Args:</span>
  327. <span class="sd"> image: grayscale image</span>
  328. <span class="sd"> Returns:</span>
  329. <span class="sd"> MSCN matrix obtained from transformation</span>
  330. <span class="sd"> Usage:</span>
  331. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  332. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  333. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  334. <span class="sd"> &gt;&gt;&gt; img = metrics.get_LAB_L(img)</span>
  335. <span class="sd"> &gt;&gt;&gt; img_mscn = metrics.gray_to_mscn(img)</span>
  336. <span class="sd"> &gt;&gt;&gt; img_mscn.shape</span>
  337. <span class="sd"> (200, 200)</span>
  338. <span class="sd"> &quot;&quot;&quot;</span>
  339. <span class="n">s</span> <span class="o">=</span> <span class="mi">7</span> <span class="o">/</span> <span class="mi">6</span>
  340. <span class="n">blurred</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">GaussianBlur</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="p">(</span><span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">),</span>
  341. <span class="n">s</span><span class="p">)</span> <span class="c1"># apply gaussian blur to the image</span>
  342. <span class="n">blurred_sq</span> <span class="o">=</span> <span class="n">blurred</span> <span class="o">*</span> <span class="n">blurred</span>
  343. <span class="n">sigma</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">GaussianBlur</span><span class="p">(</span><span class="n">image</span> <span class="o">*</span> <span class="n">image</span><span class="p">,</span> <span class="p">(</span><span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">),</span> <span class="n">s</span><span class="p">)</span>
  344. <span class="n">sigma</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">sigma</span> <span class="o">-</span> <span class="n">blurred_sq</span><span class="p">)</span><span class="o">**</span><span class="mf">0.5</span>
  345. <span class="n">sigma</span> <span class="o">=</span> <span class="n">sigma</span> <span class="o">+</span> <span class="mf">1.0</span> <span class="o">/</span> <span class="mi">255</span> <span class="c1"># avoid DivideByZero Exception</span>
  346. <span class="n">mscn</span> <span class="o">=</span> <span class="p">(</span><span class="n">image</span> <span class="o">-</span> <span class="n">blurred</span><span class="p">)</span> <span class="o">/</span> <span class="n">sigma</span> <span class="c1"># MSCN(i, j) image</span>
  347. <span class="k">return</span> <span class="n">mscn</span></div>
  348. </pre></div>
  349. </div>
  350. </div>
  351. <footer>
  352. <hr/>
  353. <div role="contentinfo">
  354. <p>
  355. &copy; Copyright 2019, Jérôme BUISINE
  356. </p>
  357. </div>
  358. 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>.
  359. </footer>
  360. </div>
  361. </div>
  362. </section>
  363. </div>
  364. <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
  365. <script type="text/javascript" src="../../_static/jquery.js"></script>
  366. <script type="text/javascript" src="../../_static/underscore.js"></script>
  367. <script type="text/javascript" src="../../_static/doctools.js"></script>
  368. <script type="text/javascript" src="../../_static/language_data.js"></script>
  369. <script type="text/javascript" src="../../_static/js/theme.js"></script>
  370. <script type="text/javascript">
  371. jQuery(function () {
  372. SphinxRtdTheme.Navigation.enable(true);
  373. });
  374. </script>
  375. </body>
  376. </html>