genindex.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  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>Index &mdash; IPFML v0.3.3 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="#" />
  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.3
  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>Index</li>
  54. <li class="wy-breadcrumbs-aside">
  55. <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/genindex" class="fa fa-github"> Edit on GitHub</a>
  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 id="index">Index</h1>
  63. <div class="genindex-jumpbox">
  64. <a href="#C"><strong>C</strong></a>
  65. | <a href="#D"><strong>D</strong></a>
  66. | <a href="#F"><strong>F</strong></a>
  67. | <a href="#G"><strong>G</strong></a>
  68. | <a href="#I"><strong>I</strong></a>
  69. | <a href="#L"><strong>L</strong></a>
  70. | <a href="#M"><strong>M</strong></a>
  71. | <a href="#N"><strong>N</strong></a>
  72. | <a href="#P"><strong>P</strong></a>
  73. | <a href="#R"><strong>R</strong></a>
  74. | <a href="#S"><strong>S</strong></a>
  75. | <a href="#V"><strong>V</strong></a>
  76. | <a href="#W"><strong>W</strong></a>
  77. </div>
  78. <h2 id="C">C</h2>
  79. <table style="width: 100%" class="indextable genindextable"><tr>
  80. <td style="width: 33%; vertical-align: top;"><ul>
  81. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.cauchy_noise">cauchy_noise() (in module ipfml.filters.noise)</a>
  82. </li>
  83. </ul></td>
  84. </tr></table>
  85. <h2 id="D">D</h2>
  86. <table style="width: 100%" class="indextable genindextable"><tr>
  87. <td style="width: 33%; vertical-align: top;"><ul>
  88. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.divide_in_blocks">divide_in_blocks() (in module ipfml.processing)</a>
  89. </li>
  90. </ul></td>
  91. </tr></table>
  92. <h2 id="F">F</h2>
  93. <table style="width: 100%" class="indextable genindextable"><tr>
  94. <td style="width: 33%; vertical-align: top;"><ul>
  95. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.fusion_images">fusion_images() (in module ipfml.processing)</a>
  96. </li>
  97. </ul></td>
  98. </tr></table>
  99. <h2 id="G">G</h2>
  100. <table style="width: 100%" class="indextable genindextable"><tr>
  101. <td style="width: 33%; vertical-align: top;"><ul>
  102. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.gaussian_noise">gaussian_noise() (in module ipfml.filters.noise)</a>
  103. </li>
  104. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_bits_img">get_bits_img() (in module ipfml.metrics)</a>
  105. </li>
  106. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB">get_LAB() (in module ipfml.metrics)</a>
  107. </li>
  108. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_a">get_LAB_a() (in module ipfml.metrics)</a>
  109. </li>
  110. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_b">get_LAB_b() (in module ipfml.metrics)</a>
  111. </li>
  112. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_L">get_LAB_L() (in module ipfml.metrics)</a>
  113. </li>
  114. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD">get_LAB_L_SVD() (in module ipfml.processing)</a>
  115. </li>
  116. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_s">get_LAB_L_SVD_s() (in module ipfml.processing)</a>
  117. </li>
  118. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_U">get_LAB_L_SVD_U() (in module ipfml.processing)</a>
  119. </li>
  120. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_V">get_LAB_L_SVD_V() (in module ipfml.processing)</a>
  121. </li>
  122. </ul></td>
  123. <td style="width: 33%; vertical-align: top;"><ul>
  124. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_low_bits_img">get_low_bits_img() (in module ipfml.metrics)</a>
  125. </li>
  126. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD">get_SVD() (in module ipfml.metrics)</a>
  127. </li>
  128. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_s">get_SVD_s() (in module ipfml.metrics)</a>
  129. </li>
  130. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_U">get_SVD_U() (in module ipfml.metrics)</a>
  131. </li>
  132. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_V">get_SVD_V() (in module ipfml.metrics)</a>
  133. </li>
  134. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ">get_XYZ() (in module ipfml.metrics)</a>
  135. </li>
  136. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_X">get_XYZ_X() (in module ipfml.metrics)</a>
  137. </li>
  138. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Y">get_XYZ_Y() (in module ipfml.metrics)</a>
  139. </li>
  140. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Z">get_XYZ_Z() (in module ipfml.metrics)</a>
  141. </li>
  142. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.gray_to_mscn">gray_to_mscn() (in module ipfml.metrics)</a>
  143. </li>
  144. </ul></td>
  145. </tr></table>
  146. <h2 id="I">I</h2>
  147. <table style="width: 100%" class="indextable genindextable"><tr>
  148. <td style="width: 33%; vertical-align: top;"><ul>
  149. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.integral_area_simps">integral_area_simps() (in module ipfml.utils)</a>
  150. </li>
  151. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.integral_area_trapz">integral_area_trapz() (in module ipfml.utils)</a>
  152. </li>
  153. <li><a href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions">ipfml.exceptions (module)</a>
  154. </li>
  155. <li><a href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
  156. </li>
  157. </ul></td>
  158. <td style="width: 33%; vertical-align: top;"><ul>
  159. <li><a href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr">ipfml.iqa.fr (module)</a>
  160. </li>
  161. <li><a href="ipfml/ipfml.metrics.html#module-ipfml.metrics">ipfml.metrics (module)</a>
  162. </li>
  163. <li><a href="ipfml/ipfml.processing.html#module-ipfml.processing">ipfml.processing (module)</a>
  164. </li>
  165. <li><a href="ipfml/ipfml.utils.html#module-ipfml.utils">ipfml.utils (module)</a>
  166. </li>
  167. </ul></td>
  168. </tr></table>
  169. <h2 id="L">L</h2>
  170. <table style="width: 100%" class="indextable genindextable"><tr>
  171. <td style="width: 33%; vertical-align: top;"><ul>
  172. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.laplace_noise">laplace_noise() (in module ipfml.filters.noise)</a>
  173. </li>
  174. </ul></td>
  175. <td style="width: 33%; vertical-align: top;"><ul>
  176. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.log_normal_noise">log_normal_noise() (in module ipfml.filters.noise)</a>
  177. </li>
  178. </ul></td>
  179. </tr></table>
  180. <h2 id="M">M</h2>
  181. <table style="width: 100%" class="indextable genindextable"><tr>
  182. <td style="width: 33%; vertical-align: top;"><ul>
  183. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mae">mae() (in module ipfml.iqa.fr)</a>
  184. </li>
  185. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ms_ssim">ms_ssim() (in module ipfml.iqa.fr)</a>
  186. </li>
  187. </ul></td>
  188. <td style="width: 33%; vertical-align: top;"><ul>
  189. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mse">mse() (in module ipfml.iqa.fr)</a>
  190. </li>
  191. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.mut_white_noise">mut_white_noise() (in module ipfml.filters.noise)</a>
  192. </li>
  193. </ul></td>
  194. </tr></table>
  195. <h2 id="N">N</h2>
  196. <table style="width: 100%" class="indextable genindextable"><tr>
  197. <td style="width: 33%; vertical-align: top;"><ul>
  198. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_2D_arr">normalize_2D_arr() (in module ipfml.utils)</a>
  199. </li>
  200. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_arr">normalize_arr() (in module ipfml.utils)</a>
  201. </li>
  202. </ul></td>
  203. <td style="width: 33%; vertical-align: top;"><ul>
  204. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_arr_with_range">normalize_arr_with_range() (in module ipfml.utils)</a>
  205. </li>
  206. <li><a href="ipfml/ipfml.exceptions.html#ipfml.exceptions.NumpyDimensionComparisonException">NumpyDimensionComparisonException</a>
  207. </li>
  208. <li><a href="ipfml/ipfml.exceptions.html#ipfml.exceptions.NumpyShapeComparisonException">NumpyShapeComparisonException</a>
  209. </li>
  210. </ul></td>
  211. </tr></table>
  212. <h2 id="P">P</h2>
  213. <table style="width: 100%" class="indextable genindextable"><tr>
  214. <td style="width: 33%; vertical-align: top;"><ul>
  215. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.psnr">psnr() (in module ipfml.iqa.fr)</a>
  216. </li>
  217. </ul></td>
  218. </tr></table>
  219. <h2 id="R">R</h2>
  220. <table style="width: 100%" class="indextable genindextable"><tr>
  221. <td style="width: 33%; vertical-align: top;"><ul>
  222. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_grey_low_bits">rgb_to_grey_low_bits() (in module ipfml.processing)</a>
  223. </li>
  224. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_bits">rgb_to_LAB_L_bits() (in module ipfml.processing)</a>
  225. </li>
  226. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_low_bits">rgb_to_LAB_L_low_bits() (in module ipfml.processing)</a>
  227. </li>
  228. </ul></td>
  229. <td style="width: 33%; vertical-align: top;"><ul>
  230. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_mscn">rgb_to_mscn() (in module ipfml.processing)</a>
  231. </li>
  232. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.rmse">rmse() (in module ipfml.iqa.fr)</a>
  233. </li>
  234. <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rotate_image">rotate_image() (in module ipfml.processing)</a>
  235. </li>
  236. </ul></td>
  237. </tr></table>
  238. <h2 id="S">S</h2>
  239. <table style="width: 100%" class="indextable genindextable"><tr>
  240. <td style="width: 33%; vertical-align: top;"><ul>
  241. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.salt_pepper_noise">salt_pepper_noise() (in module ipfml.filters.noise)</a>
  242. </li>
  243. </ul></td>
  244. <td style="width: 33%; vertical-align: top;"><ul>
  245. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ssim">ssim() (in module ipfml.iqa.fr)</a>
  246. </li>
  247. </ul></td>
  248. </tr></table>
  249. <h2 id="V">V</h2>
  250. <table style="width: 100%" class="indextable genindextable"><tr>
  251. <td style="width: 33%; vertical-align: top;"><ul>
  252. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.vif">vif() (in module ipfml.iqa.fr)</a>
  253. </li>
  254. </ul></td>
  255. </tr></table>
  256. <h2 id="W">W</h2>
  257. <table style="width: 100%" class="indextable genindextable"><tr>
  258. <td style="width: 33%; vertical-align: top;"><ul>
  259. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.white_noise">white_noise() (in module ipfml.filters.noise)</a>
  260. </li>
  261. </ul></td>
  262. </tr></table>
  263. </div>
  264. </div>
  265. <footer>
  266. <hr/>
  267. <div role="contentinfo">
  268. <p>
  269. &copy; Copyright 2019, Jérôme BUISINE
  270. </p>
  271. </div>
  272. 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>.
  273. </footer>
  274. </div>
  275. </div>
  276. </section>
  277. </div>
  278. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  279. <script type="text/javascript" src="_static/jquery.js"></script>
  280. <script type="text/javascript" src="_static/underscore.js"></script>
  281. <script type="text/javascript" src="_static/doctools.js"></script>
  282. <script type="text/javascript" src="_static/language_data.js"></script>
  283. <script type="text/javascript" src="_static/js/theme.js"></script>
  284. <script type="text/javascript">
  285. jQuery(function () {
  286. SphinxRtdTheme.Navigation.enable(true);
  287. });
  288. </script>
  289. </body>
  290. </html>