ipfml.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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>Documentation &mdash; ipfml v0.4.4 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="genindex.html" />
  11. <link rel="search" title="Search" href="search.html" />
  12. <link rel="next" title="ipfml.metrics" href="ipfml/ipfml.metrics.html" />
  13. <link rel="prev" title="Description" href="description.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.4
  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="current reference internal" href="#">Documentation</a><ul>
  39. <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.metrics.html">ipfml.metrics</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.utils.html">ipfml.utils</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.exceptions.html">ipfml.exceptions</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="#ipfml-filters">ipfml.filters</a><ul>
  43. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
  44. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.kernels.html">ipfml.filters.kernels</a></li>
  45. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.noise.html">ipfml.filters.noise</a></li>
  46. </ul>
  47. </li>
  48. <li class="toctree-l2"><a class="reference internal" href="#ipfml-iqa">ipfml.iqa</a><ul>
  49. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.iqa.fr.html">ipfml.iqa.fr</a></li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l2"><a class="reference internal" href="#ipfml-processing">ipfml.processing</a><ul>
  53. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.compression.html">ipfml.processing.compression</a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.movement.html">ipfml.processing.movement</a></li>
  55. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
  56. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
  57. <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.transform.html">ipfml.processing.transform</a></li>
  58. </ul>
  59. </li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
  64. </ul>
  65. </div>
  66. </div>
  67. </nav>
  68. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  69. <nav class="wy-nav-top" aria-label="top navigation">
  70. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  71. <a href="index.html">ipfml</a>
  72. </nav>
  73. <div class="wy-nav-content">
  74. <div class="rst-content">
  75. <div role="navigation" aria-label="breadcrumbs navigation">
  76. <ul class="wy-breadcrumbs">
  77. <li><a href="index.html">Docs</a> &raquo;</li>
  78. <li>Documentation</li>
  79. <li class="wy-breadcrumbs-aside">
  80. <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml.rst" class="fa fa-github"> Edit on GitHub</a>
  81. </li>
  82. </ul>
  83. <hr/>
  84. </div>
  85. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  86. <div itemprop="articleBody">
  87. <div class="section" id="documentation">
  88. <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
  89. <table border="1" class="longtable docutils">
  90. <colgroup>
  91. <col width="10%" />
  92. <col width="90%" />
  93. </colgroup>
  94. <tbody valign="top">
  95. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.metrics.html#module-ipfml.metrics" title="ipfml.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.metrics</span></code></a></td>
  96. <td>Contains all metrics used for model results comparisons</td>
  97. </tr>
  98. <tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.utils.html#module-ipfml.utils" title="ipfml.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.utils</span></code></a></td>
  99. <td>Utils functions of ipfml package (normalization, integral…)</td>
  100. </tr>
  101. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions" title="ipfml.exceptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.exceptions</span></code></a></td>
  102. <td>Module which contains all customs Exceptions used into ipfml package</td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. <div class="section" id="ipfml-filters">
  107. <h2>ipfml.filters<a class="headerlink" href="#ipfml-filters" title="Permalink to this headline">¶</a></h2>
  108. <table border="1" class="longtable docutils">
  109. <colgroup>
  110. <col width="10%" />
  111. <col width="90%" />
  112. </colgroup>
  113. <tbody valign="top">
  114. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.filters.convolution.html#module-ipfml.filters.convolution" title="ipfml.filters.convolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.convolution</span></code></a></td>
  115. <td>Convolution functions to apply on images</td>
  116. </tr>
  117. <tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.filters.kernels.html#module-ipfml.filters.kernels" title="ipfml.filters.kernels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.kernels</span></code></a></td>
  118. <td>Kernel to apply on images using convolution</td>
  119. </tr>
  120. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise" title="ipfml.filters.noise"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.noise</span></code></a></td>
  121. <td>Noise filters to apply on images</td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. </div>
  126. <div class="section" id="ipfml-iqa">
  127. <h2>ipfml.iqa<a class="headerlink" href="#ipfml-iqa" title="Permalink to this headline">¶</a></h2>
  128. <table border="1" class="longtable docutils">
  129. <colgroup>
  130. <col width="10%" />
  131. <col width="90%" />
  132. </colgroup>
  133. <tbody valign="top">
  134. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr" title="ipfml.iqa.fr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.iqa.fr</span></code></a></td>
  135. <td>Full-reference Image Quality Assessment (FR-IQA) methods</td>
  136. </tr>
  137. </tbody>
  138. </table>
  139. </div>
  140. <div class="section" id="ipfml-processing">
  141. <h2>ipfml.processing<a class="headerlink" href="#ipfml-processing" title="Permalink to this headline">¶</a></h2>
  142. <table border="1" class="longtable docutils">
  143. <colgroup>
  144. <col width="10%" />
  145. <col width="90%" />
  146. </colgroup>
  147. <tbody valign="top">
  148. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression" title="ipfml.processing.compression"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.compression</span></code></a></td>
  149. <td>Functions for image compression and extraction</td>
  150. </tr>
  151. <tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.movement.html#module-ipfml.processing.movement" title="ipfml.processing.movement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.movement</span></code></a></td>
  152. <td>All movements that can be applied on image such as rotations, fusions, flips</td>
  153. </tr>
  154. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html#module-ipfml.processing.reconstruction" title="ipfml.processing.reconstruction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.reconstruction</span></code></a></td>
  155. <td>Functions for reconstruction process of image using reduction/compression methods</td>
  156. </tr>
  157. <tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html#module-ipfml.processing.segmentation" title="ipfml.processing.segmentation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.segmentation</span></code></a></td>
  158. <td>All segmentation methods applied on images</td>
  159. </tr>
  160. <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.transform.html#module-ipfml.processing.transform" title="ipfml.processing.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.transform</span></code></a></td>
  161. <td>Functions which can be used to extract information from image or reduce it</td>
  162. </tr>
  163. </tbody>
  164. </table>
  165. </div>
  166. </div>
  167. </div>
  168. </div>
  169. <footer>
  170. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  171. <a href="ipfml/ipfml.metrics.html" class="btn btn-neutral float-right" title="ipfml.metrics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  172. <a href="description.html" class="btn btn-neutral" title="Description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  173. </div>
  174. <hr/>
  175. <div role="contentinfo">
  176. <p>
  177. &copy; Copyright 2019, Jérôme BUISINE
  178. </p>
  179. </div>
  180. 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>.
  181. </footer>
  182. </div>
  183. </div>
  184. </section>
  185. </div>
  186. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  187. <script type="text/javascript" src="_static/jquery.js"></script>
  188. <script type="text/javascript" src="_static/underscore.js"></script>
  189. <script type="text/javascript" src="_static/doctools.js"></script>
  190. <script type="text/javascript" src="_static/language_data.js"></script>
  191. <script type="text/javascript" src="_static/js/theme.js"></script>
  192. <script type="text/javascript">
  193. jQuery(function () {
  194. SphinxRtdTheme.Navigation.enable(true);
  195. });
  196. </script>
  197. </body>
  198. </html>