123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377 |
- <!DOCTYPE html>
- <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
- <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
- <head>
- <meta charset="utf-8">
-
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <title>ipfml.iqa.fr — IPFML v0.3.0 documentation</title>
-
-
-
-
-
-
-
-
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
- <link rel="index" title="Index" href="../../../genindex.html" />
- <link rel="search" title="Search" href="../../../search.html" />
-
- <script src="../../../_static/js/modernizr.min.js"></script>
- </head>
- <body class="wy-body-for-nav">
-
- <div class="wy-grid-for-nav">
-
- <nav data-toggle="wy-nav-shift" class="wy-nav-side">
- <div class="wy-side-scroll">
- <div class="wy-side-nav-search">
-
-
- <a href="../../../index.html" class="icon icon-home"> IPFML
-
-
- </a>
-
-
-
- <div class="version">
- 0.3.0
- </div>
-
-
-
- <div role="search">
- <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
- <input type="text" name="q" placeholder="Search docs" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
-
- </div>
- <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
-
-
-
- <p class="caption"><span class="caption-text">Contents:</span></p>
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>
- <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
- </ul>
-
-
- </div>
- </div>
- </nav>
- <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
- <nav class="wy-nav-top" aria-label="top navigation">
-
- <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="../../../index.html">IPFML</a>
-
- </nav>
- <div class="wy-nav-content">
-
- <div class="rst-content">
-
-
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
-
- <li><a href="../../../index.html">Docs</a> »</li>
-
- <li><a href="../../index.html">Module code</a> »</li>
-
- <li>ipfml.iqa.fr</li>
-
-
- <li class="wy-breadcrumbs-aside">
-
- </li>
-
- </ul>
-
- <hr/>
- </div>
- <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
- <div itemprop="articleBody">
-
- <h1>Source code for ipfml.iqa.fr</h1><div class="highlight"><pre>
- <span></span><span class="sd">"""</span>
- <span class="sd">Full-reference Image Quality Assessment (FR-IQA) methods</span>
- <span class="sd">"""</span>
- <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>
- <span class="kn">from</span> <span class="nn">ipfml.exceptions</span> <span class="k">import</span> <span class="n">NumpyShapeComparisonException</span>
- <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
- <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">'float32'</span><span class="p">):</span>
- <span class="sd">"""</span>
- <span class="sd"> Prepare image data</span>
- <span class="sd"> Raises:</span>
- <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
- <span class="sd"> """</span>
- <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>
- <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>
- <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>
- <span class="k">raise</span> <span class="n">NumpyShapeComparisonException</span>
- <span class="k">return</span> <span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span>
- <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>
- <span class="sd">"""Returns Mean-Squared Error score between two Numpy arrays</span>
- <span class="sd"> Args:</span>
- <span class="sd"> img_true: Image, numpy array of any dimension</span>
- <span class="sd"> img_test: Image, numpy array of any dimension</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> Computed MSE score</span>
- <span class="sd"> Raises:</span>
- <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.iqa import fr</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> arr1 = np.arange(10)</span>
- <span class="sd"> >>> arr2 = np.arange(5, 15)</span>
- <span class="sd"> >>> mse_score = fr.mse(arr1, arr2)</span>
- <span class="sd"> >>> mse_score</span>
- <span class="sd"> 25.0</span>
- <span class="sd"> """</span>
- <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="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>
- <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>
- <span class="sd">"""Returns Root Mean-Squared Error score between two Numpy arrays</span>
- <span class="sd"> Args:</span>
- <span class="sd"> img_true: Image, numpy array of any dimension</span>
- <span class="sd"> img_test: Image, numpy array of any dimension</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> Computed RMSE score</span>
- <span class="sd"> Raises:</span>
- <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.iqa import fr</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> arr1 = np.arange(10)</span>
- <span class="sd"> >>> arr2 = np.arange(5, 15)</span>
- <span class="sd"> >>> rmse_score = fr.rmse(arr1, arr2)</span>
- <span class="sd"> >>> rmse_score</span>
- <span class="sd"> 5.0</span>
- <span class="sd"> """</span>
- <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>
- <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>
- <span class="sd">"""Returns Mean Absolute Error between two Numpy arrays</span>
- <span class="sd"> Args:</span>
- <span class="sd"> img_true: Image, numpy array of any dimension</span>
- <span class="sd"> img_test: Image, numpy array of any dimension</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> Computed MAE score</span>
- <span class="sd"> Raises:</span>
- <span class="sd"> NumpyShapeComparisonException: if shape of images are not the same</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.iqa import fr</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> arr1 = np.arange(10)</span>
- <span class="sd"> >>> arr2 = np.arange(5, 15)</span>
- <span class="sd"> >>> mae_score = fr.mae(arr1, arr2)</span>
- <span class="sd"> >>> mae_score</span>
- <span class="sd"> 5.0</span>
- <span class="sd"> """</span>
- <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="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>
- <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>
- <span class="sd">"""Returns the computed Peak Signal to Noise Ratio (PSNR) between two images</span>
- <span class="sd"> Args:</span>
- <span class="sd"> img_true: Image, numpy array of any dimension</span>
- <span class="sd"> img_test: Image, numpy array of any dimension</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> Computed PSNR score</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.iqa import fr</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> arr1 = np.arange(100).reshape(10, 10)</span>
- <span class="sd"> >>> arr2 = np.arange(5, 105).reshape(10, 10)</span>
- <span class="sd"> >>> psnr_score = fr.psnr(arr1, arr2)</span>
- <span class="sd"> >>> int(psnr_score)</span>
- <span class="sd"> 34</span>
- <span class="sd"> """</span>
- <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">'uint8'</span><span class="p">)</span>
- <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>
- <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>
- <span class="sd">"""Returns the computed Structural Similarity (SSIM) between two images</span>
- <span class="sd"> Args:</span>
- <span class="sd"> img_true: Image, numpy array of any dimension</span>
- <span class="sd"> img_test: Image, numpy array of any dimension</span>
- <span class="sd"> Returns:</span>
- <span class="sd"> Computed SSIM score</span>
- <span class="sd"> Example:</span>
- <span class="sd"> >>> from ipfml.iqa import fr</span>
- <span class="sd"> >>> import numpy as np</span>
- <span class="sd"> >>> arr1 = np.arange(100).reshape(10, 10)</span>
- <span class="sd"> >>> arr2 = np.arange(5, 105).reshape(10, 10)</span>
- <span class="sd"> >>> ssim_score = fr.ssim(arr1, arr2)</span>
- <span class="sd"> >>> int(ssim_score)</span>
- <span class="sd"> 0</span>
- <span class="sd"> """</span>
- <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="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>
- <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>
- <span class="k">else</span><span class="p">:</span>
- <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>
- <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>
- <span class="sd">"""</span>
- <span class="sd"> Implemented later..</span>
- <span class="sd"> """</span>
- <span class="k">pass</span></div>
- <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>
- <span class="sd">"""</span>
- <span class="sd"> Implemented later..</span>
- <span class="sd"> """</span>
- <span class="k">pass</span></div>
- </pre></div>
- </div>
-
- </div>
- <footer>
-
- <hr/>
- <div role="contentinfo">
- <p>
- © Copyright 2019, Jérôme BUISINE
- </p>
- </div>
- 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>.
- </footer>
- </div>
- </div>
- </section>
- </div>
-
-
-
-
- <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../../../_static/jquery.js"></script>
- <script type="text/javascript" src="../../../_static/underscore.js"></script>
- <script type="text/javascript" src="../../../_static/doctools.js"></script>
- <script type="text/javascript" src="../../../_static/language_data.js"></script>
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
- <script type="text/javascript">
- jQuery(function () {
- SphinxRtdTheme.Navigation.enable(true);
- });
- </script>
- </body>
- </html>
|