ipfml package restructuration

README.md

@@ -2,7 +2,7 @@ Image Processing For Machine Learning
 =====================================
 
 <p align="center">
-    <img src="ipfml_logo.png" width="40%">
+    <img src="https://github.com/prise-3d/ipfml/blob/master/ipfml_logo.png" width="40%">
 </p>
 
 Installation
@@ -19,9 +19,9 @@ To use, simply do :
 
 ```python
 from PIL import Image
-from ipfml import processing
+from ipfml.processing import transform
 img = Image.open('path/to/image.png')
-s = processing.get_LAB_L_SVD_s(img)
+s = transform.get_LAB_L_SVD_s(img)
 ```
 
 Modules
@@ -29,18 +29,19 @@ Modules
 
 This project contains modules.
 
-- **processing** : *Image processing module*
-- **metrics** : *Metrics computation of PIL or 2D numpy image*
-- **filters** : *Image filter module*
+- **metrics** : *Metrics computation for model performance*
 - **utils** : *All utils functions developed for the package*
 - **exceptions** : *All customized exceptions*
+- **filters** : *Image filter module*
+- **iqa** : *Image quality assessments*
+- **processing** : *Image processing module*
 
-All these modules will be enhanced during development of the package. Documentation is available [here](https://prise-3d.github.io/IPFML/).
+All these modules will be enhanced during development of the package. Documentation is available [here](https://prise-3d.github.io/ipfml/).
 
 How to contribute
 -----------------
 
-Please refer to the [guidelines](https://github.com/prise-3d/IPFML/blob/master/CONTRIBUTING.md) file if you want to contribute!
+Please refer to the [guidelines](https://github.com/prise-3d/ipfml/blob/master/CONTRIBUTING.md) file if you want to contribute!
 
 ## Contributors
 
@@ -48,4 +49,4 @@ Please refer to the [guidelines](https://github.com/prise-3d/IPFML/blob/master/C
 
 ## License
 
-[MIT](https://github.com/prise-3d/IPFML/blob/master/LICENSE)
+[MIT](https://github.com/prise-3d/ipfml/blob/master/LICENSE)

README.rst

@@ -18,9 +18,9 @@ To use, simply do :
 .. code:: python
 
    from PIL import Image
-   from ipfml import processing
+   from ipfml.processing import transform
    img = Image.open('path/to/image.png')
-   s = processing.get_LAB_L_SVD_s(img)
+   s = transform.get_LAB_L_SVD_s(img)
 
 
 Modules
@@ -28,11 +28,12 @@ Modules
 
 This project contains modules.
 
-- **processing** : *Image processing of images*
-- **metrics** : *Metrics computation of PIL or 2D, 3D numpy images*
-- **filters** : *Filters implemented such as noise filters*
+- **metrics** : *Metrics computation for model performance*
 - **utils** : *All utils functions developed for the package*
 - **exceptions** : *All customized exceptions*
+- **filters** : *Image filter module*
+- **iqa** : *Image quality assessments*
+- **processing** : *Image processing module*
 
 All these modules will be enhanced during development of the package.
 
@@ -41,11 +42,11 @@ Documentation
 
 For more information about package, documentation_ is available.
 
-.. _documentation: https://prise-3d.github.io/IPFML/
+.. _documentation: https://prise-3d.github.io/ipfml/
 
 Contributing
 ------------
 
 Please refer to the guidelines_ file if you want to contribute!
 
-.. _guidelines: https://github.com/prise-3d/IPFML/blob/master/CONTRIBUTING.md 
+.. _guidelines: https://github.com/prise-3d/ipfml/blob/master/CONTRIBUTING.md 

build.sh

@@ -10,4 +10,4 @@ python setup.py build
 
 echo "Build documentation..."
 rm -r docs/source/ipfml
-cd docs && make clean && make html
+cd docs && make clean && make html

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 29e6f78aa0a4cae0290113e20494277d
+config: 0c36f5e963cf0ab0b9585d0aa44cdcd5
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_modules/index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Overview: module code &mdash; IPFML v0.4.0 documentation</title>
+  <title>Overview: module code &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -46,7 +46,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home"> IPFML
+            <a href="../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -83,7 +83,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -100,7 +100,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">IPFML</a>
+          <a href="../index.html">ipfml</a>
         
       </nav>
 
@@ -151,7 +151,11 @@
 <li><a href="ipfml/filters/noise.html">ipfml.filters.noise</a></li>
 <li><a href="ipfml/iqa/fr.html">ipfml.iqa.fr</a></li>
 <li><a href="ipfml/metrics.html">ipfml.metrics</a></li>
-<li><a href="ipfml/processing.html">ipfml.processing</a></li>
+<li><a href="ipfml/processing/compression.html">ipfml.processing.compression</a></li>
+<li><a href="ipfml/processing/movement.html">ipfml.processing.movement</a></li>
+<li><a href="ipfml/processing/reconstruction.html">ipfml.processing.reconstruction</a></li>
+<li><a href="ipfml/processing/segmentation.html">ipfml.processing.segmentation</a></li>
+<li><a href="ipfml/processing/transform.html">ipfml.processing.transform</a></li>
 <li><a href="ipfml/utils.html">ipfml.utils</a></li>
 </ul>
 

docs/build/html/_modules/ipfml/exceptions.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.exceptions &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.exceptions &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -46,7 +46,7 @@
           
 
           
-            <a href="../../index.html" class="icon icon-home"> IPFML
+            <a href="../../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -83,7 +83,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
@@ -100,7 +100,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">IPFML</a>
+          <a href="../../index.html">ipfml</a>
         
       </nav>
 

docs/build/html/_modules/ipfml/filters/noise.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.filters.noise &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.filters.noise &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -46,7 +46,7 @@
           
 
           
-            <a href="../../../index.html" class="icon icon-home"> IPFML
+            <a href="../../../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -83,7 +83,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
@@ -100,7 +100,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">IPFML</a>
+          <a href="../../../index.html">ipfml</a>
         
       </nav>
 
@@ -153,11 +153,10 @@
 <span class="sd">Noise filters to apply on images</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># main imports</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">import</span> <span class="nn">random</span>
 
-<span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
-
 
 <span class="k">def</span> <span class="nf">_normalise</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
 

docs/build/html/_modules/ipfml/iqa/fr.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.iqa.fr &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.iqa.fr &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -46,7 +46,7 @@
           
 
           
-            <a href="../../../index.html" class="icon icon-home"> IPFML
+            <a href="../../../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -83,7 +83,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
@@ -100,7 +100,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../../index.html">IPFML</a>
+          <a href="../../../index.html">ipfml</a>
         
       </nav>
 
@@ -153,10 +153,14 @@
 <span class="sd">Full-reference Image Quality Assessment (FR-IQA) methods</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># main imports</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+
+<span class="c1"># computations imports</span>
 <span class="kn">from</span> <span class="nn">skimage.measure</span> <span class="k">import</span> <span class="n">compare_ssim</span><span class="p">,</span> <span class="n">compare_psnr</span>
-<span class="kn">from</span> <span class="nn">ipfml.exceptions</span> <span class="k">import</span> <span class="n">NumpyShapeComparisonException</span>
 
-<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="c1"># ipfml imports</span>
+<span class="kn">from</span> <span class="nn">ipfml.exceptions</span> <span class="k">import</span> <span class="n">NumpyShapeComparisonException</span>
 
 
 <span class="k">def</span> <span class="nf">_prepare_arrays</span><span class="p">(</span><span class="n">img_true</span><span class="p">,</span> <span class="n">img_test</span><span class="p">,</span> <span class="n">p_dtype</span><span class="o">=</span><span class="s1">&#39;float32&#39;</span><span class="p">):</span>

docs/build/html/_modules/ipfml/processing/compression.html

@@ -0,0 +1,302 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>ipfml.processing.compression &mdash; ipfml v0.4.1 documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+
+  
+  <script src="../../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search">
+          
+
+          
+            <a href="../../../index.html" class="icon icon-home"> ipfml
+          
+
+          
+          </a>
+
+          
+            
+            
+              <div class="version">
+                0.4.1
+              </div>
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation of ipfml</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">ipfml</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../../../index.html">Docs</a> &raquo;</li>
+        
+          <li><a href="../../index.html">Module code</a> &raquo;</li>
+        
+      <li>ipfml.processing.compression</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <h1>Source code for ipfml.processing.compression</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">Functions for image compression and extraction</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="c1"># image processing imports</span>
+<span class="kn">from</span> <span class="nn">numpy.linalg</span> <span class="k">import</span> <span class="n">svd</span>
+
+
+<div class="viewcode-block" id="get_SVD"><a class="viewcode-back" href="../../../ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD">[docs]</a><span class="k">def</span> <span class="nf">get_SVD</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Transforms Image using SVD compression</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        image: image to convert into SVD compression</span>
+
+<span class="sd">    Return:</span>
+<span class="sd">        U, s, V obtained from SVD compression</span>
+
+<span class="sd">    Usage:</span>
+
+<span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import compression</span>
+<span class="sd">    &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
+<span class="sd">    &gt;&gt;&gt; U, s, V = compression.get_SVD(img)</span>
+<span class="sd">    &gt;&gt;&gt; U.shape</span>
+<span class="sd">    (200, 200, 3)</span>
+<span class="sd">    &gt;&gt;&gt; len(s)</span>
+<span class="sd">    200</span>
+<span class="sd">    &gt;&gt;&gt; V.shape</span>
+<span class="sd">    (200, 3, 3)</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="get_SVD_s"><a class="viewcode-back" href="../../../ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_s">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_s</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;s&#39; part</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        image: image to convert</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        vector of singular values obtained from SVD compression</span>
+
+<span class="sd">    Usage:</span>
+
+<span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import compression</span>
+<span class="sd">    &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
+<span class="sd">    &gt;&gt;&gt; s = compression.get_SVD_s(img)</span>
+<span class="sd">    &gt;&gt;&gt; len(s)</span>
+<span class="sd">    200</span>
+<span class="sd">    &quot;&quot;&quot;</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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">s</span></div>
+
+
+<div class="viewcode-block" id="get_SVD_U"><a class="viewcode-back" href="../../../ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_U">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_U</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;U&#39; part</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        image: image to convert</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        U matrix from SVD compression</span>
+
+<span class="sd">    Usage:</span>
+
+<span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import compression</span>
+<span class="sd">    &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
+<span class="sd">    &gt;&gt;&gt; U = compression.get_SVD_U(img)</span>
+<span class="sd">    &gt;&gt;&gt; U.shape</span>
+<span class="sd">    (200, 200, 3)</span>
+<span class="sd">    &quot;&quot;&quot;</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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">U</span></div>
+
+
+<div class="viewcode-block" id="get_SVD_V"><a class="viewcode-back" href="../../../ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_V">[docs]</a><span class="k">def</span> <span class="nf">get_SVD_V</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;Transforms Image into SVD and returns only &#39;V&#39; part</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        image: image to convert</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        V matrix obtained from SVD compression</span>
+
+<span class="sd">    Usage :</span>
+
+<span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import compression</span>
+<span class="sd">    &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
+<span class="sd">    &gt;&gt;&gt; V = compression.get_SVD_V(img)</span>
+<span class="sd">    &gt;&gt;&gt; V.shape</span>
+<span class="sd">    (200, 3, 3)</span>
+<span class="sd">    &quot;&quot;&quot;</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">svd</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">full_matrices</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">V</span></div>
+</pre></div>
+
+           </div>
+           
+          </div>
+          <footer>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2019, Jérôme BUISINE
+
+    </p>
+  </div>
+  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>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  
+
+    
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../../../_static/jquery.js"></script>
+        <script type="text/javascript" src="../../../_static/underscore.js"></script>
+        <script type="text/javascript" src="../../../_static/doctools.js"></script>
+        <script type="text/javascript" src="../../../_static/language_data.js"></script>
+    
+
+  
+
+  <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>

docs/build/html/_modules/ipfml/processing/segmentation.html

@@ -0,0 +1,294 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>ipfml.processing.segmentation &mdash; ipfml v0.4.1 documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+
+  
+  <script src="../../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search">
+          
+
+          
+            <a href="../../../index.html" class="icon icon-home"> ipfml
+          
+
+          
+          </a>
+
+          
+            
+            
+              <div class="version">
+                0.4.1
+              </div>
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../ipfml.html">Documentation of ipfml</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">ipfml</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../../../index.html">Docs</a> &raquo;</li>
+        
+          <li><a href="../../index.html">Module code</a> &raquo;</li>
+        
+      <li>ipfml.processing.segmentation</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <h1>Source code for ipfml.processing.segmentation</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">All segmentation methods applied on images</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="c1"># main imports</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+
+<span class="c1"># image processing imports</span>
+<span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
+
+
+<div class="viewcode-block" id="divide_in_blocks"><a class="viewcode-back" href="../../../ipfml/ipfml.processing.segmentation.html#ipfml.processing.segmentation.divide_in_blocks">[docs]</a><span class="k">def</span> <span class="nf">divide_in_blocks</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">block_size</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+    <span class="sd">&#39;&#39;&#39;Divide image into equal size blocks</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        image: PIL Image or Numpy array</span>
+<span class="sd">        block: tuple (width, height) representing the size of each dimension of the block</span>
+<span class="sd">        pil: block type returned as PIL Image (default True)</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        list containing all 2D Numpy blocks (in RGB or not)</span>
+
+<span class="sd">    Raises:</span>
+<span class="sd">        ValueError: If `image_width` or `image_height` are not compatible to produce correct block sizes</span>
+
+<span class="sd">    Example:</span>
+
+<span class="sd">    &gt;&gt;&gt; import numpy as np</span>
+<span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import transform, segmentation</span>
+<span class="sd">    &gt;&gt;&gt; image_values = np.random.randint(255, size=(800, 800, 3))</span>
+<span class="sd">    &gt;&gt;&gt; blocks = segmentation.divide_in_blocks(image_values, (20, 20))</span>
+<span class="sd">    &gt;&gt;&gt; len(blocks)</span>
+<span class="sd">    1600</span>
+<span class="sd">    &gt;&gt;&gt; blocks[0].width</span>
+<span class="sd">    20</span>
+<span class="sd">    &gt;&gt;&gt; blocks[0].height</span>
+<span class="sd">    20</span>
+<span class="sd">    &gt;&gt;&gt; img_l = Image.open(&#39;./images/test_img.png&#39;)</span>
+<span class="sd">    &gt;&gt;&gt; L = transform.get_LAB_L(img_l)</span>
+<span class="sd">    &gt;&gt;&gt; blocks_L = segmentation.divide_in_blocks(L, (100, 100))</span>
+<span class="sd">    &gt;&gt;&gt; len(blocks_L)</span>
+<span class="sd">    4</span>
+<span class="sd">    &gt;&gt;&gt; blocks_L[0].width</span>
+<span class="sd">    100</span>
+<span class="sd">    &#39;&#39;&#39;</span>
+
+    <span class="n">blocks</span> <span class="o">=</span> <span class="p">[]</span>
+    <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;RGB&#39;</span>
+
+    <span class="c1"># convert in Numpy array</span>
+    <span class="n">image_array</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">image</span><span class="p">)</span>
+
+    <span class="c1"># check dimension of input image</span>
+    <span class="k">if</span> <span class="n">image_array</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
+        <span class="n">mode</span> <span class="o">=</span> <span class="s1">&#39;L&#39;</span>
+        <span class="n">image_width</span><span class="p">,</span> <span class="n">image_height</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="n">image_width</span><span class="p">,</span> <span class="n">image_height</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">image_array</span><span class="o">.</span><span class="n">shape</span>
+
+    <span class="c1"># check size compatibility</span>
+    <span class="n">width</span><span class="p">,</span> <span class="n">height</span> <span class="o">=</span> <span class="n">block_size</span>
+
+    <span class="k">if</span> <span class="p">(</span><span class="n">image_width</span> <span class="o">%</span> <span class="n">width</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">):</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Width size issue, block size not compatible&quot;</span><span class="p">)</span>
+
+    <span class="k">if</span> <span class="p">(</span><span class="n">image_height</span> <span class="o">%</span> <span class="n">height</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">):</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Height size issue, block size not compatible&quot;</span><span class="p">)</span>
+
+    <span class="n">nb_block_width</span> <span class="o">=</span> <span class="n">image_width</span> <span class="o">/</span> <span class="n">width</span>
+    <span class="n">nb_block_height</span> <span class="o">=</span> <span class="n">image_height</span> <span class="o">/</span> <span class="n">height</span>
+
+    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">nb_block_width</span><span class="p">)):</span>
+
+        <span class="n">begin_x</span> <span class="o">=</span> <span class="n">i</span> <span class="o">*</span> <span class="n">width</span>
+
+        <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">nb_block_height</span><span class="p">)):</span>
+
+            <span class="n">begin_y</span> <span class="o">=</span> <span class="n">j</span> <span class="o">*</span> <span class="n">height</span>
+
+            <span class="c1"># getting sub block information</span>
+            <span class="n">current_block</span> <span class="o">=</span> <span class="n">image_array</span><span class="p">[</span><span class="n">begin_x</span><span class="p">:(</span><span class="n">begin_x</span> <span class="o">+</span> <span class="n">width</span><span class="p">),</span> <span class="n">begin_y</span><span class="p">:(</span>
+                <span class="n">begin_y</span> <span class="o">+</span> <span class="n">height</span><span class="p">)]</span>
+
+            <span class="k">if</span> <span class="n">pil</span><span class="p">:</span>
+                <span class="n">blocks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
+                    <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">current_block</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="s1">&#39;uint8&#39;</span><span class="p">),</span> <span class="n">mode</span><span class="p">))</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">blocks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">current_block</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">blocks</span></div>
+</pre></div>
+
+           </div>
+           
+          </div>
+          <footer>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2019, Jérôme BUISINE
+
+    </p>
+  </div>
+  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>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  
+
+    
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../../../_static/jquery.js"></script>
+        <script type="text/javascript" src="../../../_static/underscore.js"></script>
+        <script type="text/javascript" src="../../../_static/doctools.js"></script>
+        <script type="text/javascript" src="../../../_static/language_data.js"></script>
+    
+
+  
+
+  <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>

docs/build/html/_modules/ipfml/utils.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.utils &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.utils &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -46,7 +46,7 @@
           
 
           
-            <a href="../../index.html" class="icon icon-home"> IPFML
+            <a href="../../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -83,7 +83,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
@@ -100,7 +100,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">IPFML</a>
+          <a href="../../index.html">ipfml</a>
         
       </nav>
 
@@ -150,13 +150,15 @@
             
   <h1>Source code for ipfml.utils</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">Utils functions of ipfml package (array normalization)</span>
+<span class="sd">Utils functions of ipfml package (normalization, integral...)</span>
 <span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># main imports</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">import</span> <span class="nn">math</span>
 <span class="kn">import</span> <span class="nn">sys</span>
 
+<span class="c1"># computation imports</span>
 <span class="kn">from</span> <span class="nn">scipy.integrate</span> <span class="k">import</span> <span class="n">simps</span>
 
 
@@ -235,9 +237,10 @@
 <span class="sd">    Example:</span>
 
 <span class="sd">    &gt;&gt;&gt; from PIL import Image</span>
-<span class="sd">    &gt;&gt;&gt; from ipfml import utils, processing</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml import utils</span>
+<span class="sd">    &gt;&gt;&gt; from ipfml.processing import transform</span>
 <span class="sd">    &gt;&gt;&gt; img = Image.open(&#39;./images/test_img.png&#39;)</span>
-<span class="sd">    &gt;&gt;&gt; img_mscn = processing.rgb_to_mscn(img)</span>
+<span class="sd">    &gt;&gt;&gt; img_mscn = transform.rgb_to_mscn(img)</span>
 <span class="sd">    &gt;&gt;&gt; img_normalized = utils.normalize_2D_arr(img_mscn)</span>
 <span class="sd">    &gt;&gt;&gt; img_normalized.shape</span>
 <span class="sd">    (200, 200)</span>

docs/build/html/_sources/description.rst.txt

@@ -23,6 +23,6 @@ To use, simply do :
 .. code:: python
     
    from PIL import Image
-   from ipfml import processing
+   from ipfml.processing import transform
    img = Image.open('path/to/image.png')
-   s = processing.get_LAB_L_SVD_s(img)
+   s = transform.get_LAB_L_SVD_s(img)

docs/build/html/_sources/examples.rst.txt

@@ -7,41 +7,18 @@ All examples below will use this picture.
 
 .. image:: _static/nature.jpg
 
-Metrics example
---------------------
-
-Using **metrics** module you can convert image into Lab, XYZ, SVD...
-
-.. code:: python
-   
-   from PIL import Image
-   from ipfml import metrics
-
-   img_path = 'path/to/image_nature.jpg'
-   img = Image.open(img_path)
-   
-   s = metrics.get_LAB_L(img)
-
-   # convert result into PIL Image
-   output = Image.fromarray(s)
-   output.show()
-
-This is the generated output using only L chanel from Lab.
-
-.. image:: _static/nature_lab_l.png
-
 Processing example
 --------------------
 
 .. code:: python
    
    from PIL import Image
-   from ipfml import processing
+   from ipfml.processing import transform
 
    img_path = 'path/to/image_nature.jpg'
    img = Image.open(img_path)
    
-   low_bits_img = processing.rgb_to_grey_low_bits(img, 6)
+   low_bits_img = transform.rgb_to_grey_low_bits(img, 6)
    
    output = Image.fromarray(low_bits_img)
    output.show()

docs/build/html/_sources/ipfml.rst.txt

@@ -1,13 +1,10 @@
-Documentation
-================
-
+Documentation of ipfml
+======================
 
 .. autosummary::
    :toctree: ipfml
 
    ipfml.metrics
-   ipfml.processing
-   
    ipfml.utils
    ipfml.exceptions  
 
@@ -27,3 +24,14 @@ ipfml.iqa
   
    ipfml.iqa.fr
 
+ipfml.processing
+-------------------
+
+.. autosummary::
+   :toctree: ipfml
+
+   ipfml.processing.compression
+   ipfml.processing.movement
+   ipfml.processing.reconstruction
+   ipfml.processing.segmentation
+   ipfml.processing.transform

docs/build/html/_sources/ipfml/ipfml.metrics.rst.txt

@@ -9,21 +9,7 @@ ipfml.metrics
 
    .. autosummary::
    
-      get_LAB
-      get_LAB_L
-      get_LAB_a
-      get_LAB_b
-      get_SVD
-      get_SVD_U
-      get_SVD_V
-      get_SVD_s
-      get_XYZ
-      get_XYZ_X
-      get_XYZ_Y
-      get_XYZ_Z
-      get_bits_img
-      get_low_bits_img
-      gray_to_mscn
+      coefficient_of_determination
    
    
 

docs/build/html/_sources/ipfml/ipfml.processing.compression.rst.txt

@@ -0,0 +1,25 @@
+ipfml.processing.compression
+============================
+
+.. automodule:: ipfml.processing.compression
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      get_SVD
+      get_SVD_U
+      get_SVD_V
+      get_SVD_s
+   
+   
+
+   
+   
+   
+
+   
+   
+   

docs/build/html/_sources/ipfml/ipfml.processing.movement.rst.txt

@@ -0,0 +1,23 @@
+ipfml.processing.movement
+=========================
+
+.. automodule:: ipfml.processing.movement
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      fusion_images
+      rotate_image
+   
+   
+
+   
+   
+   
+
+   
+   
+   

docs/build/html/_sources/ipfml/ipfml.processing.reconstruction.rst.txt

@@ -0,0 +1,24 @@
+ipfml.processing.reconstruction
+===============================
+
+.. automodule:: ipfml.processing.reconstruction
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      fast_ica
+      ipca
+      svd
+   
+   
+
+   
+   
+   
+
+   
+   
+   

docs/build/html/_sources/ipfml/ipfml.processing.segmentation.rst.txt

@@ -0,0 +1,22 @@
+ipfml.processing.segmentation
+=============================
+
+.. automodule:: ipfml.processing.segmentation
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      divide_in_blocks
+   
+   
+
+   
+   
+   
+
+   
+   
+   

docs/source/ipfml/ipfml.processing.rst

@@ -1,7 +1,7 @@
-ipfml.processing
-================
+ipfml.processing.transform
+==========================
 
-.. automodule:: ipfml.processing
+.. automodule:: ipfml.processing.transform
 
    
    
@@ -9,21 +9,26 @@ ipfml.processing
 
    .. autosummary::
    
-      divide_in_blocks
-      fast_ica_reconstruction
-      fusion_images
+      get_LAB
+      get_LAB_L
       get_LAB_L_SVD
       get_LAB_L_SVD_U
       get_LAB_L_SVD_V
       get_LAB_L_SVD_s
+      get_LAB_a
+      get_LAB_b
+      get_XYZ
+      get_XYZ_X
+      get_XYZ_Y
+      get_XYZ_Z
+      get_bits_img
+      get_low_bits_img
       get_mscn_coefficients
-      ipca_reconstruction
+      gray_to_mscn
       rgb_to_LAB_L_bits
       rgb_to_LAB_L_low_bits
       rgb_to_grey_low_bits
       rgb_to_mscn
-      rotate_image
-      svd_reconstruction
    
    
 

docs/build/html/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.4.0',
+    VERSION: 'v0.4.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

docs/build/html/contributing.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Contributing &mdash; IPFML v0.4.0 documentation</title>
+  <title>Contributing &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -47,7 +47,7 @@
           
 
           
-            <a href="index.html" class="icon icon-home"> IPFML
+            <a href="index.html" class="icon icon-home"> ipfml
           
 
           
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -84,7 +84,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#using-github">Using GitHub</a></li>
@@ -104,7 +104,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">IPFML</a>
+          <a href="index.html">ipfml</a>
         
       </nav>
 
@@ -142,7 +142,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/contributing.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/contributing.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         

docs/build/html/description.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Description &mdash; IPFML v0.4.0 documentation</title>
+  <title>Description &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -28,7 +28,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Documentation" href="ipfml.html" />
+    <link rel="next" title="Documentation of ipfml" href="ipfml.html" />
     <link rel="prev" title="Image Processing For Machine Learning" href="index.html" /> 
 
   
@@ -48,7 +48,7 @@
           
 
           
-            <a href="index.html" class="icon icon-home"> IPFML
+            <a href="index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -89,7 +89,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#how-to-use">How to use ?</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -106,7 +106,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">IPFML</a>
+          <a href="index.html">ipfml</a>
         
       </nav>
 
@@ -144,7 +144,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/description.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/description.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -172,9 +172,9 @@
 <h2>How to use ?<a class="headerlink" href="#how-to-use" title="Permalink to this headline">¶</a></h2>
 <p>To use, simply do :</p>
 <div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
-<span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
+<span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</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;path/to/image.png&#39;</span><span class="p">)</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>
+<span class="n">s</span> <span class="o">=</span> <span class="n">transform</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>
 </pre></div>
 </div>
 </div>
@@ -188,7 +188,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="ipfml.html" class="btn btn-neutral float-right" title="Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="ipfml.html" class="btn btn-neutral float-right" title="Documentation of ipfml" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="index.html" class="btn btn-neutral" title="Image Processing For Machine Learning" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/build/html/examples.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Examples &mdash; IPFML v0.4.0 documentation</title>
+  <title>Examples &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -29,7 +29,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Contributing" href="contributing.html" />
-    <link rel="prev" title="ipfml.iqa.fr" href="ipfml/ipfml.iqa.fr.html" /> 
+    <link rel="prev" title="ipfml.processing.transform" href="ipfml/ipfml.processing.transform.html" /> 
 
   
   <script src="_static/js/modernizr.min.js"></script>
@@ -48,7 +48,7 @@
           
 
           
-            <a href="index.html" class="icon icon-home"> IPFML
+            <a href="index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,9 +85,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="#metrics-example">Metrics example</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#processing-example">Processing example</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#noise-filter-example">Noise filter example</a></li>
 </ul>
@@ -107,7 +106,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">IPFML</a>
+          <a href="index.html">ipfml</a>
         
       </nav>
 
@@ -145,7 +144,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/examples.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/examples.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -164,34 +163,15 @@
 <p>Some examples are already available into documentation. You can find here some others and results of use of IPFML package.</p>
 <p>All examples below will use this picture.</p>
 <img alt="_images/nature.jpg" src="_images/nature.jpg" />
-<div class="section" id="metrics-example">
-<h2>Metrics example<a class="headerlink" href="#metrics-example" title="Permalink to this headline">¶</a></h2>
-<p>Using <strong>metrics</strong> module you can convert image into Lab, XYZ, SVD…</p>
-<div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
-<span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
-
-<span class="n">img_path</span> <span class="o">=</span> <span class="s1">&#39;path/to/image_nature.jpg&#39;</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="n">img_path</span><span class="p">)</span>
-
-<span class="n">s</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>
-
-<span class="c1"># convert result into PIL Image</span>
-<span class="n">output</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
-<span class="n">output</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
-</pre></div>
-</div>
-<p>This is the generated output using only L chanel from Lab.</p>
-<img alt="_images/nature_lab_l.png" src="_images/nature_lab_l.png" />
-</div>
 <div class="section" id="processing-example">
 <h2>Processing example<a class="headerlink" href="#processing-example" title="Permalink to this headline">¶</a></h2>
 <div class="code python highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">PIL</span> <span class="k">import</span> <span class="n">Image</span>
-<span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
+<span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">transform</span>
 
 <span class="n">img_path</span> <span class="o">=</span> <span class="s1">&#39;path/to/image_nature.jpg&#39;</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="n">img_path</span><span class="p">)</span>
 
-<span class="n">low_bits_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">6</span><span class="p">)</span>
+<span class="n">low_bits_img</span> <span class="o">=</span> <span class="n">transform</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">6</span><span class="p">)</span>
 
 <span class="n">output</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">fromarray</span><span class="p">(</span><span class="n">low_bits_img</span><span class="p">)</span>
 <span class="n">output</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
@@ -232,7 +212,7 @@
         <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="ipfml/ipfml.iqa.fr.html" class="btn btn-neutral" title="ipfml.iqa.fr" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="ipfml/ipfml.processing.transform.html" class="btn btn-neutral" title="ipfml.processing.transform" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

docs/build/html/genindex.html

@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; IPFML v0.4.0 documentation</title>
+  <title>Index &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -47,7 +47,7 @@
           
 
           
-            <a href="index.html" class="icon icon-home"> IPFML
+            <a href="index.html" class="icon icon-home"> ipfml
           
 
           
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -84,7 +84,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -101,7 +101,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">IPFML</a>
+          <a href="index.html">ipfml</a>
         
       </nav>
 
@@ -139,7 +139,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/genindex" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/genindex" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -176,6 +176,10 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.cauchy_noise">cauchy_noise() (in module ipfml.filters.noise)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.coefficient_of_determination">coefficient_of_determination() (in module ipfml.metrics)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -183,7 +187,7 @@
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.divide_in_blocks">divide_in_blocks() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.segmentation.html#ipfml.processing.segmentation.divide_in_blocks">divide_in_blocks() (in module ipfml.processing.segmentation)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -191,11 +195,11 @@
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.fast_ica_reconstruction">fast_ica_reconstruction() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.fast_ica">fast_ica() (in module ipfml.processing.reconstruction)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.fusion_images">fusion_images() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.movement.html#ipfml.processing.movement.fusion_images">fusion_images() (in module ipfml.processing.movement)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -205,7 +209,7 @@
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ipfml/ipfml.filters.noise.html#ipfml.filters.noise.gaussian_noise">gaussian_noise() (in module ipfml.filters.noise)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_bits_img">get_bits_img() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_bits_img">get_bits_img() (in module ipfml.processing.transform)</a>
 </li>
       <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_entropy">get_entropy() (in module ipfml.utils)</a>
 </li>
@@ -217,45 +221,45 @@
 </li>
       <li><a href="ipfml/ipfml.utils.html#ipfml.utils.get_indices_of_lowest_values">get_indices_of_lowest_values() (in module ipfml.utils)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB">get_LAB() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB">get_LAB() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_a">get_LAB_a() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_a">get_LAB_a() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_b">get_LAB_b() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_b">get_LAB_b() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_LAB_L">get_LAB_L() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L">get_LAB_L() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD">get_LAB_L_SVD() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD">get_LAB_L_SVD() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_s">get_LAB_L_SVD_s() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_s">get_LAB_L_SVD_s() (in module ipfml.processing.transform)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_U">get_LAB_L_SVD_U() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_U">get_LAB_L_SVD_U() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_LAB_L_SVD_V">get_LAB_L_SVD_V() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_LAB_L_SVD_V">get_LAB_L_SVD_V() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_low_bits_img">get_low_bits_img() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_low_bits_img">get_low_bits_img() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.get_mscn_coefficients">get_mscn_coefficients() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_mscn_coefficients">get_mscn_coefficients() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD">get_SVD() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD">get_SVD() (in module ipfml.processing.compression)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_s">get_SVD_s() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_s">get_SVD_s() (in module ipfml.processing.compression)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_U">get_SVD_U() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_U">get_SVD_U() (in module ipfml.processing.compression)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_SVD_V">get_SVD_V() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.compression.html#ipfml.processing.compression.get_SVD_V">get_SVD_V() (in module ipfml.processing.compression)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ">get_XYZ() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ">get_XYZ() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_X">get_XYZ_X() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_X">get_XYZ_X() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Y">get_XYZ_Y() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_Y">get_XYZ_Y() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.get_XYZ_Z">get_XYZ_Z() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.get_XYZ_Z">get_XYZ_Z() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.metrics.html#ipfml.metrics.gray_to_mscn">gray_to_mscn() (in module ipfml.metrics)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.gray_to_mscn">gray_to_mscn() (in module ipfml.processing.transform)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -267,19 +271,27 @@
 </li>
       <li><a href="ipfml/ipfml.utils.html#ipfml.utils.integral_area_trapz">integral_area_trapz() (in module ipfml.utils)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.ipca_reconstruction">ipca_reconstruction() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.ipca">ipca() (in module ipfml.processing.reconstruction)</a>
 </li>
       <li><a href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions">ipfml.exceptions (module)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
 </li>
       <li><a href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr">ipfml.iqa.fr (module)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ipfml/ipfml.metrics.html#module-ipfml.metrics">ipfml.metrics (module)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#module-ipfml.processing">ipfml.processing (module)</a>
+      <li><a href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression">ipfml.processing.compression (module)</a>
+</li>
+      <li><a href="ipfml/ipfml.processing.movement.html#module-ipfml.processing.movement">ipfml.processing.movement (module)</a>
+</li>
+      <li><a href="ipfml/ipfml.processing.reconstruction.html#module-ipfml.processing.reconstruction">ipfml.processing.reconstruction (module)</a>
+</li>
+      <li><a href="ipfml/ipfml.processing.segmentation.html#module-ipfml.processing.segmentation">ipfml.processing.segmentation (module)</a>
+</li>
+      <li><a href="ipfml/ipfml.processing.transform.html#module-ipfml.processing.transform">ipfml.processing.transform (module)</a>
 </li>
       <li><a href="ipfml/ipfml.utils.html#module-ipfml.utils">ipfml.utils (module)</a>
 </li>
@@ -343,19 +355,19 @@
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_grey_low_bits">rgb_to_grey_low_bits() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_grey_low_bits">rgb_to_grey_low_bits() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_bits">rgb_to_LAB_L_bits() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_LAB_L_bits">rgb_to_LAB_L_bits() (in module ipfml.processing.transform)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_LAB_L_low_bits">rgb_to_LAB_L_low_bits() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_LAB_L_low_bits">rgb_to_LAB_L_low_bits() (in module ipfml.processing.transform)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rgb_to_mscn">rgb_to_mscn() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.transform.html#ipfml.processing.transform.rgb_to_mscn">rgb_to_mscn() (in module ipfml.processing.transform)</a>
 </li>
       <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.rmse">rmse() (in module ipfml.iqa.fr)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.rotate_image">rotate_image() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.movement.html#ipfml.processing.movement.rotate_image">rotate_image() (in module ipfml.processing.movement)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -369,7 +381,7 @@
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.ssim">ssim() (in module ipfml.iqa.fr)</a>
 </li>
-      <li><a href="ipfml/ipfml.processing.html#ipfml.processing.svd_reconstruction">svd_reconstruction() (in module ipfml.processing)</a>
+      <li><a href="ipfml/ipfml.processing.reconstruction.html#ipfml.processing.reconstruction.svd">svd() (in module ipfml.processing.reconstruction)</a>
 </li>
   </ul></td>
 </tr></table>

docs/build/html/index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Image Processing For Machine Learning &mdash; IPFML v0.4.0 documentation</title>
+  <title>Image Processing For Machine Learning &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -47,7 +47,7 @@
           
 
           
-            <a href="#" class="icon icon-home"> IPFML
+            <a href="#" class="icon icon-home"> ipfml
           
 
           
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -84,7 +84,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -101,7 +101,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="#">IPFML</a>
+          <a href="#">ipfml</a>
         
       </nav>
 
@@ -139,7 +139,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -168,9 +168,8 @@
 <li class="toctree-l2"><a class="reference internal" href="description.html#how-to-use">How to use ?</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation of ipfml</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.metrics.html">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.exceptions.html">ipfml.exceptions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.html#ipfml-filters">ipfml.filters</a><ul>
@@ -181,10 +180,17 @@
 <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.iqa.fr.html">ipfml.iqa.fr</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="ipfml.html#ipfml-processing">ipfml.processing</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.compression.html">ipfml.processing.compression</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.movement.html">ipfml.processing.movement</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.transform.html">ipfml.processing.transform</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="examples.html#metrics-example">Metrics example</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples.html#processing-example">Processing example</a></li>
 <li class="toctree-l2"><a class="reference internal" href="examples.html#noise-filter-example">Noise filter example</a></li>
 </ul>

docs/build/html/ipfml.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Documentation &mdash; IPFML v0.4.0 documentation</title>
+  <title>Documentation of ipfml &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -48,7 +48,7 @@
           
 
           
-            <a href="index.html" class="icon icon-home"> IPFML
+            <a href="index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,9 +85,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation of ipfml</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.metrics.html">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.exceptions.html">ipfml.exceptions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#ipfml-filters">ipfml.filters</a><ul>
@@ -98,6 +97,14 @@
 <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.iqa.fr.html">ipfml.iqa.fr</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="#ipfml-processing">ipfml.processing</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.compression.html">ipfml.processing.compression</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.movement.html">ipfml.processing.movement</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.transform.html">ipfml.processing.transform</a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
@@ -116,7 +123,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">IPFML</a>
+          <a href="index.html">ipfml</a>
         
       </nav>
 
@@ -147,14 +154,14 @@
     
       <li><a href="index.html">Docs</a> &raquo;</li>
         
-      <li>Documentation</li>
+      <li>Documentation of ipfml</li>
     
     
       <li class="wy-breadcrumbs-aside">
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -168,8 +175,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="documentation">
-<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="documentation-of-ipfml">
+<h1>Documentation of ipfml<a class="headerlink" href="#documentation-of-ipfml" title="Permalink to this headline">¶</a></h1>
 <table border="1" class="longtable docutils">
 <colgroup>
 <col width="10%" />
@@ -177,15 +184,12 @@
 </colgroup>
 <tbody valign="top">
 <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.metrics.html#module-ipfml.metrics" title="ipfml.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.metrics</span></code></a></td>
-<td>Functions which can be used to extract information from image</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.html#module-ipfml.processing" title="ipfml.processing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing</span></code></a></td>
-<td>Functions to quickly extract reduced information from image</td>
+<td>Contains all metrics used for model results comparisons</td>
 </tr>
-<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.utils.html#module-ipfml.utils" title="ipfml.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.utils</span></code></a></td>
-<td>Utils functions of ipfml package (array normalization)</td>
+<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.utils.html#module-ipfml.utils" title="ipfml.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.utils</span></code></a></td>
+<td>Utils functions of ipfml package (normalization, integral…)</td>
 </tr>
-<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions" title="ipfml.exceptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.exceptions</span></code></a></td>
+<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions" title="ipfml.exceptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.exceptions</span></code></a></td>
 <td>Module which contains all customs Exceptions used into ipfml package</td>
 </tr>
 </tbody>
@@ -218,6 +222,32 @@
 </tbody>
 </table>
 </div>
+<div class="section" id="ipfml-processing">
+<h2>ipfml.processing<a class="headerlink" href="#ipfml-processing" title="Permalink to this headline">¶</a></h2>
+<table border="1" class="longtable docutils">
+<colgroup>
+<col width="10%" />
+<col width="90%" />
+</colgroup>
+<tbody valign="top">
+<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression" title="ipfml.processing.compression"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.compression</span></code></a></td>
+<td>Functions for image compression and extraction</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.movement.html#module-ipfml.processing.movement" title="ipfml.processing.movement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.movement</span></code></a></td>
+<td>All movements that can be applied on image such as rotations, fusions, flips</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html#module-ipfml.processing.reconstruction" title="ipfml.processing.reconstruction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.reconstruction</span></code></a></td>
+<td>Functions for reconstruction process of image using reduction/compression methods</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html#module-ipfml.processing.segmentation" title="ipfml.processing.segmentation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.segmentation</span></code></a></td>
+<td>All segmentation methods applied on images</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.transform.html#module-ipfml.processing.transform" title="ipfml.processing.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.transform</span></code></a></td>
+<td>Functions which can be used to extract information from image or reduce it</td>
+</tr>
+</tbody>
+</table>
+</div>
 </div>
 
 

docs/build/html/ipfml/ipfml.exceptions.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.exceptions &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.exceptions &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -48,7 +48,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home"> IPFML
+            <a href="../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,13 +85,13 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">ipfml.exceptions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
@@ -110,7 +110,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">IPFML</a>
+          <a href="../index.html">ipfml</a>
         
       </nav>
 
@@ -141,7 +141,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
+          <li><a href="../ipfml.html">Documentation of ipfml</a> &raquo;</li>
         
       <li>ipfml.exceptions</li>
     
@@ -150,7 +150,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml/ipfml.exceptions.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.exceptions.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         

docs/build/html/ipfml/ipfml.filters.noise.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.filters.noise &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.filters.noise &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -48,7 +48,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home"> IPFML
+            <a href="../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,9 +85,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a><ul class="current">
@@ -95,6 +94,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
@@ -113,7 +113,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">IPFML</a>
+          <a href="../index.html">ipfml</a>
         
       </nav>
 
@@ -144,7 +144,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
+          <li><a href="../ipfml.html">Documentation of ipfml</a> &raquo;</li>
         
       <li>ipfml.filters.noise</li>
     
@@ -153,7 +153,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml/ipfml.filters.noise.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.filters.noise.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         

docs/build/html/ipfml/ipfml.iqa.fr.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.iqa.fr &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.iqa.fr &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -28,7 +28,7 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Examples" href="../examples.html" />
+    <link rel="next" title="ipfml.processing.compression" href="ipfml.processing.compression.html" />
     <link rel="prev" title="ipfml.filters.noise" href="ipfml.filters.noise.html" /> 
 
   
@@ -48,7 +48,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home"> IPFML
+            <a href="../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,9 +85,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
@@ -95,6 +94,7 @@
 <li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.iqa.fr</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
@@ -113,7 +113,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">IPFML</a>
+          <a href="../index.html">ipfml</a>
         
       </nav>
 
@@ -144,7 +144,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
+          <li><a href="../ipfml.html">Documentation of ipfml</a> &raquo;</li>
         
       <li>ipfml.iqa.fr</li>
     
@@ -153,7 +153,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml/ipfml.iqa.fr.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.iqa.fr.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -386,7 +386,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <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>
+        <a href="ipfml.processing.compression.html" class="btn btn-neutral float-right" title="ipfml.processing.compression" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="ipfml.filters.noise.html" class="btn btn-neutral" title="ipfml.filters.noise" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

docs/build/html/ipfml/ipfml.metrics.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.metrics &mdash; IPFML v0.4.0 documentation</title>
+  <title>ipfml.metrics &mdash; ipfml v0.4.1 documentation</title>
   
 
   
@@ -28,8 +28,8 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="ipfml.processing" href="ipfml.processing.html" />
-    <link rel="prev" title="Documentation" href="../ipfml.html" /> 
+    <link rel="next" title="ipfml.utils" href="ipfml.utils.html" />
+    <link rel="prev" title="Documentation of ipfml" href="../ipfml.html" /> 
 
   
   <script src="../_static/js/modernizr.min.js"></script>
@@ -48,7 +48,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home"> IPFML
+            <a href="../index.html" class="icon icon-home"> ipfml
           
 
           
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.0
+                0.4.1
               </div>
             
           
@@ -85,13 +85,13 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a><ul class="current">
 <li class="toctree-l2 current"><a class="current reference internal" href="#">ipfml.metrics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ipfml.processing.html">ipfml.processing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
@@ -110,7 +110,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
         
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">IPFML</a>
+          <a href="../index.html">ipfml</a>
         
       </nav>
 
@@ -141,7 +141,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
+          <li><a href="../ipfml.html">Documentation of ipfml</a> &raquo;</li>
         
       <li>ipfml.metrics</li>
     
@@ -150,7 +150,7 @@
         
             
             
-              <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/ipfml/ipfml.metrics.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.metrics.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -166,7 +166,7 @@
             
   <div class="section" id="module-ipfml.metrics">
 <span id="ipfml-metrics"></span><h1>ipfml.metrics<a class="headerlink" href="#module-ipfml.metrics" title="Permalink to this headline">¶</a></h1>
-<p>Functions which can be used to extract information from image</p>
+<p>Contains all metrics used for model results comparisons</p>
 <p class="rubric">Functions</p>
 <table border="1" class="longtable docutils">
 <colgroup>
@@ -174,446 +174,38 @@
 <col width="90%" />
 </colgroup>
 <tbody valign="top">
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_LAB" title="ipfml.metrics.get_LAB"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB</span></code></a>(image)</td>
-<td>Transforms RGB  Image into Lab</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_LAB_L" title="ipfml.metrics.get_LAB_L"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_L</span></code></a>(image)</td>
-<td>Transforms RGB Image into Lab and returns L</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_LAB_a" title="ipfml.metrics.get_LAB_a"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_a</span></code></a>(image)</td>
-<td>Transforms RGB Image into LAB and returns a</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_LAB_b" title="ipfml.metrics.get_LAB_b"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_LAB_b</span></code></a>(image)</td>
-<td>Transforms RGB Image into LAB and returns b</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_SVD" title="ipfml.metrics.get_SVD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_SVD</span></code></a>(image)</td>
-<td>Transforms Image using SVD compression</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_SVD_U" title="ipfml.metrics.get_SVD_U"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_SVD_U</span></code></a>(image)</td>
-<td>Transforms Image into SVD and returns only ‘U’ part</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_SVD_V" title="ipfml.metrics.get_SVD_V"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_SVD_V</span></code></a>(image)</td>
-<td>Transforms Image into SVD and returns only ‘V’ part</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_SVD_s" title="ipfml.metrics.get_SVD_s"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_SVD_s</span></code></a>(image)</td>
-<td>Transforms Image into SVD and returns only ‘s’ part</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_XYZ" title="ipfml.metrics.get_XYZ"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ</span></code></a>(image)</td>
-<td>Transforms RGB Image into XYZ</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_XYZ_X" title="ipfml.metrics.get_XYZ_X"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_X</span></code></a>(image)</td>
-<td>Transforms RGB Image into XYZ and returns X</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_XYZ_Y" title="ipfml.metrics.get_XYZ_Y"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_Y</span></code></a>(image)</td>
-<td>Transforms RGB Image into XYZ and returns Y</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_XYZ_Z" title="ipfml.metrics.get_XYZ_Z"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_XYZ_Z</span></code></a>(image)</td>
-<td>Transforms RGB Image into XYZ and returns Z</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.get_bits_img" title="ipfml.metrics.get_bits_img"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_bits_img</span></code></a>(image,&nbsp;interval)</td>
-<td>Returns only bits specified into the interval</td>
-</tr>
-<tr class="row-even"><td><a class="reference internal" href="#ipfml.metrics.get_low_bits_img" title="ipfml.metrics.get_low_bits_img"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_low_bits_img</span></code></a>(image[,&nbsp;nb_bits])</td>
-<td>Returns Image or Numpy array with data information reduced using only low bits</td>
-</tr>
-<tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.gray_to_mscn" title="ipfml.metrics.gray_to_mscn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gray_to_mscn</span></code></a>(image)</td>
-<td>Convert Grayscale Image into Mean Subtracted Contrast Normalized (MSCN)</td>
-</tr>
-</tbody>
-</table>
-<dl class="function">
-<dt id="ipfml.metrics.get_LAB">
-<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="reference internal" href="../_modules/ipfml/metrics.html#get_LAB"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.metrics.get_LAB" title="Permalink to this definition">¶</a></dt>
-<dd><p>Transforms RGB  Image into Lab</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>image</strong> – image to convert</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Lab information</td>
-</tr>
-</tbody>
-</table>
-<p>Usage:</p>
-<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>
-<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>
-<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>
-<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>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">Lab</span><span class="o">.</span><span class="n">shape</span>
-<span class="go">(200, 200, 3)</span>
-</pre></div>
-</div>
-</dd></dl>
-
-<dl class="function">
-<dt id="ipfml.metrics.get_LAB_L">