Accueil Explorer Aide
Connexion
Prise3D
/
ipfml
2
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki
Aborescence: 0a094c396c
Branches Tags
ipfml
/
docs
/
build
/
html
/
ipfml.html

ipfml.html 96 KB
Historique Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   
    9. 

  9.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    10. 

  10.   
    11. 

  11.   <title>Documentation &mdash; IPFML v0.2.6 documentation</title>
    12. 

  12.   
    13. 

  13. 

  14.   
    15. 

  15.   
    16. 

  16.   
    17. 

  17.   
    18. 

  18. 

  19.   
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    28. 

  28.   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    29. 

  29.     <link rel="index" title="Index" href="genindex.html" />
    30. 

  30.     <link rel="search" title="Search" href="search.html" />
    31. 

  31.     <link rel="next" title="Examples" href="examples.html" />
    32. 

  32.     <link rel="prev" title="Description" href="description.html" /> 
    33. 

  33. 

  34.   
    35. 

  35.   <script src="_static/js/modernizr.min.js"></script>
    36. 

  36. 

  37. </head>
    38. 

  38. 

  39. <body class="wy-body-for-nav">
    40. 

  40. 

  41.    
    42. 

  42.   <div class="wy-grid-for-nav">
    43. 

  43. 

  44.     
    45. 

  45.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    46. 

  46.       <div class="wy-side-scroll">
    47. 

  47.         <div class="wy-side-nav-search">
    48. 

  48.           
    49. 

  49. 

  50.           
    51. 

  51.             <a href="index.html" class="icon icon-home"> IPFML
    52. 

  52.           
    53. 

  53. 

  54.           
    55. 

  55.           </a>
    56. 

  56. 

  57.           
    58. 

  58.             
    59. 

  59.             
    60. 

  60.               <div class="version">
    61. 

  61.                 0.2.6
    62. 

  62.               </div>
    63. 

  63.             
    64. 

  64.           
    65. 

  65. 

  66.           
    67. 

  67. <div role="search">
    68. 

  68.   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    69. 

  69.     <input type="text" name="q" placeholder="Search docs" />
    70. 

  70.     <input type="hidden" name="check_keywords" value="yes" />
    71. 

  71.     <input type="hidden" name="area" value="default" />
    72. 

  72.   </form>
    73. 

  73. </div>
    74. 

  74. 

  75.           
    76. 

  76.         </div>
    77. 

  77. 

  78.         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    79. 

  79.           
    80. 

  80.             
    81. 

  81.             
    82. 

  82.               
    83. 

  83.             
    84. 

  84.             
    85. 

  85.               <p class="caption"><span class="caption-text">Contents:</span></p>
    86. 

  86. <ul class="current">
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
    88. 

  88. <li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="#module-ipfml.metrics">ipfml.metrics</a></li>
    90. 

  90. <li class="toctree-l2"><a class="reference internal" href="#module-ipfml.processing">ipfml.processing</a></li>
    91. 

  91. <li class="toctree-l2"><a class="reference internal" href="#ipfml-filters">ipfml.filters</a><ul>
    92. 

  92. <li class="toctree-l3"><a class="reference internal" href="#module-ipfml.filters.noise">ipfml.filters.noise</a></li>
    93. 

  93. </ul>
    94. 

  94. </li>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="#ipfml-iqa">ipfml.iqa</a><ul>
    96. 

  96. <li class="toctree-l3"><a class="reference internal" href="#module-ipfml.iqa.fr">ipfml.iqa.fr</a></li>
    97. 

  97. </ul>
    98. 

  98. </li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="#module-ipfml.utils">ipfml.utils</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="#module-ipfml.exceptions">ipfml.exceptions</a></li>
    101. 

  101. </ul>
    102. 

  102. </li>
    103. 

  103. <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
    104. 

  104. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
    105. 

  105. </ul>
    106. 

  106. 

  107.             
    108. 

  108.           
    109. 

  109.         </div>
    110. 

  110.       </div>
    111. 

  111.     </nav>
    112. 

  112. 

  113.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    114. 

  114. 

  115.       
    116. 

  116.       <nav class="wy-nav-top" aria-label="top navigation">
    117. 

  117.         
    118. 

  118.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    119. 

  119.           <a href="index.html">IPFML</a>
    120. 

  120.         
    121. 

  121.       </nav>
    122. 

  122. 

  123. 

  124.       <div class="wy-nav-content">
    125. 

  125.         
    126. 

  126.         <div class="rst-content">
    127. 

  127.         
    128. 

  128.           
    129. 

  129. 

  130. 

  131. 

  132. 

  133. 

  134. 

  135. 

  136. 

  137. 

  138. 

  139. 

  140. 

  141. 

  142. 

  143. 

  144. <div role="navigation" aria-label="breadcrumbs navigation">
    145. 

  145. 

  146.   <ul class="wy-breadcrumbs">
    147. 

  147.     
    148. 

  148.       <li><a href="index.html">Docs</a> &raquo;</li>
    149. 

  149.         
    150. 

  150.       <li>Documentation</li>
    151. 

  151.     
    152. 

  152.     
    153. 

  153.       <li class="wy-breadcrumbs-aside">
    154. 

  154.         
    155. 

  155.             
    156. 

  156.             
    157. 

  157.               <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml.rst" class="fa fa-github"> Edit on GitHub</a>
    158. 

  158.             
    159. 

  159.           
    160. 

  160.         
    161. 

  161.       </li>
    162. 

  162.     
    163. 

  163.   </ul>
    164. 

  164. 

  165.   
    166. 

  166.   <hr/>
    167. 

  167. </div>
    168. 

  168.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    169. 

  169.            <div itemprop="articleBody">
    170. 

  170.             
    171. 

  171.   <div class="section" id="documentation">
    172. 

  172. <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
    173. 

  173. <div class="section" id="module-ipfml.metrics">
    174. 

  174. <span id="ipfml-metrics"></span><h2>ipfml.metrics<a class="headerlink" href="#module-ipfml.metrics" title="Permalink to this headline">¶</a></h2>
    175. 

  175. <dl class="function">
    176. 

  176. <dt id="ipfml.metrics.get_LAB">
    177. 

  177. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_LAB</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_LAB" title="Permalink to this definition">¶</a></dt>
    178. 

  178. <dd><p>Transforms RGB  Image into Lab</p>
    179. 

  179. <table class="docutils field-list" frame="void" rules="none">
    180. 

  180. <col class="field-name" />
    181. 

  181. <col class="field-body" />
    182. 

  182. <tbody valign="top">
    183. 

  183. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    184. 

  184. </tr>
    185. 

  185. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Lab information</td>
    186. 

  186. </tr>
    187. 

  187. </tbody>
    188. 

  188. </table>
    189. 

  189. <p>Usage:</p>
    190. 

  190. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    191. 

  191. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    192. 

  192. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    193. 

  193. <span class="gp">&gt;&gt;&gt; </span><span class="n">Lab</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    194. 

  194. <span class="gp">&gt;&gt;&gt; </span><span class="n">Lab</span><span class="o">.</span><span class="n">shape</span>
    195. 

  195. <span class="go">(200, 200, 3)</span>
    196. 

  196. </pre></div>
    197. 

  197. </div>
    198. 

  198. </dd></dl>
    199. 

  199. 

  200. <dl class="function">
    201. 

  201. <dt id="ipfml.metrics.get_LAB_L">
    202. 

  202. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_LAB_L</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_LAB_L" title="Permalink to this definition">¶</a></dt>
    203. 

  203. <dd><p>Transforms RGB Image into Lab and returns L</p>
    204. 

  204. <table class="docutils field-list" frame="void" rules="none">
    205. 

  205. <col class="field-name" />
    206. 

  206. <col class="field-body" />
    207. 

  207. <tbody valign="top">
    208. 

  208. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    209. 

  209. </tr>
    210. 

  210. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The L chanel from Lab information</td>
    211. 

  211. </tr>
    212. 

  212. </tbody>
    213. 

  213. </table>
    214. 

  214. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    215. 

  215. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    216. 

  216. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    217. 

  217. <span class="gp">&gt;&gt;&gt; </span><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">img</span><span class="p">)</span>
    218. 

  218. <span class="gp">&gt;&gt;&gt; </span><span class="n">L</span><span class="o">.</span><span class="n">shape</span>
    219. 

  219. <span class="go">(200, 200)</span>
    220. 

  220. </pre></div>
    221. 

  221. </div>
    222. 

  222. </dd></dl>
    223. 

  223. 

  224. <dl class="function">
    225. 

  225. <dt id="ipfml.metrics.get_LAB_a">
    226. 

  226. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_LAB_a</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_LAB_a" title="Permalink to this definition">¶</a></dt>
    227. 

  227. <dd><p>Transforms RGB Image into LAB and returns a</p>
    228. 

  228. <table class="docutils field-list" frame="void" rules="none">
    229. 

  229. <col class="field-name" />
    230. 

  230. <col class="field-body" />
    231. 

  231. <tbody valign="top">
    232. 

  232. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    233. 

  233. </tr>
    234. 

  234. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The a chanel from Lab information</td>
    235. 

  235. </tr>
    236. 

  236. </tbody>
    237. 

  237. </table>
    238. 

  238. <p>Usage:</p>
    239. 

  239. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    240. 

  240. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    241. 

  241. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    242. 

  242. <span class="gp">&gt;&gt;&gt; </span><span class="n">a</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_a</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    243. 

  243. <span class="gp">&gt;&gt;&gt; </span><span class="n">a</span><span class="o">.</span><span class="n">shape</span>
    244. 

  244. <span class="go">(200, 200)</span>
    245. 

  245. </pre></div>
    246. 

  246. </div>
    247. 

  247. </dd></dl>
    248. 

  248. 

  249. <dl class="function">
    250. 

  250. <dt id="ipfml.metrics.get_LAB_b">
    251. 

  251. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_LAB_b</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_LAB_b" title="Permalink to this definition">¶</a></dt>
    252. 

  252. <dd><p>Transforms RGB Image into LAB and returns b</p>
    253. 

  253. <table class="docutils field-list" frame="void" rules="none">
    254. 

  254. <col class="field-name" />
    255. 

  255. <col class="field-body" />
    256. 

  256. <tbody valign="top">
    257. 

  257. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    258. 

  258. </tr>
    259. 

  259. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The b chanel from Lab information</td>
    260. 

  260. </tr>
    261. 

  261. </tbody>
    262. 

  262. </table>
    263. 

  263. <p>Usage :</p>
    264. 

  264. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    265. 

  265. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    266. 

  266. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    267. 

  267. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_LAB_b</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    268. 

  268. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="o">.</span><span class="n">shape</span>
    269. 

  269. <span class="go">(200, 200)</span>
    270. 

  270. </pre></div>
    271. 

  271. </div>
    272. 

  272. </dd></dl>
    273. 

  273. 

  274. <dl class="function">
    275. 

  275. <dt id="ipfml.metrics.get_SVD">
    276. 

  276. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_SVD</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_SVD" title="Permalink to this definition">¶</a></dt>
    277. 

  277. <dd><p>Transforms Image using SVD compression</p>
    278. 

  278. <table class="docutils field-list" frame="void" rules="none">
    279. 

  279. <col class="field-name" />
    280. 

  280. <col class="field-body" />
    281. 

  281. <tbody valign="top">
    282. 

  282. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert into SVD compression</td>
    283. 

  283. </tr>
    284. 

  284. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U, s, V obtained from SVD compression</td>
    285. 

  285. </tr>
    286. 

  286. </tbody>
    287. 

  287. </table>
    288. 

  288. <p>Usage:</p>
    289. 

  289. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    290. 

  290. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    291. 

  291. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    292. 

  292. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">V</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    293. 

  293. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
    294. 

  294. <span class="go">(200, 200, 3)</span>
    295. 

  295. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
    296. 

  296. <span class="go">200</span>
    297. 

  297. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
    298. 

  298. <span class="go">(200, 3, 3)</span>
    299. 

  299. </pre></div>
    300. 

  300. </div>
    301. 

  301. </dd></dl>
    302. 

  302. 

  303. <dl class="function">
    304. 

  304. <dt id="ipfml.metrics.get_SVD_U">
    305. 

  305. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_SVD_U</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_SVD_U" title="Permalink to this definition">¶</a></dt>
    306. 

  306. <dd><p>Transforms Image into SVD and returns only ‘U’ part</p>
    307. 

  307. <table class="docutils field-list" frame="void" rules="none">
    308. 

  308. <col class="field-name" />
    309. 

  309. <col class="field-body" />
    310. 

  310. <tbody valign="top">
    311. 

  311. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    312. 

  312. </tr>
    313. 

  313. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U matrix from SVD compression</td>
    314. 

  314. </tr>
    315. 

  315. </tbody>
    316. 

  316. </table>
    317. 

  317. <p>Usage:</p>
    318. 

  318. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    319. 

  319. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    320. 

  320. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    321. 

  321. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_U</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    322. 

  322. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
    323. 

  323. <span class="go">(200, 200, 3)</span>
    324. 

  324. </pre></div>
    325. 

  325. </div>
    326. 

  326. </dd></dl>
    327. 

  327. 

  328. <dl class="function">
    329. 

  329. <dt id="ipfml.metrics.get_SVD_V">
    330. 

  330. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_SVD_V</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_SVD_V" title="Permalink to this definition">¶</a></dt>
    331. 

  331. <dd><p>Transforms Image into SVD and returns only ‘V’ part</p>
    332. 

  332. <table class="docutils field-list" frame="void" rules="none">
    333. 

  333. <col class="field-name" />
    334. 

  334. <col class="field-body" />
    335. 

  335. <tbody valign="top">
    336. 

  336. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    337. 

  337. </tr>
    338. 

  338. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">V matrix obtained from SVD compression</td>
    339. 

  339. </tr>
    340. 

  340. </tbody>
    341. 

  341. </table>
    342. 

  342. <p>Usage :</p>
    343. 

  343. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    344. 

  344. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    345. 

  345. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    346. 

  346. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_V</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    347. 

  347. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
    348. 

  348. <span class="go">(200, 3, 3)</span>
    349. 

  349. </pre></div>
    350. 

  350. </div>
    351. 

  351. </dd></dl>
    352. 

  352. 

  353. <dl class="function">
    354. 

  354. <dt id="ipfml.metrics.get_SVD_s">
    355. 

  355. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_SVD_s</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_SVD_s" title="Permalink to this definition">¶</a></dt>
    356. 

  356. <dd><p>Transforms Image into SVD and returns only ‘s’ part</p>
    357. 

  357. <table class="docutils field-list" frame="void" rules="none">
    358. 

  358. <col class="field-name" />
    359. 

  359. <col class="field-body" />
    360. 

  360. <tbody valign="top">
    361. 

  361. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    362. 

  362. </tr>
    363. 

  363. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">vector of singular values obtained from SVD compression</td>
    364. 

  364. </tr>
    365. 

  365. </tbody>
    366. 

  366. </table>
    367. 

  367. <p>Usage:</p>
    368. 

  368. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    369. 

  369. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    370. 

  370. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    371. 

  371. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_SVD_s</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    372. 

  372. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
    373. 

  373. <span class="go">200</span>
    374. 

  374. </pre></div>
    375. 

  375. </div>
    376. 

  376. </dd></dl>
    377. 

  377. 

  378. <dl class="function">
    379. 

  379. <dt id="ipfml.metrics.get_XYZ">
    380. 

  380. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_XYZ</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_XYZ" title="Permalink to this definition">¶</a></dt>
    381. 

  381. <dd><p>Transforms RGB Image into XYZ</p>
    382. 

  382. <table class="docutils field-list" frame="void" rules="none">
    383. 

  383. <col class="field-name" />
    384. 

  384. <col class="field-body" />
    385. 

  385. <tbody valign="top">
    386. 

  386. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    387. 

  387. </tr>
    388. 

  388. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">XYZ information obtained from transformation</td>
    389. 

  389. </tr>
    390. 

  390. </tbody>
    391. 

  391. </table>
    392. 

  392. <p>Usage:</p>
    393. 

  393. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    394. 

  394. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    395. 

  395. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    396. 

  396. <span class="gp">&gt;&gt;&gt; </span><span class="n">metrics</span><span class="o">.</span><span class="n">get_XYZ</span><span class="p">(</span><span class="n">img</span><span class="p">)</span><span class="o">.</span><span class="n">shape</span>
    397. 

  397. <span class="go">(200, 200, 3)</span>
    398. 

  398. </pre></div>
    399. 

  399. </div>
    400. 

  400. </dd></dl>
    401. 

  401. 

  402. <dl class="function">
    403. 

  403. <dt id="ipfml.metrics.get_XYZ_X">
    404. 

  404. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_XYZ_X</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_XYZ_X" title="Permalink to this definition">¶</a></dt>
    405. 

  405. <dd><p>Transforms RGB Image into XYZ and returns X</p>
    406. 

  406. <table class="docutils field-list" frame="void" rules="none">
    407. 

  407. <col class="field-name" />
    408. 

  408. <col class="field-body" />
    409. 

  409. <tbody valign="top">
    410. 

  410. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    411. 

  411. </tr>
    412. 

  412. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The X chanel from XYZ information</td>
    413. 

  413. </tr>
    414. 

  414. </tbody>
    415. 

  415. </table>
    416. 

  416. <p>Usage:</p>
    417. 

  417. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    418. 

  418. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    419. 

  419. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    420. 

  420. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_XYZ_X</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    421. 

  421. <span class="gp">&gt;&gt;&gt; </span><span class="n">x</span><span class="o">.</span><span class="n">shape</span>
    422. 

  422. <span class="go">(200, 200)</span>
    423. 

  423. </pre></div>
    424. 

  424. </div>
    425. 

  425. </dd></dl>
    426. 

  426. 

  427. <dl class="function">
    428. 

  428. <dt id="ipfml.metrics.get_XYZ_Y">
    429. 

  429. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_XYZ_Y</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_XYZ_Y" title="Permalink to this definition">¶</a></dt>
    430. 

  430. <dd><p>Transforms RGB Image into XYZ and returns Y</p>
    431. 

  431. <table class="docutils field-list" frame="void" rules="none">
    432. 

  432. <col class="field-name" />
    433. 

  433. <col class="field-body" />
    434. 

  434. <tbody valign="top">
    435. 

  435. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    436. 

  436. </tr>
    437. 

  437. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Y chanel from XYZ information</td>
    438. 

  438. </tr>
    439. 

  439. </tbody>
    440. 

  440. </table>
    441. 

  441. <p>Usage:</p>
    442. 

  442. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    443. 

  443. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    444. 

  444. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    445. 

  445. <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_XYZ_Y</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    446. 

  446. <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span><span class="o">.</span><span class="n">shape</span>
    447. 

  447. <span class="go">(200, 200)</span>
    448. 

  448. </pre></div>
    449. 

  449. </div>
    450. 

  450. </dd></dl>
    451. 

  451. 

  452. <dl class="function">
    453. 

  453. <dt id="ipfml.metrics.get_XYZ_Z">
    454. 

  454. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_XYZ_Z</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_XYZ_Z" title="Permalink to this definition">¶</a></dt>
    455. 

  455. <dd><p>Transforms RGB Image into XYZ and returns Z</p>
    456. 

  456. <table class="docutils field-list" frame="void" rules="none">
    457. 

  457. <col class="field-name" />
    458. 

  458. <col class="field-body" />
    459. 

  459. <tbody valign="top">
    460. 

  460. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
    461. 

  461. </tr>
    462. 

  462. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The Z chanel from XYZ information</td>
    463. 

  463. </tr>
    464. 

  464. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If <cite>nb_bits</cite> has unexpected value. <cite>nb_bits</cite> needs to be in interval [1, 8].</td>
    465. 

  465. </tr>
    466. 

  466. </tbody>
    467. 

  467. </table>
    468. 

  468. <p>Usage:</p>
    469. 

  469. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    470. 

  470. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    471. 

  471. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    472. 

  472. <span class="gp">&gt;&gt;&gt; </span><span class="n">z</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_XYZ_Z</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    473. 

  473. <span class="gp">&gt;&gt;&gt; </span><span class="n">z</span><span class="o">.</span><span class="n">shape</span>
    474. 

  474. <span class="go">(200, 200)</span>
    475. 

  475. </pre></div>
    476. 

  476. </div>
    477. 

  477. </dd></dl>
    478. 

  478. 

  479. <dl class="function">
    480. 

  480. <dt id="ipfml.metrics.get_bits_img">
    481. 

  481. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_bits_img</code><span class="sig-paren">(</span><em>image</em>, <em>interval</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_bits_img" title="Permalink to this definition">¶</a></dt>
    482. 

  482. <dd><p>Returns only bits specified into the interval</p>
    483. 

  483. <table class="docutils field-list" frame="void" rules="none">
    484. 

  484. <col class="field-name" />
    485. 

  485. <col class="field-body" />
    486. 

  486. <tbody valign="top">
    487. 

  487. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    488. 

  488. <li><strong>image</strong> – image to convert using this interval of bits value to keep</li>
    489. 

  489. <li><strong>interval</strong> – (begin, end) of bits values</li>
    490. 

  490. </ul>
    491. 

  491. </td>
    492. 

  492. </tr>
    493. 

  493. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Numpy array with reduced values</p>
    494. 

  494. </td>
    495. 

  495. </tr>
    496. 

  496. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
    497. 

  497. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If min value from interval is not &gt;= 1.</li>
    498. 

  498. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If max value from interval is not &lt;= 8.</li>
    499. 

  499. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If min value from interval &gt;= max value.</li>
    500. 

  500. </ul>
    501. 

  501. </td>
    502. 

  502. </tr>
    503. 

  503. </tbody>
    504. 

  504. </table>
    505. 

  505. <p>Usage:</p>
    506. 

  506. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    507. 

  507. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    508. 

  508. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    509. 

  509. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_img</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">get_bits_img</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span>
    510. 

  510. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_img</span><span class="o">.</span><span class="n">shape</span>
    511. 

  511. <span class="go">(200, 200, 3)</span>
    512. 

  512. </pre></div>
    513. 

  513. </div>
    514. 

  514. </dd></dl>
    515. 

  515. 

  516. <dl class="function">
    517. 

  517. <dt id="ipfml.metrics.get_low_bits_img">
    518. 

  518. <code class="descclassname">ipfml.metrics.</code><code class="descname">get_low_bits_img</code><span class="sig-paren">(</span><em>image</em>, <em>nb_bits=4</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.get_low_bits_img" title="Permalink to this definition">¶</a></dt>
    519. 

  519. <dd><p>Returns Image or Numpy array with data information reduced using only low bits</p>
    520. 

  520. <table class="docutils field-list" frame="void" rules="none">
    521. 

  521. <col class="field-name" />
    522. 

  522. <col class="field-body" />
    523. 

  523. <tbody valign="top">
    524. 

  524. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    525. 

  525. <li><strong>image</strong> – image to convert</li>
    526. 

  526. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep</li>
    527. 

  527. </ul>
    528. 

  528. </td>
    529. 

  529. </tr>
    530. 

  530. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Numpy array with reduced values</p>
    531. 

  531. </td>
    532. 

  532. </tr>
    533. 

  533. </tbody>
    534. 

  534. </table>
    535. 

  535. <p>Usage:</p>
    536. 

  536. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    537. 

  537. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    538. 

  538. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    539. 

  539. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_img</span> <span class="o">=</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">img</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
    540. 

  540. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_img</span><span class="o">.</span><span class="n">shape</span>
    541. 

  541. <span class="go">(200, 200, 3)</span>
    542. 

  542. </pre></div>
    543. 

  543. </div>
    544. 

  544. </dd></dl>
    545. 

  545. 

  546. <dl class="function">
    547. 

  547. <dt id="ipfml.metrics.gray_to_mscn">
    548. 

  548. <code class="descclassname">ipfml.metrics.</code><code class="descname">gray_to_mscn</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.metrics.gray_to_mscn" title="Permalink to this definition">¶</a></dt>
    549. 

  549. <dd><p>Convert Grayscale Image into Mean Subtracted Contrast Normalized (MSCN)</p>
    550. 

  550. <table class="docutils field-list" frame="void" rules="none">
    551. 

  551. <col class="field-name" />
    552. 

  552. <col class="field-body" />
    553. 

  553. <tbody valign="top">
    554. 

  554. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – grayscale image</td>
    555. 

  555. </tr>
    556. 

  556. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">MSCN matrix obtained from transformation</td>
    557. 

  557. </tr>
    558. 

  558. </tbody>
    559. 

  559. </table>
    560. 

  560. <p>Usage:</p>
    561. 

  561. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    562. 

  562. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    563. 

  563. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    564. 

  564. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_mscn</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    565. 

  565. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span><span class="o">.</span><span class="n">shape</span>
    566. 

  566. <span class="go">(200, 200)</span>
    567. 

  567. </pre></div>
    568. 

  568. </div>
    569. 

  569. </dd></dl>
    570. 

  570. 

  571. </div>
    572. 

  572. <div class="section" id="module-ipfml.processing">
    573. 

  573. <span id="ipfml-processing"></span><h2>ipfml.processing<a class="headerlink" href="#module-ipfml.processing" title="Permalink to this headline">¶</a></h2>
    574. 

  574. <dl class="function">
    575. 

  575. <dt id="ipfml.processing.divide_in_blocks">
    576. 

  576. <code class="descclassname">ipfml.processing.</code><code class="descname">divide_in_blocks</code><span class="sig-paren">(</span><em>image</em>, <em>block_size</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.divide_in_blocks" title="Permalink to this definition">¶</a></dt>
    577. 

  577. <dd><p>Divide image into equal size blocks</p>
    578. 

  578. <table class="docutils field-list" frame="void" rules="none">
    579. 

  579. <col class="field-name" />
    580. 

  580. <col class="field-body" />
    581. 

  581. <tbody valign="top">
    582. 

  582. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    583. 

  583. <li><strong>image</strong> – PIL Image or Numpy array</li>
    584. 

  584. <li><strong>block</strong> – tuple (width, height) representing the size of each dimension of the block</li>
    585. 

  585. <li><strong>pil</strong> – block type returned (default True)</li>
    586. 

  586. </ul>
    587. 

  587. </td>
    588. 

  588. </tr>
    589. 

  589. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list containing all 2D Numpy blocks (in RGB or not)</p>
    590. 

  590. </td>
    591. 

  591. </tr>
    592. 

  592. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If <cite>image_width</cite> or <cite>image_heigt</cite> are not compatible to produce correct block sizes</p>
    593. 

  593. </td>
    594. 

  594. </tr>
    595. 

  595. </tbody>
    596. 

  596. </table>
    597. 

  597. <p>Example:</p>
    598. 

  598. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    599. 

  599. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    600. 

  600. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    601. 

  601. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
    602. 

  602. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
    603. 

  603. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span> <span class="o">=</span> <span class="n">divide_in_blocks</span><span class="p">(</span><span class="n">image_values</span><span class="p">,</span> <span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">20</span><span class="p">))</span>
    604. 

  604. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">blocks</span><span class="p">)</span>
    605. 

  605. <span class="go">1600</span>
    606. 

  606. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">width</span>
    607. 

  607. <span class="go">20</span>
    608. 

  608. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">height</span>
    609. 

  609. <span class="go">20</span>
    610. 

  610. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_l</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    611. 

  611. <span class="gp">&gt;&gt;&gt; </span><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">img_l</span><span class="p">)</span>
    612. 

  612. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks_L</span> <span class="o">=</span> <span class="n">divide_in_blocks</span><span class="p">(</span><span class="n">L</span><span class="p">,</span> <span class="p">(</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    613. 

  613. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">blocks_L</span><span class="p">)</span>
    614. 

  614. <span class="go">4</span>
    615. 

  615. <span class="gp">&gt;&gt;&gt; </span><span class="n">blocks_L</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">width</span>
    616. 

  616. <span class="go">100</span>
    617. 

  617. </pre></div>
    618. 

  618. </div>
    619. 

  619. </dd></dl>
    620. 

  620. 

  621. <dl class="function">
    622. 

  622. <dt id="ipfml.processing.get_LAB_L_SVD">
    623. 

  623. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD" title="Permalink to this definition">¶</a></dt>
    624. 

  624. <dd><p>Returns Singular values from LAB L Image information</p>
    625. 

  625. <table class="docutils field-list" frame="void" rules="none">
    626. 

  626. <col class="field-name" />
    627. 

  627. <col class="field-body" />
    628. 

  628. <tbody valign="top">
    629. 

  629. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
    630. 

  630. </tr>
    631. 

  631. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U, s, V information obtained from SVD compression using Lab</td>
    632. 

  632. </tr>
    633. 

  633. </tbody>
    634. 

  634. </table>
    635. 

  635. <p>Example:</p>
    636. 

  636. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    637. 

  637. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    638. 

  638. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    639. 

  639. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">V</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    640. 

  640. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
    641. 

  641. <span class="go">(200, 200)</span>
    642. 

  642. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
    643. 

  643. <span class="go">200</span>
    644. 

  644. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
    645. 

  645. <span class="go">(200, 200)</span>
    646. 

  646. </pre></div>
    647. 

  647. </div>
    648. 

  648. </dd></dl>
    649. 

  649. 

  650. <dl class="function">
    651. 

  651. <dt id="ipfml.processing.get_LAB_L_SVD_U">
    652. 

  652. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_U</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_U" title="Permalink to this definition">¶</a></dt>
    653. 

  653. <dd><p>Returns U SVD from L of LAB Image information</p>
    654. 

  654. <table class="docutils field-list" frame="void" rules="none">
    655. 

  655. <col class="field-name" />
    656. 

  656. <col class="field-body" />
    657. 

  657. <tbody valign="top">
    658. 

  658. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
    659. 

  659. </tr>
    660. 

  660. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">U matrix of SVD compression</td>
    661. 

  661. </tr>
    662. 

  662. </tbody>
    663. 

  663. </table>
    664. 

  664. <p>Example:</p>
    665. 

  665. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    666. 

  666. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    667. 

  667. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    668. 

  668. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_U</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    669. 

  669. <span class="gp">&gt;&gt;&gt; </span><span class="n">U</span><span class="o">.</span><span class="n">shape</span>
    670. 

  670. <span class="go">(200, 200)</span>
    671. 

  671. </pre></div>
    672. 

  672. </div>
    673. 

  673. </dd></dl>
    674. 

  674. 

  675. <dl class="function">
    676. 

  676. <dt id="ipfml.processing.get_LAB_L_SVD_V">
    677. 

  677. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_V</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_V" title="Permalink to this definition">¶</a></dt>
    678. 

  678. <dd><p>Returns V SVD from L of LAB Image information</p>
    679. 

  679. <table class="docutils field-list" frame="void" rules="none">
    680. 

  680. <col class="field-name" />
    681. 

  681. <col class="field-body" />
    682. 

  682. <tbody valign="top">
    683. 

  683. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
    684. 

  684. </tr>
    685. 

  685. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">V matrix of SVD compression</td>
    686. 

  686. </tr>
    687. 

  687. </tbody>
    688. 

  688. </table>
    689. 

  689. <p>Example:</p>
    690. 

  690. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    691. 

  691. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    692. 

  692. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    693. 

  693. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_V</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    694. 

  694. <span class="gp">&gt;&gt;&gt; </span><span class="n">V</span><span class="o">.</span><span class="n">shape</span>
    695. 

  695. <span class="go">(200, 200)</span>
    696. 

  696. </pre></div>
    697. 

  697. </div>
    698. 

  698. </dd></dl>
    699. 

  699. 

  700. <dl class="function">
    701. 

  701. <dt id="ipfml.processing.get_LAB_L_SVD_s">
    702. 

  702. <code class="descclassname">ipfml.processing.</code><code class="descname">get_LAB_L_SVD_s</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.get_LAB_L_SVD_s" title="Permalink to this definition">¶</a></dt>
    703. 

  703. <dd><p>Returns s (Singular values) SVD from L of LAB Image information</p>
    704. 

  704. <table class="docutils field-list" frame="void" rules="none">
    705. 

  705. <col class="field-name" />
    706. 

  706. <col class="field-body" />
    707. 

  707. <tbody valign="top">
    708. 

  708. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – PIL Image or Numpy array</td>
    709. 

  709. </tr>
    710. 

  710. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">vector of singular values</td>
    711. 

  711. </tr>
    712. 

  712. </tbody>
    713. 

  713. </table>
    714. 

  714. <p>Example:</p>
    715. 

  715. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    716. 

  716. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    717. 

  717. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    718. 

  718. <span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_s</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    719. 

  719. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
    720. 

  720. <span class="go">200</span>
    721. 

  721. </pre></div>
    722. 

  722. </div>
    723. 

  723. </dd></dl>
    724. 

  724. 

  725. <dl class="function">
    726. 

  726. <dt id="ipfml.processing.rgb_to_LAB_L_bits">
    727. 

  727. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_LAB_L_bits</code><span class="sig-paren">(</span><em>image</em>, <em>interval</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.rgb_to_LAB_L_bits" title="Permalink to this definition">¶</a></dt>
    728. 

  728. <dd><p>Returns only bits from LAB L canal specified into the interval</p>
    729. 

  729. <table class="docutils field-list" frame="void" rules="none">
    730. 

  730. <col class="field-name" />
    731. 

  731. <col class="field-body" />
    732. 

  732. <tbody valign="top">
    733. 

  733. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    734. 

  734. <li><strong>image</strong> – image to convert using this interval of bits value to keep</li>
    735. 

  735. <li><strong>interval</strong> – (begin, end) of bits values</li>
    736. 

  736. </ul>
    737. 

  737. </td>
    738. 

  738. </tr>
    739. 

  739. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with reduced values</p>
    740. 

  740. </td>
    741. 

  741. </tr>
    742. 

  742. </tbody>
    743. 

  743. </table>
    744. 

  744. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    745. 

  745. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    746. 

  746. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    747. 

  747. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_LAB_L_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">6</span><span class="p">))</span>
    748. 

  748. <span class="gp">&gt;&gt;&gt; </span><span class="n">bits_Lab_l_img</span><span class="o">.</span><span class="n">shape</span>
    749. 

  749. <span class="go">(200, 200)</span>
    750. 

  750. </pre></div>
    751. 

  751. </div>
    752. 

  752. </dd></dl>
    753. 

  753. 

  754. <dl class="function">
    755. 

  755. <dt id="ipfml.processing.rgb_to_LAB_L_low_bits">
    756. 

  756. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_LAB_L_low_bits</code><span class="sig-paren">(</span><em>image</em>, <em>nb_bits=4</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.rgb_to_LAB_L_low_bits" title="Permalink to this definition">¶</a></dt>
    757. 

  757. <dd><p>Convert RGB Image into Lab L channel image using only 4 low bits values</p>
    758. 

  758. <table class="docutils field-list" frame="void" rules="none">
    759. 

  759. <col class="field-name" />
    760. 

  760. <col class="field-body" />
    761. 

  761. <tbody valign="top">
    762. 

  762. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    763. 

  763. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
    764. 

  764. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
    765. 

  765. </ul>
    766. 

  766. </td>
    767. 

  767. </tr>
    768. 

  768. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with low bits information kept</p>
    769. 

  769. </td>
    770. 

  770. </tr>
    771. 

  771. </tbody>
    772. 

  772. </table>
    773. 

  773. <p>Example:</p>
    774. 

  774. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    775. 

  775. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    776. 

  776. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    777. 

  777. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_Lab_l_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_LAB_L_low_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
    778. 

  778. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_Lab_l_img</span><span class="o">.</span><span class="n">shape</span>
    779. 

  779. <span class="go">(200, 200)</span>
    780. 

  780. </pre></div>
    781. 

  781. </div>
    782. 

  782. </dd></dl>
    783. 

  783. 

  784. <dl class="function">
    785. 

  785. <dt id="ipfml.processing.rgb_to_grey_low_bits">
    786. 

  786. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_grey_low_bits</code><span class="sig-paren">(</span><em>image</em>, <em>nb_bits=4</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.rgb_to_grey_low_bits" title="Permalink to this definition">¶</a></dt>
    787. 

  787. <dd><p>Convert RGB Image into grey image using only 4 low bits values</p>
    788. 

  788. <table class="docutils field-list" frame="void" rules="none">
    789. 

  789. <col class="field-name" />
    790. 

  790. <col class="field-body" />
    791. 

  791. <tbody valign="top">
    792. 

  792. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    793. 

  793. <li><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</li>
    794. 

  794. <li><strong>nb_bits</strong> – optional parameter which indicates the number of bits to keep (default 4)</li>
    795. 

  795. </ul>
    796. 

  796. </td>
    797. 

  797. </tr>
    798. 

  798. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with low bits information kept</p>
    799. 

  799. </td>
    800. 

  800. </tr>
    801. 

  801. </tbody>
    802. 

  802. </table>
    803. 

  803. <p>Example:</p>
    804. 

  804. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    805. 

  805. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    806. 

  806. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    807. 

  807. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_img</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_grey_low_bits</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
    808. 

  808. <span class="gp">&gt;&gt;&gt; </span><span class="n">low_bits_grey_img</span><span class="o">.</span><span class="n">shape</span>
    809. 

  809. <span class="go">(200, 200)</span>
    810. 

  810. </pre></div>
    811. 

  811. </div>
    812. 

  812. </dd></dl>
    813. 

  813. 

  814. <dl class="function">
    815. 

  815. <dt id="ipfml.processing.rgb_to_mscn">
    816. 

  816. <code class="descclassname">ipfml.processing.</code><code class="descname">rgb_to_mscn</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.processing.rgb_to_mscn" title="Permalink to this definition">¶</a></dt>
    817. 

  817. <dd><p>Convert RGB Image into Mean Subtracted Contrast Normalized (MSCN)</p>
    818. 

  818. <table class="docutils field-list" frame="void" rules="none">
    819. 

  819. <col class="field-name" />
    820. 

  820. <col class="field-body" />
    821. 

  821. <tbody valign="top">
    822. 

  822. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – 3D RGB image Numpy array or PIL RGB image</td>
    823. 

  823. </tr>
    824. 

  824. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">2D Numpy array with MSCN information</td>
    825. 

  825. </tr>
    826. 

  826. </tbody>
    827. 

  827. </table>
    828. 

  828. <p>Example:</p>
    829. 

  829. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    830. 

  830. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    831. 

  831. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    832. 

  832. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_mscn</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    833. 

  833. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span><span class="o">.</span><span class="n">shape</span>
    834. 

  834. <span class="go">(200, 200)</span>
    835. 

  835. </pre></div>
    836. 

  836. </div>
    837. 

  837. </dd></dl>
    838. 

  838. 

  839. </div>
    840. 

  840. <div class="section" id="ipfml-filters">
    841. 

  841. <h2>ipfml.filters<a class="headerlink" href="#ipfml-filters" title="Permalink to this headline">¶</a></h2>
    842. 

  842. <div class="section" id="module-ipfml.filters.noise">
    843. 

  843. <span id="ipfml-filters-noise"></span><h3>ipfml.filters.noise<a class="headerlink" href="#module-ipfml.filters.noise" title="Permalink to this headline">¶</a></h3>
    844. 

  844. <dl class="function">
    845. 

  845. <dt id="ipfml.filters.noise.cauchy_noise">
    846. 

  846. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">cauchy_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(0</em>, <em>1)</em>, <em>k=0.0002</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.cauchy_noise" title="Permalink to this definition">¶</a></dt>
    847. 

  847. <dd><p>Cauchy noise filter to apply on image</p>
    848. 

  848. <table class="docutils field-list" frame="void" rules="none">
    849. 

  849. <col class="field-name" />
    850. 

  850. <col class="field-body" />
    851. 

  851. <tbody valign="top">
    852. 

  852. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    853. 

  853. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    854. 

  854. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    855. 

  855. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    856. 

  856. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (0, 1))</li>
    857. 

  857. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.0002)</li>
    858. 

  858. </ul>
    859. 

  859. </td>
    860. 

  860. </tr>
    861. 

  861. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with Cauchy noise applied</p>
    862. 

  862. </td>
    863. 

  863. </tr>
    864. 

  864. </tbody>
    865. 

  865. </table>
    866. 

  866. <p>Example:</p>
    867. 

  867. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">cauchy_noise</span>
    868. 

  868. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    869. 

  869. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    870. 

  870. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">cauchy_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    871. 

  871. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    872. 

  872. <span class="go">(100, 100)</span>
    873. 

  873. </pre></div>
    874. 

  874. </div>
    875. 

  875. </dd></dl>
    876. 

  876. 

  877. <dl class="function">
    878. 

  878. <dt id="ipfml.filters.noise.gaussian_noise">
    879. 

  879. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">gaussian_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(0</em>, <em>1)</em>, <em>k=0.1</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.gaussian_noise" title="Permalink to this definition">¶</a></dt>
    880. 

  880. <dd><p>Gaussian noise filter to apply on image</p>
    881. 

  881. <table class="docutils field-list" frame="void" rules="none">
    882. 

  882. <col class="field-name" />
    883. 

  883. <col class="field-body" />
    884. 

  884. <tbody valign="top">
    885. 

  885. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    886. 

  886. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    887. 

  887. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    888. 

  888. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    889. 

  889. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (0, 1))</li>
    890. 

  890. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.1)</li>
    891. 

  891. </ul>
    892. 

  892. </td>
    893. 

  893. </tr>
    894. 

  894. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with gaussian noise applied</p>
    895. 

  895. </td>
    896. 

  896. </tr>
    897. 

  897. </tbody>
    898. 

  898. </table>
    899. 

  899. <p>Example:</p>
    900. 

  900. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">gaussian_noise</span>
    901. 

  901. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    902. 

  902. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    903. 

  903. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">gaussian_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    904. 

  904. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    905. 

  905. <span class="go">(100, 100)</span>
    906. 

  906. </pre></div>
    907. 

  907. </div>
    908. 

  908. </dd></dl>
    909. 

  909. 

  910. <dl class="function">
    911. 

  911. <dt id="ipfml.filters.noise.laplace_noise">
    912. 

  912. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">laplace_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(0</em>, <em>1)</em>, <em>k=0.1</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.laplace_noise" title="Permalink to this definition">¶</a></dt>
    913. 

  913. <dd><p>Laplace noise filter to apply on image</p>
    914. 

  914. <table class="docutils field-list" frame="void" rules="none">
    915. 

  915. <col class="field-name" />
    916. 

  916. <col class="field-body" />
    917. 

  917. <tbody valign="top">
    918. 

  918. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    919. 

  919. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    920. 

  920. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    921. 

  921. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    922. 

  922. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (0, 1))</li>
    923. 

  923. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.1)</li>
    924. 

  924. </ul>
    925. 

  925. </td>
    926. 

  926. </tr>
    927. 

  927. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpay array with Laplace noise applied</p>
    928. 

  928. </td>
    929. 

  929. </tr>
    930. 

  930. </tbody>
    931. 

  931. </table>
    932. 

  932. <p>Example:</p>
    933. 

  933. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">laplace_noise</span>
    934. 

  934. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    935. 

  935. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    936. 

  936. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">laplace_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    937. 

  937. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    938. 

  938. <span class="go">(100, 100)</span>
    939. 

  939. </pre></div>
    940. 

  940. </div>
    941. 

  941. </dd></dl>
    942. 

  942. 

  943. <dl class="function">
    944. 

  944. <dt id="ipfml.filters.noise.log_normal_noise">
    945. 

  945. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">log_normal_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(0</em>, <em>1)</em>, <em>k=0.05</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.log_normal_noise" title="Permalink to this definition">¶</a></dt>
    946. 

  946. <dd><p>Log-normal noise filter to apply on image</p>
    947. 

  947. <table class="docutils field-list" frame="void" rules="none">
    948. 

  948. <col class="field-name" />
    949. 

  949. <col class="field-body" />
    950. 

  950. <tbody valign="top">
    951. 

  951. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    952. 

  952. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    953. 

  953. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    954. 

  954. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    955. 

  955. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (0, 1))</li>
    956. 

  956. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.05)</li>
    957. 

  957. </ul>
    958. 

  958. </td>
    959. 

  959. </tr>
    960. 

  960. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with Log-normal noise applied</p>
    961. 

  961. </td>
    962. 

  962. </tr>
    963. 

  963. </tbody>
    964. 

  964. </table>
    965. 

  965. <p>Example:</p>
    966. 

  966. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">log_normal_noise</span>
    967. 

  967. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    968. 

  968. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    969. 

  969. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">log_normal_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    970. 

  970. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    971. 

  971. <span class="go">(100, 100)</span>
    972. 

  972. </pre></div>
    973. 

  973. </div>
    974. 

  974. </dd></dl>
    975. 

  975. 

  976. <dl class="function">
    977. 

  977. <dt id="ipfml.filters.noise.mut_white_noise">
    978. 

  978. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">mut_white_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(0</em>, <em>1)</em>, <em>k=0.002</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.mut_white_noise" title="Permalink to this definition">¶</a></dt>
    979. 

  979. <dd><p>Multiplied White noise filter to apply on image</p>
    980. 

  980. <table class="docutils field-list" frame="void" rules="none">
    981. 

  981. <col class="field-name" />
    982. 

  982. <col class="field-body" />
    983. 

  983. <tbody valign="top">
    984. 

  984. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    985. 

  985. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    986. 

  986. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    987. 

  987. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    988. 

  988. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (0, 1))</li>
    989. 

  989. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.002)</li>
    990. 

  990. </ul>
    991. 

  991. </td>
    992. 

  992. </tr>
    993. 

  993. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with multiplied white noise applied</p>
    994. 

  994. </td>
    995. 

  995. </tr>
    996. 

  996. </tbody>
    997. 

  997. </table>
    998. 

  998. <p>Example:</p>
    999. 

  999. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">mut_white_noise</span>
    1000. 

  1000. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1001. 

  1001. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    1002. 

  1002. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">mut_white_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1003. 

  1003. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    1004. 

  1004. <span class="go">(100, 100)</span>
    1005. 

  1005. </pre></div>
    1006. 

  1006. </div>
    1007. 

  1007. </dd></dl>
    1008. 

  1008. 

  1009. <dl class="function">
    1010. 

  1010. <dt id="ipfml.filters.noise.salt_pepper_noise">
    1011. 

  1011. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">salt_pepper_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>p=0.1</em>, <em>k=0.5</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.salt_pepper_noise" title="Permalink to this definition">¶</a></dt>
    1012. 

  1012. <dd><p>Pepper salt noise filter to apply on image</p>
    1013. 

  1013. <table class="docutils field-list" frame="void" rules="none">
    1014. 

  1014. <col class="field-name" />
    1015. 

  1015. <col class="field-body" />
    1016. 

  1016. <tbody valign="top">
    1017. 

  1017. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1018. 

  1018. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    1019. 

  1019. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    1020. 

  1020. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    1021. 

  1021. <li><strong>p</strong> – probability to increase pixel value otherwise decrease it</li>
    1022. 

  1022. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.5)</li>
    1023. 

  1023. </ul>
    1024. 

  1024. </td>
    1025. 

  1025. </tr>
    1026. 

  1026. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with salt and pepper noise applied</p>
    1027. 

  1027. </td>
    1028. 

  1028. </tr>
    1029. 

  1029. </tbody>
    1030. 

  1030. </table>
    1031. 

  1031. <p>Example:</p>
    1032. 

  1032. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">salt_pepper_noise</span>
    1033. 

  1033. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1034. 

  1034. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    1035. 

  1035. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">salt_pepper_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1036. 

  1036. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    1037. 

  1037. <span class="go">(100, 100)</span>
    1038. 

  1038. </pre></div>
    1039. 

  1039. </div>
    1040. 

  1040. </dd></dl>
    1041. 

  1041. 

  1042. <dl class="function">
    1043. 

  1043. <dt id="ipfml.filters.noise.white_noise">
    1044. 

  1044. <code class="descclassname">ipfml.filters.noise.</code><code class="descname">white_noise</code><span class="sig-paren">(</span><em>image</em>, <em>n</em>, <em>identical=False</em>, <em>distribution_interval=(-0.5</em>, <em>0.5)</em>, <em>k=0.2</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.filters.noise.white_noise" title="Permalink to this definition">¶</a></dt>
    1045. 

  1045. <dd><p>White noise filter to apply on image</p>
    1046. 

  1046. <table class="docutils field-list" frame="void" rules="none">
    1047. 

  1047. <col class="field-name" />
    1048. 

  1048. <col class="field-body" />
    1049. 

  1049. <tbody valign="top">
    1050. 

  1050. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1051. 

  1051. <li><strong>image</strong> – image used as input (2D or 3D image representation)</li>
    1052. 

  1052. <li><strong>n</strong> – used to set importance of noise [1, 999]</li>
    1053. 

  1053. <li><strong>identical</strong> – keep or not identical noise distribution for each canal if RGB Image (default False)</li>
    1054. 

  1054. <li><strong>distribution_interval</strong> – set the distribution interval of normal law distribution (default (-0.5, 0.5))</li>
    1055. 

  1055. <li><strong>k</strong> – variable that specifies the amount of noise to be taken into account in the output image (default 0.2)</li>
    1056. 

  1056. </ul>
    1057. 

  1057. </td>
    1058. 

  1058. </tr>
    1059. 

  1059. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D Numpy array with white noise applied</p>
    1060. 

  1060. </td>
    1061. 

  1061. </tr>
    1062. 

  1062. </tbody>
    1063. 

  1063. </table>
    1064. 

  1064. <p>Example:</p>
    1065. 

  1065. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.noise</span> <span class="k">import</span> <span class="n">white_noise</span>
    1066. 

  1066. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1067. 

  1067. <span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">255</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">))</span>
    1068. 

  1068. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span> <span class="o">=</span> <span class="n">white_noise</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1069. 

  1069. <span class="gp">&gt;&gt;&gt; </span><span class="n">noisy_image</span><span class="o">.</span><span class="n">shape</span>
    1070. 

  1070. <span class="go">(100, 100)</span>
    1071. 

  1071. </pre></div>
    1072. 

  1072. </div>
    1073. 

  1073. </dd></dl>
    1074. 

  1074. 

  1075. </div>
    1076. 

  1076. </div>
    1077. 

  1077. <div class="section" id="ipfml-iqa">
    1078. 

  1078. <h2>ipfml.iqa<a class="headerlink" href="#ipfml-iqa" title="Permalink to this headline">¶</a></h2>
    1079. 

  1079. <div class="section" id="module-ipfml.iqa.fr">
    1080. 

  1080. <span id="ipfml-iqa-fr"></span><h3>ipfml.iqa.fr<a class="headerlink" href="#module-ipfml.iqa.fr" title="Permalink to this headline">¶</a></h3>
    1081. 

  1081. <dl class="function">
    1082. 

  1082. <dt id="ipfml.iqa.fr.mae">
    1083. 

  1083. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">mae</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.mae" title="Permalink to this definition">¶</a></dt>
    1084. 

  1084. <dd><p>Returns Mean-Squared Error between two Numpy arrays</p>
    1085. 

  1085. <table class="docutils field-list" frame="void" rules="none">
    1086. 

  1086. <col class="field-name" />
    1087. 

  1087. <col class="field-body" />
    1088. 

  1088. <tbody valign="top">
    1089. 

  1089. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1090. 

  1090. <li><strong>img_true</strong> – Image, numpy array of any dimension</li>
    1091. 

  1091. <li><strong>img_test</strong> – Image, numpy array of any dimension</li>
    1092. 

  1092. </ul>
    1093. 

  1093. </td>
    1094. 

  1094. </tr>
    1095. 

  1095. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Computed MSE score</p>
    1096. 

  1096. </td>
    1097. 

  1097. </tr>
    1098. 

  1098. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NumpyShapeComparisonException</span></code> – if shape of images are not the same</p>
    1099. 

  1099. </td>
    1100. 

  1100. </tr>
    1101. 

  1101. </tbody>
    1102. 

  1102. </table>
    1103. 

  1103. <p class="rubric">Example</p>
    1104. 

  1104. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">utils</span>
    1105. 

  1105. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1106. 

  1106. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
    1107. 

  1107. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1108. 

  1108. <span class="gp">&gt;&gt;&gt; </span><span class="n">mse</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">mse</span><span class="p">(</span><span class="n">arr1</span><span class="p">,</span> <span class="n">arr2</span><span class="p">)</span>
    1109. 

  1109. <span class="gp">&gt;&gt;&gt; </span><span class="n">mse</span>
    1110. 

  1110. <span class="go">100</span>
    1111. 

  1111. </pre></div>
    1112. 

  1112. </div>
    1113. 

  1113. </dd></dl>
    1114. 

  1114. 

  1115. <dl class="function">
    1116. 

  1116. <dt id="ipfml.iqa.fr.ms_ssim">
    1117. 

  1117. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">ms_ssim</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.ms_ssim" title="Permalink to this definition">¶</a></dt>
    1118. 

  1118. <dd><p>Implemented later..</p>
    1119. 

  1119. </dd></dl>
    1120. 

  1120. 

  1121. <dl class="function">
    1122. 

  1122. <dt id="ipfml.iqa.fr.mse">
    1123. 

  1123. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">mse</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.mse" title="Permalink to this definition">¶</a></dt>
    1124. 

  1124. <dd><p>Returns Mean-Squared Error between two Numpy arrays</p>
    1125. 

  1125. <table class="docutils field-list" frame="void" rules="none">
    1126. 

  1126. <col class="field-name" />
    1127. 

  1127. <col class="field-body" />
    1128. 

  1128. <tbody valign="top">
    1129. 

  1129. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1130. 

  1130. <li><strong>img_true</strong> – Image, numpy array of any dimension</li>
    1131. 

  1131. <li><strong>img_test</strong> – Image, numpy array of any dimension</li>
    1132. 

  1132. </ul>
    1133. 

  1133. </td>
    1134. 

  1134. </tr>
    1135. 

  1135. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Computed MSE score</p>
    1136. 

  1136. </td>
    1137. 

  1137. </tr>
    1138. 

  1138. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NumpyShapeComparisonException</span></code> – if shape of images are not the same</p>
    1139. 

  1139. </td>
    1140. 

  1140. </tr>
    1141. 

  1141. </tbody>
    1142. 

  1142. </table>
    1143. 

  1143. <p class="rubric">Example</p>
    1144. 

  1144. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">utils</span>
    1145. 

  1145. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1146. 

  1146. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
    1147. 

  1147. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1148. 

  1148. <span class="gp">&gt;&gt;&gt; </span><span class="n">mse</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">mse</span><span class="p">(</span><span class="n">arr1</span><span class="p">,</span> <span class="n">arr2</span><span class="p">)</span>
    1149. 

  1149. <span class="gp">&gt;&gt;&gt; </span><span class="n">mse</span>
    1150. 

  1150. <span class="go">100</span>
    1151. 

  1151. </pre></div>
    1152. 

  1152. </div>
    1153. 

  1153. </dd></dl>
    1154. 

  1154. 

  1155. <dl class="function">
    1156. 

  1156. <dt id="ipfml.iqa.fr.pnsr">
    1157. 

  1157. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">pnsr</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.pnsr" title="Permalink to this definition">¶</a></dt>
    1158. 

  1158. <dd><p>Returns the computed Peak Signal to Noise Ratio (PSNR) between two images</p>
    1159. 

  1159. <table class="docutils field-list" frame="void" rules="none">
    1160. 

  1160. <col class="field-name" />
    1161. 

  1161. <col class="field-body" />
    1162. 

  1162. <tbody valign="top">
    1163. 

  1163. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1164. 

  1164. <li><strong>img_true</strong> – Image, numpy array of any dimension</li>
    1165. 

  1165. <li><strong>img_test</strong> – Image, numpy array of any dimension</li>
    1166. 

  1166. </ul>
    1167. 

  1167. </td>
    1168. 

  1168. </tr>
    1169. 

  1169. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Computed PSNR score</p>
    1170. 

  1170. </td>
    1171. 

  1171. </tr>
    1172. 

  1172. </tbody>
    1173. 

  1173. </table>
    1174. 

  1174. </dd></dl>
    1175. 

  1175. 

  1176. <dl class="function">
    1177. 

  1177. <dt id="ipfml.iqa.fr.rmse">
    1178. 

  1178. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">rmse</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.rmse" title="Permalink to this definition">¶</a></dt>
    1179. 

  1179. <dd><p>Returns Mean-Squared Error between two Numpy arrays</p>
    1180. 

  1180. <table class="docutils field-list" frame="void" rules="none">
    1181. 

  1181. <col class="field-name" />
    1182. 

  1182. <col class="field-body" />
    1183. 

  1183. <tbody valign="top">
    1184. 

  1184. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1185. 

  1185. <li><strong>img_true</strong> – Image, numpy array of any dimension</li>
    1186. 

  1186. <li><strong>img_test</strong> – Image, numpy array of any dimension</li>
    1187. 

  1187. </ul>
    1188. 

  1188. </td>
    1189. 

  1189. </tr>
    1190. 

  1190. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Computed MSE score</p>
    1191. 

  1191. </td>
    1192. 

  1192. </tr>
    1193. 

  1193. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NumpyShapeComparisonException</span></code> – if shape of images are not the same</p>
    1194. 

  1194. </td>
    1195. 

  1195. </tr>
    1196. 

  1196. </tbody>
    1197. 

  1197. </table>
    1198. 

  1198. <p class="rubric">Example</p>
    1199. 

  1199. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">utils</span>
    1200. 

  1200. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1201. 

  1201. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
    1202. 

  1202. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
    1203. 

  1203. <span class="gp">&gt;&gt;&gt; </span><span class="n">rmse</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">rmse</span><span class="p">(</span><span class="n">arr1</span><span class="p">,</span> <span class="n">arr2</span><span class="p">)</span>
    1204. 

  1204. <span class="gp">&gt;&gt;&gt; </span><span class="n">rmse</span>
    1205. 

  1205. <span class="go">100</span>
    1206. 

  1206. </pre></div>
    1207. 

  1207. </div>
    1208. 

  1208. </dd></dl>
    1209. 

  1209. 

  1210. <dl class="function">
    1211. 

  1211. <dt id="ipfml.iqa.fr.vif">
    1212. 

  1212. <code class="descclassname">ipfml.iqa.fr.</code><code class="descname">vif</code><span class="sig-paren">(</span><em>img_true</em>, <em>img_test</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.iqa.fr.vif" title="Permalink to this definition">¶</a></dt>
    1213. 

  1213. <dd><p>Implemented later..</p>
    1214. 

  1214. </dd></dl>
    1215. 

  1215. 

  1216. </div>
    1217. 

  1217. </div>
    1218. 

  1218. <div class="section" id="module-ipfml.utils">
    1219. 

  1219. <span id="ipfml-utils"></span><h2>ipfml.utils<a class="headerlink" href="#module-ipfml.utils" title="Permalink to this headline">¶</a></h2>
    1220. 

  1220. <dl class="function">
    1221. 

  1221. <dt id="ipfml.utils.normalize_2D_arr">
    1222. 

  1222. <code class="descclassname">ipfml.utils.</code><code class="descname">normalize_2D_arr</code><span class="sig-paren">(</span><em>arr</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.utils.normalize_2D_arr" title="Permalink to this definition">¶</a></dt>
    1223. 

  1223. <dd><p>Return array normalize from its min and max values</p>
    1224. 

  1224. <table class="docutils field-list" frame="void" rules="none">
    1225. 

  1225. <col class="field-name" />
    1226. 

  1226. <col class="field-body" />
    1227. 

  1227. <tbody valign="top">
    1228. 

  1228. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> – 2D Numpy array</td>
    1229. 

  1229. </tr>
    1230. 

  1230. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Normalized 2D Numpy array</td>
    1231. 

  1231. </tr>
    1232. 

  1232. </tbody>
    1233. 

  1233. </table>
    1234. 

  1234. <p>Example:</p>
    1235. 

  1235. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
    1236. 

  1236. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">utils</span><span class="p">,</span> <span class="n">processing</span>
    1237. 

  1237. <span class="gp">&gt;&gt;&gt; </span><span class="n">img</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
    1238. 

  1238. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_mscn</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">rgb_to_mscn</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
    1239. 

  1239. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_normalized</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">normalize_2D_arr</span><span class="p">(</span><span class="n">img_mscn</span><span class="p">)</span>
    1240. 

  1240. <span class="gp">&gt;&gt;&gt; </span><span class="n">img_normalized</span><span class="o">.</span><span class="n">shape</span>
    1241. 

  1241. <span class="go">(200, 200)</span>
    1242. 

  1242. </pre></div>
    1243. 

  1243. </div>
    1244. 

  1244. </dd></dl>
    1245. 

  1245. 

  1246. <dl class="function">
    1247. 

  1247. <dt id="ipfml.utils.normalize_arr">
    1248. 

  1248. <code class="descclassname">ipfml.utils.</code><code class="descname">normalize_arr</code><span class="sig-paren">(</span><em>arr</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.utils.normalize_arr" title="Permalink to this definition">¶</a></dt>
    1249. 

  1249. <dd><p>Normalize data of 1D array shape</p>
    1250. 

  1250. <table class="docutils field-list" frame="void" rules="none">
    1251. 

  1251. <col class="field-name" />
    1252. 

  1252. <col class="field-body" />
    1253. 

  1253. <tbody valign="top">
    1254. 

  1254. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> – array data of 1D shape</td>
    1255. 

  1255. </tr>
    1256. 

  1256. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Normalized 1D array</td>
    1257. 

  1257. </tr>
    1258. 

  1258. </tbody>
    1259. 

  1259. </table>
    1260. 

  1260. <p>Example:</p>
    1261. 

  1261. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">utils</span>
    1262. 

  1262. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1263. 

  1263. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">11</span><span class="p">)</span>
    1264. 

  1264. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr_normalized</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">normalize_arr</span><span class="p">(</span><span class="n">arr</span><span class="p">)</span>
    1265. 

  1265. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr_normalized</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
    1266. 

  1266. <span class="go">0.1</span>
    1267. 

  1267. </pre></div>
    1268. 

  1268. </div>
    1269. 

  1269. </dd></dl>
    1270. 

  1270. 

  1271. <dl class="function">
    1272. 

  1272. <dt id="ipfml.utils.normalize_arr_with_range">
    1273. 

  1273. <code class="descclassname">ipfml.utils.</code><code class="descname">normalize_arr_with_range</code><span class="sig-paren">(</span><em>arr</em>, <em>min</em>, <em>max</em><span class="sig-paren">)</span><a class="headerlink" href="#ipfml.utils.normalize_arr_with_range" title="Permalink to this definition">¶</a></dt>
    1274. 

  1274. <dd><p>Normalize data of 1D array shape</p>
    1275. 

  1275. <table class="docutils field-list" frame="void" rules="none">
    1276. 

  1276. <col class="field-name" />
    1277. 

  1277. <col class="field-body" />
    1278. 

  1278. <tbody valign="top">
    1279. 

  1279. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> – array data of 1D shape</td>
    1280. 

  1280. </tr>
    1281. 

  1281. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Normalized 1D Numpy array</td>
    1282. 

  1282. </tr>
    1283. 

  1283. </tbody>
    1284. 

  1284. </table>
    1285. 

  1285. <p>Example:</p>
    1286. 

  1286. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
    1287. 

  1287. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    1288. 

  1288. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">11</span><span class="p">)</span>
    1289. 

  1289. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr_normalized</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">normalize_arr_with_range</span><span class="p">(</span><span class="n">arr</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>
    1290. 

  1290. <span class="gp">&gt;&gt;&gt; </span><span class="n">arr_normalized</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
    1291. 

  1291. <span class="go">0.05</span>
    1292. 

  1292. </pre></div>
    1293. 

  1293. </div>
    1294. 

  1294. </dd></dl>
    1295. 

  1295. 

  1296. </div>
    1297. 

  1297. <div class="section" id="module-ipfml.exceptions">
    1298. 

  1298. <span id="ipfml-exceptions"></span><h2>ipfml.exceptions<a class="headerlink" href="#module-ipfml.exceptions" title="Permalink to this headline">¶</a></h2>
    1299. 

  1299. <p>Module which contains all customs Exceptions</p>
    1300. 

  1300. <dl class="exception">
    1301. 

  1301. <dt id="ipfml.exceptions.NumpyDimensionComparisonException">
    1302. 

  1302. <em class="property">exception </em><code class="descclassname">ipfml.exceptions.</code><code class="descname">NumpyDimensionComparisonException</code><a class="headerlink" href="#ipfml.exceptions.NumpyDimensionComparisonException" title="Permalink to this definition">¶</a></dt>
    1303. 

  1303. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
    1304. 

  1304. <p>Numpy dimensions comparison Exception raised if two numpy arrays provided do not have same dimensions</p>
    1305. 

  1305. </dd></dl>
    1306. 

  1306. 

  1307. <dl class="exception">
    1308. 

  1308. <dt id="ipfml.exceptions.NumpyShapeComparisonException">
    1309. 

  1309. <em class="property">exception </em><code class="descclassname">ipfml.exceptions.</code><code class="descname">NumpyShapeComparisonException</code><a class="headerlink" href="#ipfml.exceptions.NumpyShapeComparisonException" title="Permalink to this definition">¶</a></dt>
    1310. 

  1310. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
    1311. 

  1311. <p>Numpy shape comparison Exception raised if two numpy arrays provided do not have same shape extactly</p>
    1312. 

  1312. </dd></dl>
    1313. 

  1313. 

  1314. </div>
    1315. 

  1315. </div>
    1316. 

  1316. 

  1317. 

  1318.            </div>
    1319. 

  1319.            
    1320. 

  1320.           </div>
    1321. 

  1321.           <footer>
    1322. 

  1322.   
    1323. 

  1323.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    1324. 

  1324.       
    1325. 

  1325.         <a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
    1326. 

  1326.       
    1327. 

  1327.       
    1328. 

  1328.         <a href="description.html" class="btn btn-neutral" title="Description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    1329. 

  1329.       
    1330. 

  1330.     </div>
    1331. 

  1331.   
    1332. 

  1332. 

  1333.   <hr/>
    1334. 

  1334. 

  1335.   <div role="contentinfo">
    1336. 

  1336.     <p>
    1337. 

  1337.         &copy; Copyright 2019, Jérôme BUISINE
    1338. 

  1338. 

  1339.     </p>
    1340. 

  1340.   </div>
    1341. 

  1341.   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>. 
    1342. 

  1342. 

  1343. </footer>
    1344. 

  1344. 

  1345.         </div>
    1346. 

  1346.       </div>
    1347. 

  1347. 

  1348.     </section>
    1349. 

  1349. 

  1350.   </div>
    1351. 

  1351.   
    1352. 

  1352. 

  1353. 

  1354.   
    1355. 

  1355. 

  1356.     
    1357. 

  1357.     
    1358. 

  1358.       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    1359. 

  1359.         <script type="text/javascript" src="_static/jquery.js"></script>
    1360. 

  1360.         <script type="text/javascript" src="_static/underscore.js"></script>
    1361. 

  1361.         <script type="text/javascript" src="_static/doctools.js"></script>
    1362. 

  1362.         <script type="text/javascript" src="_static/language_data.js"></script>
    1363. 

  1363.     
    1364. 

  1364. 

  1365.   
    1366. 

  1366. 

  1367.   <script type="text/javascript" src="_static/js/theme.js"></script>
    1368. 

  1368. 

  1369.   <script type="text/javascript">
    1370. 

  1370.       jQuery(function () {
    1371. 

  1371.           SphinxRtdTheme.Navigation.enable(true);
    1372. 

  1372.       });
    1373. 

  1373.   </script> 
    1374. 

  1374. 

  1375. </body>
    1376. 

  1376. </html>
    1377.