Add of some examples in documentation

README.md

@@ -1,7 +1,15 @@
-IPFML
-=====
+Image Processing For Machine Learning
+=====================================
 
-Image Processing For Machine Learning package.
+![ipfml_logo](ipfml_logo.png)
+
+
+Installation
+------------
+
+```bash
+pip install ipfml
+```
 
 How to use ?
 ------------
@@ -10,9 +18,9 @@ To use, simply do :
 
 ```python
 from PIL import Image
-from ipfml import image_processing
+from ipfml import processing
 img = Image.open('path/to/image.png')
-s = image_processing.get_LAB_L_SVD_s(img)
+s = processing.get_LAB_L_SVD_s(img)
 ```
 
 Modules

README.rst

@@ -1,19 +1,28 @@
-IPFML
-=====
+Image Processing For Machine Learning
+=====================================
 
-Image Processing For Machine Learning python package.
+.. image:: ipfml_logo.png
 
 This is a package developed during a thesis project.
 
+Installation
+------------
+
+.. code:: bash
+   
+   pip install ifpml
+
 How to use ?
 ------------
 
 To use, simply do :
 
-    >>> from PIL import Image
-    >>> from ipfml import image_processing
-    >>> img = Image.open('path/to/image.png')
-    >>> s = image_processing.get_LAB_L_SVD_s(img)
+.. code:: python
+   
+   from PIL import Image
+   from ipfml import processing
+   img = Image.open('path/to/image.png')
+   s = processing.get_LAB_L_SVD_s(img)
 
 
 Modules

build.sh

@@ -1,4 +1,4 @@
 #! bin/bash
 
 # script used to build documentation from setup.py build command
-cd docs && 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: 4e957c4a0da9a7a3a633d897435d117f
+config: 69203b98984ddfbab21b49127519dae7
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -0,0 +1,15 @@
+Contributing
+=====================================
+
+.. image:: _static/ipfml_logo.png
+
+
+Using GitHub
+------------
+
+This git project uses git-flow_ implementation. You are free to contribute to it.
+
+.. _git-flow: https://danielkummer.github.io/git-flow-cheatsheet/    
+
+You just have to create your own feature branch and make a pull request.
+

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

@@ -1,5 +1,7 @@
 Description
-============
+=====================================
+
+.. image:: _static/ipfml_logo.png
 
 
 Installation
@@ -7,7 +9,9 @@ Installation
 
 Just install package using pip 
 
-   >>> pip install ipfml
+.. code:: bash
+   
+   pip install ipfml
 
 
 How to use ?
@@ -15,9 +19,9 @@ How to use ?
 
 To use, simply do :
 
-    >>> from PIL import Image
-    >>> from ipfml import image_processing
-    >>> img = Image.open('path/to/image.png')
-    >>> s = image_processing.get_LAB_L_SVD_s(img)
-
-
+.. code:: python
+    
+   from PIL import Image
+   from ipfml import image_processing
+   img = Image.open('path/to/image.png')
+   s = image_processing.get_LAB_L_SVD_s(img)

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

@@ -0,0 +1,73 @@
+Examples
+=====================================
+
+Some examples are already available into documentation. You can find here some others and results of use of IPFML package.
+
+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
+
+   img_path = 'path/to/image_nature.jpg'
+   img = Image.open(img_path)
+   
+   low_bits_img = processing.rgb_to_grey_low_bits(img, 6)
+   
+   output = Image.fromarray(low_bits_img)
+   output.show()
+
+Now we have picture information with only the 6 low bits values.
+
+.. image:: _static/nature_low_bits_6.png
+
+Noise filter example
+---------------------
+
+.. code:: python
+   
+   from PIL import Image
+   from ipfml.filters import noise as nf
+
+   img_path = 'path/to/image_nature.jpg'
+   img = Image.open(img_path)
+
+   # set noise impact to 30
+   noisy_image = nf.gaussian_noise(img, n=30)
+
+   output = Image.fromarray(noisy_image)
+   output.show()
+   
+Image result after applying gaussian noise on nature image.
+
+.. image:: _static/nature_gaussian_noise.png
+

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

@@ -3,23 +3,24 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-IPFML's documentation!
-=================================
+Image Processing For Machine Learning
+=====================================
 
-.. toctree::
-   :maxdepth: 2
-      
-   description
-   ipfml
-   ipfml.filters
+.. image:: _static/ipfml_logo.png
 
 What's IPFML ?
 =================
 
-Image Processing For Machine Learning python package.
+IPFML is a python ackage developed during a thesis project.
 
-This is a package developed during a thesis project.
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
+   description
+   ipfml
+   examples
+   contributing
 
 Indices and tables
 ==================

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

@@ -1,10 +0,0 @@
-ipfml.filters
-=====================
-
-ipfml.filters.noise
---------------------------
-
-.. automodule:: ipfml.filters.noise
-    :members:
-    :show-inheritance:
-    

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

@@ -1,16 +1,27 @@
-ipfml
+Documentation
 =============
 
 ipfml.metrics
---------------------
+---------------------------
 
 .. automodule:: ipfml.metrics
     :members:
     :show-inheritance:
 
 ipfml.processing
------------------------
+---------------------------
 
 .. automodule:: ipfml.processing
     :members:
     :show-inheritance:
+
+
+ipfml.filters
+---------------------------
+
+ipfml.filters.noise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: ipfml.filters.noise
+    :members:
+    :show-inheritance:
+ 

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.1.9',
+    VERSION: 'v0.2.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

docs/build/html/_static/pymunk.js

@@ -1,56 +0,0 @@
-$(function (){
-
-    console.log("There!")
-
-    var createList = function(selector){
-
-        var ul = $('<ul>');
-        var selected = $(selector);
-
-        console.log(selected.length);
-        if (selected.length === 0){
-            return;
-        }
-
-        selected.clone().each(function (i,e){
-
-            var p = $(e).children('.descclassname');
-            var n = $(e).children('.descname');
-            var l = $(e).children('.headerlink');
-
-            var a = $('<a>');
-            a.attr('href',l.attr('href')).attr('title', 'Link to this definition');
-
-            a.append(p).append(n);
-
-            var entry = $('<li>').append(a);
-            ul.append(entry);
-        });
-        return ul;
-    }
-
-
-    var c = $('<div style="float:left; min-width: 300px;">');
-
-    var ul0 = c.clone().append($('.submodule-index'))
-
-    customIndex = $('.custom-index');
-    customIndex.empty();
-    customIndex.append(ul0);
-
-    var x = [];
-    x.push(['Classes','dl.class > dt']);
-    x.push(['Functions','dl.function > dt']);
-    x.push(['Variables','dl.data > dt']);
-
-    x.forEach(function (e){
-        var l = createList(e[1]);
-        if (l) {
-            var ul = c.clone()
-                .append('<p class="rubric">'+e[0]+'</p>')
-                .append(l);
-        }
-        customIndex.append(ul);
-    });
-
-});

docs/build/html/contributing.html

@@ -0,0 +1,224 @@
+
+
+<!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>Contributing &mdash; IPFML v0.2.0 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" />
+    <link rel="prev" title="Examples" href="examples.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.2.0
+              </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 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="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>
+</ul>
+</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>Contributing</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            <a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a>
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="contributing">
+<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
+<img alt="_images/ipfml_logo.png" src="_images/ipfml_logo.png" />
+<div class="section" id="using-github">
+<h2>Using GitHub<a class="headerlink" href="#using-github" title="Permalink to this headline">¶</a></h2>
+<p>This git project uses <a class="reference external" href="https://danielkummer.github.io/git-flow-cheatsheet/">git-flow</a> implementation. You are free to contribute to it.</p>
+<p>You just have to create your own feature branch and make a pull request.</p>
+</div>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+      
+        <a href="examples.html" class="btn btn-neutral" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <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/description.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Description &mdash; IPFML v0.1.9 documentation</title>
+  <title>Description &mdash; IPFML v0.2.0 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" href="ipfml.html" />
-    <link rel="prev" title="IPFML’s documentation!" href="index.html" /> 
+    <link rel="next" title="Documentation" href="ipfml.html" />
+    <link rel="prev" title="Image Processing For Machine Learning" href="index.html" /> 
 
   
   <script src="_static/js/modernizr.min.js"></script>
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.1.9
+                0.2.0
               </div>
             
           
@@ -82,14 +82,16 @@
               
             
             
-              <ul class="current">
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Description</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
 <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">ipfml</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</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="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
             
@@ -156,20 +158,21 @@
             
   <div class="section" id="description">
 <h1>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h1>
+<img alt="_images/ipfml_logo.png" src="_images/ipfml_logo.png" />
 <div class="section" id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
 <p>Just install package using pip</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pip</span> <span class="n">install</span> <span class="n">ipfml</span>
+<div class="code bash highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">ipfml</span>
 </pre></div>
 </div>
 </div>
 <div class="section" id="how-to-use">
 <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="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">image_processing</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;path/to/image.png&#39;</span><span class="p">)</span>
-<span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="n">image_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>
+<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">image_processing</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">image_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>
 </pre></div>
 </div>
 </div>
@@ -183,10 +186,10 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="ipfml.html" class="btn btn-neutral float-right" title="ipfml" 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" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="index.html" class="btn btn-neutral" title="IPFML’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</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>
       
     </div>
   

docs/build/html/examples.html

@@ -0,0 +1,280 @@
+
+
+<!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>Examples &mdash; IPFML v0.2.0 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" />
+    <link rel="next" title="Contributing" href="contributing.html" />
+    <link rel="prev" title="Documentation" href="ipfml.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.2.0
+              </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 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 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>
+</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>Examples</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            <a href="_sources/examples.rst.txt" rel="nofollow"> View page source</a>
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="examples">
+<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
+<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="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">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>
+</pre></div>
+</div>
+<p>Now we have picture information with only the 6 low bits values.</p>
+<img alt="_images/nature_low_bits_6.png" src="_images/nature_low_bits_6.png" />
+</div>
+<div class="section" id="noise-filter-example">
+<h2>Noise filter example<a class="headerlink" href="#noise-filter-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.filters</span> <span class="k">import</span> <span class="n">noise</span> <span class="k">as</span> <span class="n">nf</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="c1"># set noise impact to 30</span>
+<span class="n">noisy_image</span> <span class="o">=</span> <span class="n">nf</span><span class="o">.</span><span class="n">gaussian_noise</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">30</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">noisy_image</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>Image result after applying gaussian noise on nature image.</p>
+<img alt="_images/nature_gaussian_noise.png" src="_images/nature_gaussian_noise.png" />
+</div>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <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.html" class="btn btn-neutral" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <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/genindex.html

@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; IPFML v0.1.9 documentation</title>
+  <title>Index &mdash; IPFML v0.2.0 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.1.9
+                0.2.0
               </div>
             
           
@@ -81,10 +81,12 @@
               
             
             
-              <ul>
+              <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">ipfml</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</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="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
             
@@ -165,7 +167,7 @@
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.cauchy_noise">cauchy_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.cauchy_noise">cauchy_noise() (in module ipfml.filters.noise)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -181,7 +183,7 @@
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.gaussian_noise">gaussian_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.gaussian_noise">gaussian_noise() (in module ipfml.filters.noise)</a>
 </li>
       <li><a href="ipfml.html#ipfml.metrics.get_bits_img">get_bits_img() (in module ipfml.metrics)</a>
 </li>
@@ -229,7 +231,7 @@
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
+      <li><a href="ipfml.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -243,11 +245,11 @@
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.laplace_noise">laplace_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.laplace_noise">laplace_noise() (in module ipfml.filters.noise)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.log_normal_noise">log_normal_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.log_normal_noise">log_normal_noise() (in module ipfml.filters.noise)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -255,7 +257,7 @@
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.mut_white_noise">mut_white_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.mut_white_noise">mut_white_noise() (in module ipfml.filters.noise)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -293,7 +295,7 @@
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="ipfml.filters.html#ipfml.filters.noise.white_noise">white_noise() (in module ipfml.filters.noise)</a>
+      <li><a href="ipfml.html#ipfml.filters.noise.white_noise">white_noise() (in module ipfml.filters.noise)</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>IPFML’s documentation! &mdash; IPFML v0.1.9 documentation</title>
+  <title>Image Processing For Machine Learning &mdash; IPFML v0.2.0 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.1.9
+                0.2.0
               </div>
             
           
@@ -81,10 +81,12 @@
               
             
             
-              <ul>
+              <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">ipfml</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</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="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
             
@@ -130,7 +132,7 @@
     
       <li><a href="#">Docs</a> &raquo;</li>
         
-      <li>IPFML’s documentation!</li>
+      <li>Image Processing For Machine Learning</li>
     
     
       <li class="wy-breadcrumbs-aside">
@@ -149,32 +151,40 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="ipfml-s-documentation">
-<h1>IPFML’s documentation!<a class="headerlink" href="#ipfml-s-documentation" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="image-processing-for-machine-learning">
+<h1>Image Processing For Machine Learning<a class="headerlink" href="#image-processing-for-machine-learning" title="Permalink to this headline">¶</a></h1>
+<img alt="_images/ipfml_logo.png" src="_images/ipfml_logo.png" />
+</div>
+<div class="section" id="what-s-ipfml">
+<h1>What’s IPFML ?<a class="headerlink" href="#what-s-ipfml" title="Permalink to this headline">¶</a></h1>
+<p>IPFML is a python ackage developed during a thesis project.</p>
 <div class="toctree-wrapper compound">
+<p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="description.html#installation">Installation</a></li>
 <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">ipfml</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.html#module-ipfml.metrics">ipfml.metrics</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ipfml.html#module-ipfml.processing">ipfml.processing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ipfml.html#ipfml-filters">ipfml.filters</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="ipfml.filters.html#module-ipfml.filters.noise">ipfml.filters.noise</a></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>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="contributing.html#using-github">Using GitHub</a></li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
-<div class="section" id="what-s-ipfml">
-<h1>What’s IPFML ?<a class="headerlink" href="#what-s-ipfml" title="Permalink to this headline">¶</a></h1>
-<p>Image Processing For Machine Learning python package.</p>
-<p>This is a package developed during a thesis project.</p>
-</div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">

docs/build/html/py-modindex.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Python Module Index &mdash; IPFML v0.1.9 documentation</title>
+  <title>Python Module Index &mdash; IPFML v0.2.0 documentation</title>
   
 
   
@@ -59,7 +59,7 @@
             
             
               <div class="version">
-                0.1.9
+                0.2.0
               </div>
             
           
@@ -83,10 +83,12 @@
               
             
             
-              <ul>
+              <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">ipfml</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</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="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
             
@@ -167,7 +169,7 @@
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="ipfml.filters.html#module-ipfml.filters.noise"><code class="xref">ipfml.filters.noise</code></a></td><td>
+       <a href="ipfml.html#module-ipfml.filters.noise"><code class="xref">ipfml.filters.noise</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

docs/build/html/search.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; IPFML v0.1.9 documentation</title>
+  <title>Search &mdash; IPFML v0.2.0 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.1.9
+                0.2.0
               </div>
             
           
@@ -80,10 +80,12 @@
               
             
             
-              <ul>
+              <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">ipfml</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ipfml.filters.html">ipfml.filters</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="examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
 
             

docs/source/conf.py

@@ -24,9 +24,9 @@ copyright = '2019, Jérôme BUISINE'
 author = 'Jérôme BUISINE'
 
 # The short X.Y version
-version = '0.1.9'
+version = '0.2.0'
 # The full versiabson, including alpha/beta/rc tags
-release = 'v0.1.9'
+release = 'v0.2.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/contributing.rst

@@ -0,0 +1,15 @@
+Contributing
+=====================================
+
+.. image:: _static/ipfml_logo.png
+
+
+Using GitHub
+------------
+
+This git project uses git-flow_ implementation. You are free to contribute to it.
+
+.. _git-flow: https://danielkummer.github.io/git-flow-cheatsheet/    
+
+You just have to create your own feature branch and make a pull request.
+

docs/source/description.rst

@@ -1,5 +1,7 @@
 Description
-============
+=====================================
+
+.. image:: _static/ipfml_logo.png
 
 
 Installation
@@ -7,7 +9,9 @@ Installation
 
 Just install package using pip 
 
-   >>> pip install ipfml
+.. code:: bash
+   
+   pip install ipfml
 
 
 How to use ?
@@ -15,9 +19,9 @@ How to use ?
 
 To use, simply do :
 
-    >>> from PIL import Image
-    >>> from ipfml import image_processing
-    >>> img = Image.open('path/to/image.png')
-    >>> s = image_processing.get_LAB_L_SVD_s(img)
-
-
+.. code:: python
+    
+   from PIL import Image
+   from ipfml import processing
+   img = Image.open('path/to/image.png')
+   s = processing.get_LAB_L_SVD_s(img)

docs/source/examples.rst

@@ -0,0 +1,73 @@
+Examples
+=====================================
+
+Some examples are already available into documentation. You can find here some others and results of use of IPFML package.
+
+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
+
+   img_path = 'path/to/image_nature.jpg'
+   img = Image.open(img_path)
+   
+   low_bits_img = processing.rgb_to_grey_low_bits(img, 6)
+   
+   output = Image.fromarray(low_bits_img)
+   output.show()
+
+Now we have picture information with only the 6 low bits values.
+
+.. image:: _static/nature_low_bits_6.png
+
+Noise filter example
+---------------------
+
+.. code:: python
+   
+   from PIL import Image
+   from ipfml.filters import noise as nf
+
+   img_path = 'path/to/image_nature.jpg'
+   img = Image.open(img_path)
+
+   # set noise impact to 30
+   noisy_image = nf.gaussian_noise(img, n=30)
+
+   output = Image.fromarray(noisy_image)
+   output.show()
+   
+Image result after applying gaussian noise on nature image.
+
+.. image:: _static/nature_gaussian_noise.png
+

docs/source/index.rst

@@ -3,23 +3,24 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-IPFML's documentation!
-=================================
+Image Processing For Machine Learning
+=====================================
 
-.. toctree::
-   :maxdepth: 2
-      
-   description
-   ipfml
-   ipfml.filters
+.. image:: _static/ipfml_logo.png
 
 What's IPFML ?
 =================
 
-Image Processing For Machine Learning python package.
+IPFML is a python ackage developed during a thesis project.
 
-This is a package developed during a thesis project.
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
+   description
+   ipfml
+   examples
+   contributing
 
 Indices and tables
 ==================

docs/source/ipfml.filters.rst

@@ -1,10 +0,0 @@
-ipfml.filters
-=====================
-
-ipfml.filters.noise
---------------------------
-
-.. automodule:: ipfml.filters.noise
-    :members:
-    :show-inheritance:
-    

docs/source/ipfml.rst

@@ -1,16 +1,28 @@
-ipfml
+Documentation
 =============
 
 ipfml.metrics
---------------------
+---------------------------
 
 .. automodule:: ipfml.metrics
     :members:
     :show-inheritance:
 
 ipfml.processing
------------------------
+---------------------------
 
 .. automodule:: ipfml.processing
     :members:
     :show-inheritance:
+
+
+ipfml.filters
+---------------------------
+
+ipfml.filters.noise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: ipfml.filters.noise
+    :members:
+    :show-inheritance:
+ 

setup.py

@@ -43,7 +43,7 @@ class BuildTestCommand(setuptools.command.build_py.build_py):
 
 setup(
     name='ipfml',
-    version='0.1.9',
+    version='0.2.0',
     description='Image Processing For Machine Learning',
     long_description=readme(),
     classifiers=[