genindex.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  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.4.1 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.4.1
  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 of ipfml</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/prise-3d/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. <td style="width: 33%; vertical-align: top;"><ul>
  85. <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.coefficient_of_determination">coefficient_of_determination() (in module ipfml.metrics)</a>
  86. </li>
  87. </ul></td>
  88. </tr></table>
  89. <h2 id="D">D</h2>
  90. <table style="width: 100%" class="indextable genindextable"><tr>
  91. <td style="width: 33%; vertical-align: top;"><ul>
  92. <li><a href="ipfml/ipfml.processing.segmentation.html#ipfml.processing.segmentation.divide_in_blocks">divide_in_blocks() (in module ipfml.processing.segmentation)</a>
  93. </li>
  94. </ul></td>
  95. </tr></table>
  96. <h2 id="F">F</h2>
  97. <table style="width: 100%" class="indextable genindextable"><tr>
  98. <td style="width: 33%; vertical-align: top;"><ul>
  99. <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.fast_ica">fast_ica() (in module ipfml.processing.reconstruction)</a>
  100. </li>
  101. </ul></td>
  102. <td style="width: 33%; vertical-align: top;"><ul>
  103. <li><a href="ipfml/ipfml.processing.movement.html#ipfml.processing.movement.fusion_images">fusion_images() (in module ipfml.processing.movement)</a>
  104. </li>
  105. </ul></td>
  106. </tr></table>
  107. <h2 id="G">G</h2>
  108. <table style="width: 100%" class="indextable genindextable"><tr>
  109. <td style="width: 33%; vertical-align: top;"><ul>
  110. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.gaussian_noise">gaussian_noise() (in module ipfml.filters.noise)</a>
  111. </li>
  112. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_bits_img">get_bits_img() (in module ipfml.processing.transform)</a>
  113. </li>
  114. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_entropy">get_entropy() (in module ipfml.utils)</a>
  115. </li>
  116. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_entropy_contribution_of_i">get_entropy_contribution_of_i() (in module ipfml.utils)</a>
  117. </li>
  118. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_entropy_without_i">get_entropy_without_i() (in module ipfml.utils)</a>
  119. </li>
  120. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_indices_of_highest_values">get_indices_of_highest_values() (in module ipfml.utils)</a>
  121. </li>
  122. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_indices_of_lowest_values">get_indices_of_lowest_values() (in module ipfml.utils)</a>
  123. </li>
  124. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB">get_LAB() (in module ipfml.processing.transform)</a>
  125. </li>
  126. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_a">get_LAB_a() (in module ipfml.processing.transform)</a>
  127. </li>
  128. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_b">get_LAB_b() (in module ipfml.processing.transform)</a>
  129. </li>
  130. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L">get_LAB_L() (in module ipfml.processing.transform)</a>
  131. </li>
  132. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD">get_LAB_L_SVD() (in module ipfml.processing.transform)</a>
  133. </li>
  134. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_s">get_LAB_L_SVD_s() (in module ipfml.processing.transform)</a>
  135. </li>
  136. </ul></td>
  137. <td style="width: 33%; vertical-align: top;"><ul>
  138. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_U">get_LAB_L_SVD_U() (in module ipfml.processing.transform)</a>
  139. </li>
  140. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_V">get_LAB_L_SVD_V() (in module ipfml.processing.transform)</a>
  141. </li>
  142. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_low_bits_img">get_low_bits_img() (in module ipfml.processing.transform)</a>
  143. </li>
  144. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_mscn_coefficients">get_mscn_coefficients() (in module ipfml.processing.transform)</a>
  145. </li>
  146. <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD">get_SVD() (in module ipfml.processing.compression)</a>
  147. </li>
  148. <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_s">get_SVD_s() (in module ipfml.processing.compression)</a>
  149. </li>
  150. <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_U">get_SVD_U() (in module ipfml.processing.compression)</a>
  151. </li>
  152. <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_V">get_SVD_V() (in module ipfml.processing.compression)</a>
  153. </li>
  154. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ">get_XYZ() (in module ipfml.processing.transform)</a>
  155. </li>
  156. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_X">get_XYZ_X() (in module ipfml.processing.transform)</a>
  157. </li>
  158. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_Y">get_XYZ_Y() (in module ipfml.processing.transform)</a>
  159. </li>
  160. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_Z">get_XYZ_Z() (in module ipfml.processing.transform)</a>
  161. </li>
  162. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.gray_to_mscn">gray_to_mscn() (in module ipfml.processing.transform)</a>
  163. </li>
  164. </ul></td>
  165. </tr></table>
  166. <h2 id="I">I</h2>
  167. <table style="width: 100%" class="indextable genindextable"><tr>
  168. <td style="width: 33%; vertical-align: top;"><ul>
  169. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.integral_area_simps">integral_area_simps() (in module ipfml.utils)</a>
  170. </li>
  171. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.integral_area_trapz">integral_area_trapz() (in module ipfml.utils)</a>
  172. </li>
  173. <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.ipca">ipca() (in module ipfml.processing.reconstruction)</a>
  174. </li>
  175. <li><a href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions">ipfml.exceptions (module)</a>
  176. </li>
  177. <li><a href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
  178. </li>
  179. <li><a href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr">ipfml.iqa.fr (module)</a>
  180. </li>
  181. </ul></td>
  182. <td style="width: 33%; vertical-align: top;"><ul>
  183. <li><a href="ipfml/ipfml.metrics.html#module-ipfml.metrics">ipfml.metrics (module)</a>
  184. </li>
  185. <li><a href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression">ipfml.processing.compression (module)</a>
  186. </li>
  187. <li><a href="ipfml/ipfml.processing.movement.html#module-ipfml.processing.movement">ipfml.processing.movement (module)</a>
  188. </li>
  189. <li><a href="ipfml/ipfml.processing.reconstruction.html#module-ipfml.processing.reconstruction">ipfml.processing.reconstruction (module)</a>
  190. </li>
  191. <li><a href="ipfml/ipfml.processing.segmentation.html#module-ipfml.processing.segmentation">ipfml.processing.segmentation (module)</a>
  192. </li>
  193. <li><a href="ipfml/ipfml.processing.transform.html#module-ipfml.processing.transform">ipfml.processing.transform (module)</a>
  194. </li>
  195. <li><a href="ipfml/ipfml.utils.html#module-ipfml.utils">ipfml.utils (module)</a>
  196. </li>
  197. </ul></td>
  198. </tr></table>
  199. <h2 id="L">L</h2>
  200. <table style="width: 100%" class="indextable genindextable"><tr>
  201. <td style="width: 33%; vertical-align: top;"><ul>
  202. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.laplace_noise">laplace_noise() (in module ipfml.filters.noise)</a>
  203. </li>
  204. </ul></td>
  205. <td style="width: 33%; vertical-align: top;"><ul>
  206. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.log_normal_noise">log_normal_noise() (in module ipfml.filters.noise)</a>
  207. </li>
  208. </ul></td>
  209. </tr></table>
  210. <h2 id="M">M</h2>
  211. <table style="width: 100%" class="indextable genindextable"><tr>
  212. <td style="width: 33%; vertical-align: top;"><ul>
  213. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mae">mae() (in module ipfml.iqa.fr)</a>
  214. </li>
  215. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ms_ssim">ms_ssim() (in module ipfml.iqa.fr)</a>
  216. </li>
  217. </ul></td>
  218. <td style="width: 33%; vertical-align: top;"><ul>
  219. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.mse">mse() (in module ipfml.iqa.fr)</a>
  220. </li>
  221. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.mut_white_noise">mut_white_noise() (in module ipfml.filters.noise)</a>
  222. </li>
  223. </ul></td>
  224. </tr></table>
  225. <h2 id="N">N</h2>
  226. <table style="width: 100%" class="indextable genindextable"><tr>
  227. <td style="width: 33%; vertical-align: top;"><ul>
  228. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_2D_arr">normalize_2D_arr() (in module ipfml.utils)</a>
  229. </li>
  230. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_arr">normalize_arr() (in module ipfml.utils)</a>
  231. </li>
  232. </ul></td>
  233. <td style="width: 33%; vertical-align: top;"><ul>
  234. <li><a href="ipfml/ipfml.utils.html#ipfml.utils.normalize_arr_with_range">normalize_arr_with_range() (in module ipfml.utils)</a>
  235. </li>
  236. <li><a href="ipfml/ipfml.exceptions.html#ipfml.exceptions.NumpyDimensionComparisonException">NumpyDimensionComparisonException</a>
  237. </li>
  238. <li><a href="ipfml/ipfml.exceptions.html#ipfml.exceptions.NumpyShapeComparisonException">NumpyShapeComparisonException</a>
  239. </li>
  240. </ul></td>
  241. </tr></table>
  242. <h2 id="P">P</h2>
  243. <table style="width: 100%" class="indextable genindextable"><tr>
  244. <td style="width: 33%; vertical-align: top;"><ul>
  245. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.psnr">psnr() (in module ipfml.iqa.fr)</a>
  246. </li>
  247. </ul></td>
  248. </tr></table>
  249. <h2 id="R">R</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.processing.transform.html#ipfml.processing.transform.rgb_to_grey_low_bits">rgb_to_grey_low_bits() (in module ipfml.processing.transform)</a>
  253. </li>
  254. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_LAB_L_bits">rgb_to_LAB_L_bits() (in module ipfml.processing.transform)</a>
  255. </li>
  256. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_LAB_L_low_bits">rgb_to_LAB_L_low_bits() (in module ipfml.processing.transform)</a>
  257. </li>
  258. </ul></td>
  259. <td style="width: 33%; vertical-align: top;"><ul>
  260. <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_mscn">rgb_to_mscn() (in module ipfml.processing.transform)</a>
  261. </li>
  262. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.rmse">rmse() (in module ipfml.iqa.fr)</a>
  263. </li>
  264. <li><a href="ipfml/ipfml.processing.movement.html#ipfml.processing.movement.rotate_image">rotate_image() (in module ipfml.processing.movement)</a>
  265. </li>
  266. </ul></td>
  267. </tr></table>
  268. <h2 id="S">S</h2>
  269. <table style="width: 100%" class="indextable genindextable"><tr>
  270. <td style="width: 33%; vertical-align: top;"><ul>
  271. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.salt_pepper_noise">salt_pepper_noise() (in module ipfml.filters.noise)</a>
  272. </li>
  273. </ul></td>
  274. <td style="width: 33%; vertical-align: top;"><ul>
  275. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ssim">ssim() (in module ipfml.iqa.fr)</a>
  276. </li>
  277. <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.svd">svd() (in module ipfml.processing.reconstruction)</a>
  278. </li>
  279. </ul></td>
  280. </tr></table>
  281. <h2 id="V">V</h2>
  282. <table style="width: 100%" class="indextable genindextable"><tr>
  283. <td style="width: 33%; vertical-align: top;"><ul>
  284. <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.vif">vif() (in module ipfml.iqa.fr)</a>
  285. </li>
  286. </ul></td>
  287. </tr></table>
  288. <h2 id="W">W</h2>
  289. <table style="width: 100%" class="indextable genindextable"><tr>
  290. <td style="width: 33%; vertical-align: top;"><ul>
  291. <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.white_noise">white_noise() (in module ipfml.filters.noise)</a>
  292. </li>
  293. </ul></td>
  294. </tr></table>
  295. </div>
  296. </div>
  297. <footer>
  298. <hr/>
  299. <div role="contentinfo">
  300. <p>
  301. &copy; Copyright 2019, Jérôme BUISINE
  302. </p>
  303. </div>
  304. 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>.
  305. </footer>
  306. </div>
  307. </div>
  308. </section>
  309. </div>
  310. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  311. <script type="text/javascript" src="_static/jquery.js"></script>
  312. <script type="text/javascript" src="_static/underscore.js"></script>
  313. <script type="text/javascript" src="_static/doctools.js"></script>
  314. <script type="text/javascript" src="_static/language_data.js"></script>
  315. <script type="text/javascript" src="_static/js/theme.js"></script>
  316. <script type="text/javascript">
  317. jQuery(function () {
  318. SphinxRtdTheme.Navigation.enable(true);
  319. });
  320. </script>
  321. </body>
  322. </html>