fr.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  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.iqa.fr &mdash; ipfml v0.4.2 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.4.2
  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.iqa.fr</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.iqa.fr</h1><div class="highlight"><pre>
  63. <span></span><span class="sd">&quot;&quot;&quot;</span>
  64. <span class="sd">Full-reference Image Quality Assessment (FR-IQA) methods</span>
  65. <span class="sd">&quot;&quot;&quot;</span>
  66. <span class="c1"># main imports</span>
  67. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  68. <span class="c1"># computations imports</span>
  69. <span class="kn">from</span> <span class="nn">skimage.measure</span> <span class="k">import</span> <span class="n">compare_ssim</span><span class="p">,</span> <span class="n">compare_psnr</span>
  70. <span class="c1"># ipfml imports</span>
  71. <span class="kn">from</span> <span class="nn">ipfml.exceptions</span> <span class="k">import</span> <span class="n">NumpyShapeComparisonException</span>
  72. <span class="k">def</span> <span class="nf">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">,</span> <span class="n">p_dtype</span><span class="o">=</span><span class="s1">&#39;float32&#39;</span><span class="p">):</span>
  73. <span class="sd">&quot;&quot;&quot;</span>
  74. <span class="sd"> Prepare image data</span>
  75. <span class="sd"> Raises:</span>
  76. <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
  77. <span class="sd"> &quot;&quot;&quot;</span>
  78. <span class="n">img_true</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">p_dtype</span><span class="p">)</span>
  79. <span class="n">img_test</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">img_test</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">p_dtype</span><span class="p">)</span>
  80. <span class="k">if</span> <span class="n">img_true</span><span class="o">.</span><span class="n">shape</span> <span class="o">!=</span> <span class="n">img_test</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span>
  81. <span class="k">raise</span> <span class="n">NumpyShapeComparisonException</span>
  82. <span class="k">return</span> <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span>
  83. <div class="viewcode-block" id="mse"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mse">[docs]</a><span class="k">def</span> <span class="nf">mse</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  84. <span class="sd">&quot;&quot;&quot;Returns Mean-Squared Error score between two Numpy arrays</span>
  85. <span class="sd"> Args:</span>
  86. <span class="sd"> img_true: Image, numpy array of any dimension</span>
  87. <span class="sd"> img_test: Image, numpy array of any dimension</span>
  88. <span class="sd"> Returns:</span>
  89. <span class="sd"> Computed MSE score</span>
  90. <span class="sd"> Raises:</span>
  91. <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
  92. <span class="sd"> Example:</span>
  93. <span class="sd"> &gt;&gt;&gt; from ipfml.iqa import fr</span>
  94. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  95. <span class="sd"> &gt;&gt;&gt; arr1 = np.arange(10)</span>
  96. <span class="sd"> &gt;&gt;&gt; arr2 = np.arange(5, 15)</span>
  97. <span class="sd"> &gt;&gt;&gt; mse_score = fr.mse(arr1, arr2)</span>
  98. <span class="sd"> &gt;&gt;&gt; mse_score</span>
  99. <span class="sd"> 25.0</span>
  100. <span class="sd"> &quot;&quot;&quot;</span>
  101. <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span> <span class="o">=</span> <span class="n">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">)</span>
  102. <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">square</span><span class="p">(</span><span class="n">img_true</span> <span class="o">-</span> <span class="n">img_test</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span></div>
  103. <div class="viewcode-block" id="rmse"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.rmse">[docs]</a><span class="k">def</span> <span class="nf">rmse</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  104. <span class="sd">&quot;&quot;&quot;Returns Root Mean-Squared Error score between two Numpy arrays</span>
  105. <span class="sd"> Args:</span>
  106. <span class="sd"> img_true: Image, numpy array of any dimension</span>
  107. <span class="sd"> img_test: Image, numpy array of any dimension</span>
  108. <span class="sd"> Returns:</span>
  109. <span class="sd"> Computed RMSE score</span>
  110. <span class="sd"> Raises:</span>
  111. <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
  112. <span class="sd"> Example:</span>
  113. <span class="sd"> &gt;&gt;&gt; from ipfml.iqa import fr</span>
  114. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  115. <span class="sd"> &gt;&gt;&gt; arr1 = np.arange(10)</span>
  116. <span class="sd"> &gt;&gt;&gt; arr2 = np.arange(5, 15)</span>
  117. <span class="sd"> &gt;&gt;&gt; rmse_score = fr.rmse(arr1, arr2)</span>
  118. <span class="sd"> &gt;&gt;&gt; rmse_score</span>
  119. <span class="sd"> 5.0</span>
  120. <span class="sd"> &quot;&quot;&quot;</span>
  121. <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">mse</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">))</span></div>
  122. <div class="viewcode-block" id="mae"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mae">[docs]</a><span class="k">def</span> <span class="nf">mae</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  123. <span class="sd">&quot;&quot;&quot;Returns Mean Absolute Error between two Numpy arrays</span>
  124. <span class="sd"> Args:</span>
  125. <span class="sd"> img_true: Image, numpy array of any dimension</span>
  126. <span class="sd"> img_test: Image, numpy array of any dimension</span>
  127. <span class="sd"> Returns:</span>
  128. <span class="sd"> Computed MAE score</span>
  129. <span class="sd"> Raises:</span>
  130. <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
  131. <span class="sd"> Example:</span>
  132. <span class="sd"> &gt;&gt;&gt; from ipfml.iqa import fr</span>
  133. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  134. <span class="sd"> &gt;&gt;&gt; arr1 = np.arange(10)</span>
  135. <span class="sd"> &gt;&gt;&gt; arr2 = np.arange(5, 15)</span>
  136. <span class="sd"> &gt;&gt;&gt; mae_score = fr.mae(arr1, arr2)</span>
  137. <span class="sd"> &gt;&gt;&gt; mae_score</span>
  138. <span class="sd"> 5.0</span>
  139. <span class="sd"> &quot;&quot;&quot;</span>
  140. <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span> <span class="o">=</span> <span class="n">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">)</span>
  141. <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">mean</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">absolute</span><span class="p">(</span><span class="n">img_true</span> <span class="o">-</span> <span class="n">img_test</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span></div>
  142. <div class="viewcode-block" id="psnr"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.psnr">[docs]</a><span class="k">def</span> <span class="nf">psnr</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  143. <span class="sd">&quot;&quot;&quot;Returns the computed Peak Signal to Noise Ratio (PSNR) between two images</span>
  144. <span class="sd"> Args:</span>
  145. <span class="sd"> img_true: Image, numpy array of any dimension</span>
  146. <span class="sd"> img_test: Image, numpy array of any dimension</span>
  147. <span class="sd"> Returns:</span>
  148. <span class="sd"> Computed PSNR score</span>
  149. <span class="sd"> Example:</span>
  150. <span class="sd"> &gt;&gt;&gt; from ipfml.iqa import fr</span>
  151. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  152. <span class="sd"> &gt;&gt;&gt; arr1 = np.arange(100).reshape(10, 10)</span>
  153. <span class="sd"> &gt;&gt;&gt; arr2 = np.arange(5, 105).reshape(10, 10)</span>
  154. <span class="sd"> &gt;&gt;&gt; psnr_score = fr.psnr(arr1, arr2)</span>
  155. <span class="sd"> &gt;&gt;&gt; int(psnr_score)</span>
  156. <span class="sd"> 34</span>
  157. <span class="sd"> &quot;&quot;&quot;</span>
  158. <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span> <span class="o">=</span> <span class="n">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">,</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  159. <span class="k">return</span> <span class="n">compare_psnr</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">)</span></div>
  160. <div class="viewcode-block" id="ssim"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ssim">[docs]</a><span class="k">def</span> <span class="nf">ssim</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  161. <span class="sd">&quot;&quot;&quot;Returns the computed Structural Similarity (SSIM) between two images</span>
  162. <span class="sd"> Args:</span>
  163. <span class="sd"> img_true: Image, numpy array of any dimension</span>
  164. <span class="sd"> img_test: Image, numpy array of any dimension</span>
  165. <span class="sd"> Returns:</span>
  166. <span class="sd"> Computed SSIM score</span>
  167. <span class="sd"> Example:</span>
  168. <span class="sd"> &gt;&gt;&gt; from ipfml.iqa import fr</span>
  169. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  170. <span class="sd"> &gt;&gt;&gt; arr1 = np.arange(100).reshape(10, 10)</span>
  171. <span class="sd"> &gt;&gt;&gt; arr2 = np.arange(5, 105).reshape(10, 10)</span>
  172. <span class="sd"> &gt;&gt;&gt; ssim_score = fr.ssim(arr1, arr2)</span>
  173. <span class="sd"> &gt;&gt;&gt; int(ssim_score)</span>
  174. <span class="sd"> 0</span>
  175. <span class="sd"> &quot;&quot;&quot;</span>
  176. <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span> <span class="o">=</span> <span class="n">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">)</span>
  177. <span class="k">if</span> <span class="n">img_true</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
  178. <span class="k">return</span> <span class="n">compare_ssim</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">,</span> <span class="n">multichannel</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
  179. <span class="k">else</span><span class="p">:</span>
  180. <span class="k">return</span> <span class="n">compare_ssim</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">)</span></div>
  181. <div class="viewcode-block" id="ms_ssim"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ms_ssim">[docs]</a><span class="k">def</span> <span class="nf">ms_ssim</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  182. <span class="sd">&quot;&quot;&quot;</span>
  183. <span class="sd"> Implemented later..</span>
  184. <span class="sd"> &quot;&quot;&quot;</span>
  185. <span class="k">pass</span></div>
  186. <div class="viewcode-block" id="vif"><a class="viewcode-back" href="../../../ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.vif">[docs]</a><span class="k">def</span> <span class="nf">vif</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">):</span>
  187. <span class="sd">&quot;&quot;&quot;</span>
  188. <span class="sd"> Implemented later..</span>
  189. <span class="sd"> &quot;&quot;&quot;</span>
  190. <span class="k">pass</span></div>
  191. </pre></div>
  192. </div>
  193. </div>
  194. <footer>
  195. <hr/>
  196. <div role="contentinfo">
  197. <p>
  198. &copy; Copyright 2019, Jérôme BUISINE
  199. </p>
  200. </div>
  201. 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>.
  202. </footer>
  203. </div>
  204. </div>
  205. </section>
  206. </div>
  207. <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
  208. <script type="text/javascript" src="../../../_static/jquery.js"></script>
  209. <script type="text/javascript" src="../../../_static/underscore.js"></script>
  210. <script type="text/javascript" src="../../../_static/doctools.js"></script>
  211. <script type="text/javascript" src="../../../_static/language_data.js"></script>
  212. <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  213. <script type="text/javascript">
  214. jQuery(function () {
  215. SphinxRtdTheme.Navigation.enable(true);
  216. });
  217. </script>
  218. </body>
  219. </html>