processing.html 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681
  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.processing &mdash; IPFML v0.3.7 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.3.7
  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.processing</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.processing</h1><div class="highlight"><pre>
  63. <span></span><span class="sd">&quot;&quot;&quot;</span>
  64. <span class="sd">Functions to quickly extract reduced information from image</span>
  65. <span class="sd">&quot;&quot;&quot;</span>
  66. <span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
  67. <span class="kn">import</span> <span class="nn">random</span>
  68. <span class="kn">import</span> <span class="nn">cv2</span>
  69. <span class="kn">from</span> <span class="nn">skimage</span> <span class="k">import</span> <span class="n">transform</span><span class="p">,</span> <span class="n">color</span>
  70. <span class="kn">from</span> <span class="nn">scipy</span> <span class="k">import</span> <span class="n">signal</span>
  71. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  72. <span class="kn">import</span> <span class="nn">ipfml.metrics</span> <span class="k">as</span> <span class="nn">metrics</span>
  73. <span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">exceptions</span>
  74. <span class="kn">import</span> <span class="nn">os</span>
  75. <div class="viewcode-block" id="get_LAB_L_SVD"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_L_SVD</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  76. <span class="sd">&quot;&quot;&quot;Returns Singular values from LAB L Image information</span>
  77. <span class="sd"> Args:</span>
  78. <span class="sd"> image: PIL Image or Numpy array</span>
  79. <span class="sd"> Returns:</span>
  80. <span class="sd"> U, s, V information obtained from SVD compression using Lab</span>
  81. <span class="sd"> Example:</span>
  82. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  83. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  84. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  85. <span class="sd"> &gt;&gt;&gt; U, s, V = processing.get_LAB_L_SVD(img)</span>
  86. <span class="sd"> &gt;&gt;&gt; U.shape</span>
  87. <span class="sd"> (200, 200)</span>
  88. <span class="sd"> &gt;&gt;&gt; len(s)</span>
  89. <span class="sd"> 200</span>
  90. <span class="sd"> &gt;&gt;&gt; V.shape</span>
  91. <span class="sd"> (200, 200)</span>
  92. <span class="sd"> &quot;&quot;&quot;</span>
  93. <span class="n">L</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  94. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD</span><span class="p">(</span><span class="n">L</span><span class="p">)</span></div>
  95. <div class="viewcode-block" id="get_LAB_L_SVD_s"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_s">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_L_SVD_s</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  96. <span class="sd">&quot;&quot;&quot;Returns s (Singular values) SVD from L of LAB Image information</span>
  97. <span class="sd"> Args:</span>
  98. <span class="sd"> image: PIL Image or Numpy array</span>
  99. <span class="sd"> Returns:</span>
  100. <span class="sd"> vector of singular values</span>
  101. <span class="sd"> Example:</span>
  102. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  103. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  104. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  105. <span class="sd"> &gt;&gt;&gt; s = processing.get_LAB_L_SVD_s(img)</span>
  106. <span class="sd"> &gt;&gt;&gt; len(s)</span>
  107. <span class="sd"> 200</span>
  108. <span class="sd"> &quot;&quot;&quot;</span>
  109. <span class="n">L</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  110. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_s</span><span class="p">(</span><span class="n">L</span><span class="p">)</span></div>
  111. <div class="viewcode-block" id="get_LAB_L_SVD_U"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_U">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_L_SVD_U</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  112. <span class="sd">&quot;&quot;&quot;Returns U SVD from L of LAB Image information</span>
  113. <span class="sd"> Args:</span>
  114. <span class="sd"> image: PIL Image or Numpy array</span>
  115. <span class="sd"> Returns:</span>
  116. <span class="sd"> U matrix of SVD compression</span>
  117. <span class="sd"> Example:</span>
  118. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  119. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  120. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  121. <span class="sd"> &gt;&gt;&gt; U = processing.get_LAB_L_SVD_U(img)</span>
  122. <span class="sd"> &gt;&gt;&gt; U.shape</span>
  123. <span class="sd"> (200, 200)</span>
  124. <span class="sd"> &quot;&quot;&quot;</span>
  125. <span class="n">L</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  126. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_U</span><span class="p">(</span><span class="n">L</span><span class="p">)</span></div>
  127. <div class="viewcode-block" id="get_LAB_L_SVD_V"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_V">[docs]</a><span class="k">def</span> <span class="nf">get_LAB_L_SVD_V</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  128. <span class="sd">&quot;&quot;&quot;Returns V SVD from L of LAB Image information</span>
  129. <span class="sd"> Args:</span>
  130. <span class="sd"> image: PIL Image or Numpy array</span>
  131. <span class="sd"> Returns:</span>
  132. <span class="sd"> V matrix of SVD compression</span>
  133. <span class="sd"> Example:</span>
  134. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  135. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  136. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  137. <span class="sd"> &gt;&gt;&gt; V = processing.get_LAB_L_SVD_V(img)</span>
  138. <span class="sd"> &gt;&gt;&gt; V.shape</span>
  139. <span class="sd"> (200, 200)</span>
  140. <span class="sd"> &quot;&quot;&quot;</span>
  141. <span class="n">L</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  142. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_V</span><span class="p">(</span><span class="n">L</span><span class="p">)</span></div>
  143. <div class="viewcode-block" id="rgb_to_mscn"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.rgb_to_mscn">[docs]</a><span class="k">def</span> <span class="nf">rgb_to_mscn</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  144. <span class="sd">&quot;&quot;&quot;Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</span>
  145. <span class="sd"> Args:</span>
  146. <span class="sd"> image: 3D RGB image Numpy array or PIL RGB image</span>
  147. <span class="sd"> Returns:</span>
  148. <span class="sd"> 2D Numpy array with MSCN information</span>
  149. <span class="sd"> Example:</span>
  150. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  151. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  152. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  153. <span class="sd"> &gt;&gt;&gt; img_mscn = processing.rgb_to_mscn(img)</span>
  154. <span class="sd"> &gt;&gt;&gt; img_mscn.shape</span>
  155. <span class="sd"> (200, 200)</span>
  156. <span class="sd"> &quot;&quot;&quot;</span>
  157. <span class="c1"># check if PIL image or not</span>
  158. <span class="n">img_arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  159. <span class="c1"># convert rgb image to gray</span>
  160. <span class="n">im</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">color</span><span class="o">.</span><span class="n">rgb2gray</span><span class="p">(</span><span class="n">img_arr</span><span class="p">)</span> <span class="o">*</span> <span class="mi">255</span><span class="p">,</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  161. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">gray_to_mscn</span><span class="p">(</span><span class="n">im</span><span class="p">)</span></div>
  162. <div class="viewcode-block" id="rgb_to_grey_low_bits"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.rgb_to_grey_low_bits">[docs]</a><span class="k">def</span> <span class="nf">rgb_to_grey_low_bits</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">nb_bits</span><span class="o">=</span><span class="mi">4</span><span class="p">):</span>
  163. <span class="sd">&quot;&quot;&quot;Convert RGB Image into grey image using only 4 low bits values</span>
  164. <span class="sd"> Args:</span>
  165. <span class="sd"> image: 3D RGB image Numpy array or PIL RGB image</span>
  166. <span class="sd"> nb_bits: optional parameter which indicates the number of bits to keep (default 4)</span>
  167. <span class="sd"> Returns:</span>
  168. <span class="sd"> 2D Numpy array with low bits information kept</span>
  169. <span class="sd"> Example:</span>
  170. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  171. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  172. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  173. <span class="sd"> &gt;&gt;&gt; low_bits_grey_img = processing.rgb_to_grey_low_bits(img, 5)</span>
  174. <span class="sd"> &gt;&gt;&gt; low_bits_grey_img.shape</span>
  175. <span class="sd"> (200, 200)</span>
  176. <span class="sd"> &quot;&quot;&quot;</span>
  177. <span class="n">img_arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  178. <span class="n">grey_block</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">color</span><span class="o">.</span><span class="n">rgb2gray</span><span class="p">(</span><span class="n">img_arr</span><span class="p">)</span> <span class="o">*</span> <span class="mi">255</span><span class="p">,</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  179. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_low_bits_img</span><span class="p">(</span><span class="n">grey_block</span><span class="p">,</span> <span class="n">nb_bits</span><span class="p">)</span></div>
  180. <div class="viewcode-block" id="rgb_to_LAB_L_low_bits"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_low_bits">[docs]</a><span class="k">def</span> <span class="nf">rgb_to_LAB_L_low_bits</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">nb_bits</span><span class="o">=</span><span class="mi">4</span><span class="p">):</span>
  181. <span class="sd">&quot;&quot;&quot;Convert RGB Image into Lab L channel image using only 4 low bits values</span>
  182. <span class="sd"> Args:</span>
  183. <span class="sd"> image: 3D RGB image Numpy array or PIL RGB image</span>
  184. <span class="sd"> nb_bits: optional parameter which indicates the number of bits to keep (default 4)</span>
  185. <span class="sd"> Returns:</span>
  186. <span class="sd"> 2D Numpy array with low bits information kept</span>
  187. <span class="sd"> Example:</span>
  188. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  189. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  190. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  191. <span class="sd"> &gt;&gt;&gt; low_bits_Lab_l_img = processing.rgb_to_LAB_L_low_bits(img, 5)</span>
  192. <span class="sd"> &gt;&gt;&gt; low_bits_Lab_l_img.shape</span>
  193. <span class="sd"> (200, 200)</span>
  194. <span class="sd"> &quot;&quot;&quot;</span>
  195. <span class="n">L_block</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">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">),</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  196. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_low_bits_img</span><span class="p">(</span><span class="n">L_block</span><span class="p">,</span> <span class="n">nb_bits</span><span class="p">)</span></div>
  197. <div class="viewcode-block" id="rgb_to_LAB_L_bits"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_bits">[docs]</a><span class="k">def</span> <span class="nf">rgb_to_LAB_L_bits</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
  198. <span class="sd">&quot;&quot;&quot;Returns only bits from LAB L canal specified into the interval</span>
  199. <span class="sd"> Args:</span>
  200. <span class="sd"> image: image to convert using this interval of bits value to keep</span>
  201. <span class="sd"> interval: (begin, end) of bits values</span>
  202. <span class="sd"> Returns:</span>
  203. <span class="sd"> 2D Numpy array with reduced values</span>
  204. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  205. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  206. <span class="sd"> &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
  207. <span class="sd"> &gt;&gt;&gt; bits_Lab_l_img = processing.rgb_to_LAB_L_bits(img, (2, 6))</span>
  208. <span class="sd"> &gt;&gt;&gt; bits_Lab_l_img.shape</span>
  209. <span class="sd"> (200, 200)</span>
  210. <span class="sd"> &quot;&quot;&quot;</span>
  211. <span class="n">L_block</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">metrics</span><span class="o">.</span><span class="n">get_LAB_L</span><span class="p">(</span><span class="n">image</span><span class="p">),</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  212. <span class="k">return</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_bits_img</span><span class="p">(</span><span class="n">L_block</span><span class="p">,</span> <span class="n">interval</span><span class="p">)</span></div>
  213. <div class="viewcode-block" id="divide_in_blocks"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.divide_in_blocks">[docs]</a><span class="k">def</span> <span class="nf">divide_in_blocks</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">block_size</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  214. <span class="sd">&#39;&#39;&#39;Divide image into equal size blocks</span>
  215. <span class="sd"> Args:</span>
  216. <span class="sd"> image: PIL Image or Numpy array</span>
  217. <span class="sd"> block: tuple (width, height) representing the size of each dimension of the block</span>
  218. <span class="sd"> pil: block type returned as PIL Image (default True)</span>
  219. <span class="sd"> Returns:</span>
  220. <span class="sd"> list containing all 2D Numpy blocks (in RGB or not)</span>
  221. <span class="sd"> Raises:</span>
  222. <span class="sd"> ValueError: If `image_width` or `image_height` are not compatible to produce correct block sizes</span>
  223. <span class="sd"> Example:</span>
  224. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  225. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  226. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  227. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  228. <span class="sd"> &gt;&gt;&gt; image_values = np.random.randint(255, size=(800, 800, 3))</span>
  229. <span class="sd"> &gt;&gt;&gt; blocks = divide_in_blocks(image_values, (20, 20))</span>
  230. <span class="sd"> &gt;&gt;&gt; len(blocks)</span>
  231. <span class="sd"> 1600</span>
  232. <span class="sd"> &gt;&gt;&gt; blocks[0].width</span>
  233. <span class="sd"> 20</span>
  234. <span class="sd"> &gt;&gt;&gt; blocks[0].height</span>
  235. <span class="sd"> 20</span>
  236. <span class="sd"> &gt;&gt;&gt; img_l = Image.open(&#39;./images/test_img.png&#39;)</span>
  237. <span class="sd"> &gt;&gt;&gt; L = metrics.get_LAB_L(img_l)</span>
  238. <span class="sd"> &gt;&gt;&gt; blocks_L = divide_in_blocks(L, (100, 100))</span>
  239. <span class="sd"> &gt;&gt;&gt; len(blocks_L)</span>
  240. <span class="sd"> 4</span>
  241. <span class="sd"> &gt;&gt;&gt; blocks_L[0].width</span>
  242. <span class="sd"> 100</span>
  243. <span class="sd"> &#39;&#39;&#39;</span>
  244. <span class="n">blocks</span> <span class="o">=</span> <span class="p">[]</span>
  245. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;RGB&#39;</span>
  246. <span class="c1"># convert in Numpy array</span>
  247. <span class="n">image_array</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
  248. <span class="c1"># check dimension of input image</span>
  249. <span class="k">if</span> <span class="n">image_array</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
  250. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;L&#39;</span>
  251. <span class="n">image_width</span><span class="p">,</span> <span class="n">image_height</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
  252. <span class="k">else</span><span class="p">:</span>
  253. <span class="n">image_width</span><span class="p">,</span> <span class="n">image_height</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
  254. <span class="c1"># check size compatibility</span>
  255. <span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">block_size</span>
  256. <span class="k">if</span> <span class="p">(</span><span class="n">image_width</span> <span class="o">%</span> <span class="n">width</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">):</span>
  257. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Width size issue, block size not compatible&quot;</span><span class="p">)</span>
  258. <span class="k">if</span> <span class="p">(</span><span class="n">image_height</span> <span class="o">%</span> <span class="n">height</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">):</span>
  259. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Height size issue, block size not compatible&quot;</span><span class="p">)</span>
  260. <span class="n">nb_block_width</span> <span class="o">=</span> <span class="n">image_width</span> <span class="o">/</span> <span class="n">width</span>
  261. <span class="n">nb_block_height</span> <span class="o">=</span> <span class="n">image_height</span> <span class="o">/</span> <span class="n">height</span>
  262. <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">nb_block_width</span><span class="p">)):</span>
  263. <span class="n">begin_x</span> <span class="o">=</span> <span class="n">i</span> <span class="o">*</span> <span class="n">width</span>
  264. <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">nb_block_height</span><span class="p">)):</span>
  265. <span class="n">begin_y</span> <span class="o">=</span> <span class="n">j</span> <span class="o">*</span> <span class="n">height</span>
  266. <span class="c1"># getting sub block information</span>
  267. <span class="n">current_block</span> <span class="o">=</span> <span class="n">image_array</span><span class="p">[</span><span class="n">begin_x</span><span class="p">:(</span><span class="n">begin_x</span> <span class="o">+</span> <span class="n">width</span><span class="p">),</span> <span class="n">begin_y</span><span class="p">:(</span>
  268. <span class="n">begin_y</span> <span class="o">+</span> <span class="n">height</span><span class="p">)]</span>
  269. <span class="k">if</span> <span class="n">pil</span><span class="p">:</span>
  270. <span class="n">blocks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  271. <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">current_block</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="s1">&#39;uint8&#39;</span><span class="p">),</span> <span class="n">mode</span><span class="p">))</span>
  272. <span class="k">else</span><span class="p">:</span>
  273. <span class="n">blocks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">current_block</span><span class="p">)</span>
  274. <span class="k">return</span> <span class="n">blocks</span></div>
  275. <div class="viewcode-block" id="fusion_images"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.fusion_images">[docs]</a><span class="k">def</span> <span class="nf">fusion_images</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  276. <span class="sd">&#39;&#39;&#39;Fusion array of images into single image</span>
  277. <span class="sd"> Args:</span>
  278. <span class="sd"> images: array of images (PIL Image or Numpy array)</span>
  279. <span class="sd"> pil: block type returned as PIL Image (default True)</span>
  280. <span class="sd"> Returns:</span>
  281. <span class="sd"> merged image from array of images</span>
  282. <span class="sd"> Raises:</span>
  283. <span class="sd"> ValueError: if `images` is not an array or is empty</span>
  284. <span class="sd"> NumpyShapeComparisonException: if `images` array contains images with different shapes</span>
  285. <span class="sd"> Example:</span>
  286. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  287. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  288. <span class="sd"> &gt;&gt;&gt; image_values_1 = np.random.randint(255, size=(800, 800, 3))</span>
  289. <span class="sd"> &gt;&gt;&gt; image_values_2 = np.random.randint(255, size=(800, 800, 3))</span>
  290. <span class="sd"> &gt;&gt;&gt; merged_image = processing.fusion_images([image_values_1, image_values_2], pil=False)</span>
  291. <span class="sd"> &gt;&gt;&gt; merged_image.shape</span>
  292. <span class="sd"> (800, 800, 3)</span>
  293. <span class="sd"> &#39;&#39;&#39;</span>
  294. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;RGB&#39;</span>
  295. <span class="n">dim</span> <span class="o">=</span> <span class="mi">1</span>
  296. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">images</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
  297. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Empty array of images provided...&#39;</span><span class="p">)</span>
  298. <span class="c1"># convert image in numpy array (perhaps not necessary)</span>
  299. <span class="n">images</span> <span class="o">=</span> <span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">img</span><span class="p">)</span> <span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="n">images</span><span class="p">]</span>
  300. <span class="n">image_array</span> <span class="o">=</span> <span class="n">images</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  301. <span class="k">if</span> <span class="n">image_array</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
  302. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;L&#39;</span>
  303. <span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
  304. <span class="k">else</span><span class="p">:</span>
  305. <span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">dim</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
  306. <span class="c1"># raise exception if all images do not have same shape</span>
  307. <span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">image_array</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">a</span><span class="o">.</span><span class="n">shape</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">images</span><span class="p">])</span><span class="o">.</span><span class="n">all</span><span class="p">():</span>
  308. <span class="k">raise</span> <span class="n">NumpyShapeComparisonException</span><span class="p">()</span>
  309. <span class="k">if</span> <span class="n">dim</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
  310. <span class="n">image_mean</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">([</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">])</span>
  311. <span class="k">else</span><span class="p">:</span>
  312. <span class="n">image_mean</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">([</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">dim</span><span class="p">])</span>
  313. <span class="n">nb_images</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">images</span><span class="p">)</span>
  314. <span class="c1"># construction of mean image from rotation</span>
  315. <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">width</span><span class="p">):</span>
  316. <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">height</span><span class="p">):</span>
  317. <span class="k">if</span> <span class="n">dim</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
  318. <span class="n">grey_value</span> <span class="o">=</span> <span class="mi">0</span>
  319. <span class="c1"># for each image we merge pixel values</span>
  320. <span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="n">images</span><span class="p">:</span>
  321. <span class="n">grey_value</span> <span class="o">+=</span> <span class="n">img</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span>
  322. <span class="n">image_mean</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="n">grey_value</span> <span class="o">/</span> <span class="n">nb_images</span>
  323. <span class="k">else</span><span class="p">:</span>
  324. <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">dim</span><span class="p">):</span>
  325. <span class="n">canal_value</span> <span class="o">=</span> <span class="mi">0</span>
  326. <span class="c1"># for each image we merge pixel values</span>
  327. <span class="k">for</span> <span class="n">img</span> <span class="ow">in</span> <span class="n">images</span><span class="p">:</span>
  328. <span class="n">canal_value</span> <span class="o">+=</span> <span class="n">img</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">][</span><span class="n">k</span><span class="p">]</span>
  329. <span class="n">image_mean</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">][</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">canal_value</span> <span class="o">/</span> <span class="n">nb_images</span>
  330. <span class="n">image_mean</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image_mean</span><span class="p">,</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  331. <span class="k">if</span> <span class="n">pil</span><span class="p">:</span>
  332. <span class="k">return</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">image_mean</span><span class="p">,</span> <span class="n">mode</span><span class="p">)</span>
  333. <span class="k">else</span><span class="p">:</span>
  334. <span class="k">return</span> <span class="n">image_mean</span></div>
  335. <div class="viewcode-block" id="rotate_image"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.rotate_image">[docs]</a><span class="k">def</span> <span class="nf">rotate_image</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">angle</span><span class="o">=</span><span class="mi">90</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  336. <span class="sd">&quot;&quot;&quot;Rotate image using specific angle</span>
  337. <span class="sd"> Args:</span>
  338. <span class="sd"> image: PIL Image or Numpy array</span>
  339. <span class="sd"> angle: Angle value of the rotation</span>
  340. <span class="sd"> pil: block type returned as PIL Image (default True)</span>
  341. <span class="sd"> Returns:</span>
  342. <span class="sd"> Image with rotation applied</span>
  343. <span class="sd"> Example:</span>
  344. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  345. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  346. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  347. <span class="sd"> &gt;&gt;&gt; image_values = Image.open(&#39;./images/test_img.png&#39;)</span>
  348. <span class="sd"> &gt;&gt;&gt; rotated_image = processing.rotate_image(image_values, 90, pil=False)</span>
  349. <span class="sd"> &gt;&gt;&gt; rotated_image.shape</span>
  350. <span class="sd"> (200, 200, 3)</span>
  351. <span class="sd"> &quot;&quot;&quot;</span>
  352. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;RGB&#39;</span>
  353. <span class="n">image_array</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">image</span><span class="p">)</span>
  354. <span class="k">if</span> <span class="n">image_array</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
  355. <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;L&#39;</span>
  356. <span class="n">rotated_image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span>
  357. <span class="n">transform</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="n">image_array</span><span class="p">,</span> <span class="n">angle</span><span class="p">)</span> <span class="o">*</span> <span class="mi">255</span><span class="p">,</span> <span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
  358. <span class="k">if</span> <span class="n">pil</span><span class="p">:</span>
  359. <span class="k">return</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">rotated_image</span><span class="p">,</span> <span class="n">mode</span><span class="p">)</span>
  360. <span class="k">else</span><span class="p">:</span>
  361. <span class="k">return</span> <span class="n">rotated_image</span></div>
  362. <div class="viewcode-block" id="get_mscn_coefficients"><a class="viewcode-back" href="../../ipfml/ipfml.processing.html#ipfml.processing.get_mscn_coefficients">[docs]</a><span class="k">def</span> <span class="nf">get_mscn_coefficients</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  363. <span class="sd">&quot;&quot;&quot;Compute the Mean Substracted Constrast Normalized coefficients of an image</span>
  364. <span class="sd"> Args:</span>
  365. <span class="sd"> image: PIL Image, Numpy array or path of image</span>
  366. <span class="sd"> Returns:</span>
  367. <span class="sd"> MSCN coefficients</span>
  368. <span class="sd"> Raises:</span>
  369. <span class="sd"> FileNotFoundError: If `image` is set as str path and image was not found</span>
  370. <span class="sd"> ValueError: If `image` numpy shape are not correct</span>
  371. <span class="sd"> Example:</span>
  372. <span class="sd"> &gt;&gt;&gt; from PIL import Image</span>
  373. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  374. <span class="sd"> &gt;&gt;&gt; from ipfml import processing</span>
  375. <span class="sd"> &gt;&gt;&gt; image_values = Image.open(&#39;./images/test_img.png&#39;)</span>
  376. <span class="sd"> &gt;&gt;&gt; mscn_coefficients = processing.get_mscn_coefficients(image_values)</span>
  377. <span class="sd"> &gt;&gt;&gt; mscn_coefficients.shape</span>
  378. <span class="sd"> (200, 200)</span>
  379. <span class="sd"> &quot;&quot;&quot;</span>
  380. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
  381. <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
  382. <span class="c1"># open image directly as grey level image</span>
  383. <span class="n">imdist</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
  384. <span class="k">else</span><span class="p">:</span>
  385. <span class="k">raise</span> <span class="ne">FileNotFoundError</span><span class="p">(</span><span class="s1">&#39;Image not found in your system&#39;</span><span class="p">)</span>
  386. <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">):</span>
  387. <span class="c1"># convert if necessary to grey level numpy array</span>
  388. <span class="k">if</span> <span class="n">image</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
  389. <span class="n">imdist</span> <span class="o">=</span> <span class="n">image</span>
  390. <span class="k">if</span> <span class="n">image</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
  391. <span class="n">imdist</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">cvtColor</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">cv2</span><span class="o">.</span><span class="n">COLOR_BGR2GRAY</span><span class="p">)</span>
  392. <span class="k">else</span><span class="p">:</span>
  393. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Incorrect image shape&#39;</span><span class="p">)</span>
  394. <span class="k">else</span><span class="p">:</span>
  395. <span class="c1"># if PIL Image</span>
  396. <span class="n">image</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">image</span><span class="p">)</span>
  397. <span class="k">if</span> <span class="n">image</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
  398. <span class="n">imdist</span> <span class="o">=</span> <span class="n">image</span>
  399. <span class="k">if</span> <span class="n">image</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
  400. <span class="n">imdist</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">cvtColor</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">cv2</span><span class="o">.</span><span class="n">COLOR_BGR2GRAY</span><span class="p">)</span>
  401. <span class="k">else</span><span class="p">:</span>
  402. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Incorrect image shape&#39;</span><span class="p">)</span>
  403. <span class="n">imdist</span> <span class="o">=</span> <span class="n">imdist</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
  404. <span class="n">imdist</span> <span class="o">=</span> <span class="n">imdist</span> <span class="o">/</span> <span class="mf">255.0</span>
  405. <span class="c1"># calculating MSCN coefficients</span>
  406. <span class="n">mu</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">GaussianBlur</span><span class="p">(</span>
  407. <span class="n">imdist</span><span class="p">,</span> <span class="p">(</span><span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">),</span> <span class="mi">7</span> <span class="o">/</span> <span class="mi">6</span><span class="p">,</span> <span class="n">borderType</span><span class="o">=</span><span class="n">cv2</span><span class="o">.</span><span class="n">BORDER_CONSTANT</span><span class="p">)</span>
  408. <span class="n">mu_sq</span> <span class="o">=</span> <span class="n">mu</span> <span class="o">*</span> <span class="n">mu</span>
  409. <span class="n">sigma</span> <span class="o">=</span> <span class="n">cv2</span><span class="o">.</span><span class="n">GaussianBlur</span><span class="p">(</span>
  410. <span class="n">imdist</span> <span class="o">*</span> <span class="n">imdist</span><span class="p">,</span> <span class="p">(</span><span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">),</span> <span class="mi">7</span> <span class="o">/</span> <span class="mi">6</span><span class="p">,</span> <span class="n">borderType</span><span class="o">=</span><span class="n">cv2</span><span class="o">.</span><span class="n">BORDER_CONSTANT</span><span class="p">)</span>
  411. <span class="n">sigma</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="nb">abs</span><span class="p">((</span><span class="n">sigma</span> <span class="o">-</span> <span class="n">mu_sq</span><span class="p">)))</span>
  412. <span class="n">structdis</span> <span class="o">=</span> <span class="p">(</span><span class="n">imdist</span> <span class="o">-</span> <span class="n">mu</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="n">sigma</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
  413. <span class="k">return</span> <span class="n">structdis</span></div>
  414. </pre></div>
  415. </div>
  416. </div>
  417. <footer>
  418. <hr/>
  419. <div role="contentinfo">
  420. <p>
  421. &copy; Copyright 2019, Jérôme BUISINE
  422. </p>
  423. </div>
  424. 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>.
  425. </footer>
  426. </div>
  427. </div>
  428. </section>
  429. </div>
  430. <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
  431. <script type="text/javascript" src="../../_static/jquery.js"></script>
  432. <script type="text/javascript" src="../../_static/underscore.js"></script>
  433. <script type="text/javascript" src="../../_static/doctools.js"></script>
  434. <script type="text/javascript" src="../../_static/language_data.js"></script>
  435. <script type="text/javascript" src="../../_static/js/theme.js"></script>
  436. <script type="text/javascript">
  437. jQuery(function () {
  438. SphinxRtdTheme.Navigation.enable(true);
  439. });
  440. </script>
  441. </body>
  442. </html>