Browse Source

Contributing file update such as documentation

Jérôme BUISINE 1 year ago
parent
commit
f0d4cc32f9
53 changed files with 1488 additions and 78 deletions
  1. 5 0
      CONTRIBUTING.md
  2. 3 3
      README.md
  3. 1 1
      README.rst
  4. BIN
      docs/build/doctrees/environment.pickle
  5. BIN
      docs/build/doctrees/ipfml.doctree
  6. BIN
      docs/build/doctrees/ipfml/ipfml.filters.convolution.doctree
  7. BIN
      docs/build/doctrees/ipfml/ipfml.filters.kernels.doctree
  8. 1 1
      docs/build/html/.buildinfo
  9. 4 2
      docs/build/html/_modules/index.html
  10. 2 2
      docs/build/html/_modules/ipfml/exceptions.html
  11. 268 0
      docs/build/html/_modules/ipfml/filters/convolution.html
  12. 379 0
      docs/build/html/_modules/ipfml/filters/kernels.html
  13. 2 2
      docs/build/html/_modules/ipfml/filters/noise.html
  14. 2 2
      docs/build/html/_modules/ipfml/iqa/fr.html
  15. 2 2
      docs/build/html/_modules/ipfml/metrics.html
  16. 2 2
      docs/build/html/_modules/ipfml/processing/compression.html
  17. 2 2
      docs/build/html/_modules/ipfml/processing/movement.html
  18. 2 2
      docs/build/html/_modules/ipfml/processing/reconstruction.html
  19. 2 2
      docs/build/html/_modules/ipfml/processing/segmentation.html
  20. 2 2
      docs/build/html/_modules/ipfml/processing/transform.html
  21. 2 2
      docs/build/html/_modules/ipfml/utils.html
  22. 3 1
      docs/build/html/_sources/ipfml.rst.txt
  23. 22 0
      docs/build/html/_sources/ipfml/ipfml.filters.convolution.rst.txt
  24. 24 0
      docs/build/html/_sources/ipfml/ipfml.filters.kernels.rst.txt
  25. 1 1
      docs/build/html/_static/documentation_options.js
  26. 2 2
      docs/build/html/contributing.html
  27. 2 2
      docs/build/html/description.html
  28. 2 2
      docs/build/html/examples.html
  29. 26 5
      docs/build/html/genindex.html
  30. 4 2
      docs/build/html/index.html
  31. 10 2
      docs/build/html/ipfml.html
  32. 4 4
      docs/build/html/ipfml/ipfml.exceptions.html
  33. 280 0
      docs/build/html/ipfml/ipfml.filters.convolution.html
  34. 337 0
      docs/build/html/ipfml/ipfml.filters.kernels.html
  35. 6 4
      docs/build/html/ipfml/ipfml.filters.noise.html
  36. 2 2
      docs/build/html/ipfml/ipfml.iqa.fr.html
  37. 2 2
      docs/build/html/ipfml/ipfml.metrics.html
  38. 2 2
      docs/build/html/ipfml/ipfml.processing.compression.html
  39. 2 2
      docs/build/html/ipfml/ipfml.processing.movement.html
  40. 2 2
      docs/build/html/ipfml/ipfml.processing.reconstruction.html
  41. 2 2
      docs/build/html/ipfml/ipfml.processing.segmentation.html
  42. 2 2
      docs/build/html/ipfml/ipfml.processing.transform.html
  43. 2 2
      docs/build/html/ipfml/ipfml.utils.html
  44. BIN
      docs/build/html/objects.inv
  45. 12 2
      docs/build/html/py-modindex.html
  46. 2 2
      docs/build/html/search.html
  47. 1 1
      docs/build/html/searchindex.js
  48. 2 2
      docs/source/conf.py
  49. 3 1
      docs/source/ipfml.rst
  50. 22 0
      docs/source/ipfml/ipfml.filters.convolution.rst
  51. 24 0
      docs/source/ipfml/ipfml.filters.kernels.rst
  52. 1 1
      ipfml/filters/convolution.py
  53. 1 1
      setup.py

+ 5 - 0
CONTRIBUTING.md

@@ -143,6 +143,11 @@ This command do a lot of thing for you:
 
 Do not forget to build documentation as explained in section [2.3](#code-documentation).
 
+Or directly use bash script which runs all you need:
+
+```bash
+bash build.sh
+```
 
 ## Pull request
 

+ 3 - 3
README.md

@@ -32,7 +32,7 @@ This project contains modules.
 - **metrics** : *Metrics computation for model performance*
 - **utils** : *All utils functions developed for the package*
 - **exceptions** : *All customized exceptions*
-- **filters** : *Image filter module*
+- **filters** : *Image filter module with convolution*
 - **iqa** : *Image quality assessments*
 - **processing** : *Image processing module*
 
@@ -41,7 +41,7 @@ All these modules will be enhanced during development of the package. Documentat
 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](CONTRIBUTING.md) file if you want to contribute!
 
 ## Contributors
 
@@ -49,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](LICENSE)

+ 1 - 1
README.rst

@@ -31,7 +31,7 @@ This project contains modules.
 - **metrics** : *Metrics computation for model performance*
 - **utils** : *All utils functions developed for the package*
 - **exceptions** : *All customized exceptions*
-- **filters** : *Image filter module*
+- **filters** : *Image filter module with convolution*
 - **iqa** : *Image quality assessments*
 - **processing** : *Image processing module*
 

BIN
docs/build/doctrees/environment.pickle


BIN
docs/build/doctrees/ipfml.doctree


BIN
docs/build/doctrees/ipfml/ipfml.filters.convolution.doctree


BIN
docs/build/doctrees/ipfml/ipfml.filters.kernels.doctree


+ 1 - 1
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: ab7df74f90d59db7127f81213334c1ef
+config: 37aa5d24da7c15a63553a5371e611c5e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

+ 4 - 2
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.3 documentation</title>
+  <title>Overview: module code &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -148,6 +148,8 @@
             
   <h1>All modules for which code is available</h1>
 <ul><li><a href="ipfml/exceptions.html">ipfml.exceptions</a></li>
+<li><a href="ipfml/filters/convolution.html">ipfml.filters.convolution</a></li>
+<li><a href="ipfml/filters/kernels.html">ipfml.filters.kernels</a></li>
 <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>

+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.exceptions &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

File diff suppressed because it is too large
+ 268 - 0
docs/build/html/_modules/ipfml/filters/convolution.html


File diff suppressed because it is too large
+ 379 - 0
docs/build/html/_modules/ipfml/filters/kernels.html


+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.filters.noise &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.iqa.fr &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/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.3 documentation</title>
+  <title>ipfml.metrics &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/ipfml/processing/compression.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.compression &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.compression &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/ipfml/processing/movement.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.movement &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.movement &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/ipfml/processing/reconstruction.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.reconstruction &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.reconstruction &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/ipfml/processing/segmentation.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.segmentation &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.segmentation &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/_modules/ipfml/processing/transform.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.transform &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.transform &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.utils &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 3 - 1
docs/build/html/_sources/ipfml.rst.txt

@@ -13,7 +13,9 @@ ipfml.filters
 
 .. autosummary::
    :toctree: ipfml
-  
+   
+   ipfml.filters.convolution
+   ipfml.filters.kernels
    ipfml.filters.noise
 
 ipfml.iqa

+ 22 - 0
docs/build/html/_sources/ipfml/ipfml.filters.convolution.rst.txt

@@ -0,0 +1,22 @@
+ipfml.filters.convolution
+=========================
+
+.. automodule:: ipfml.filters.convolution
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      convolution2D
+   
+   
+
+   
+   
+   
+
+   
+   
+   

+ 24 - 0
docs/build/html/_sources/ipfml/ipfml.filters.kernels.rst.txt

@@ -0,0 +1,24 @@
+ipfml.filters.kernels
+=====================
+
+.. automodule:: ipfml.filters.kernels
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      bilateral_diff
+      plane_max_error
+      plane_mean
+   
+   
+
+   
+   
+   
+
+   
+   
+   

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

+ 2 - 2
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.3 documentation</title>
+  <title>Contributing &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
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.3 documentation</title>
+  <title>Description &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
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.3 documentation</title>
+  <title>Examples &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 26 - 5
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.3 documentation</title>
+  <title>Index &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -157,7 +157,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
@@ -172,6 +173,14 @@
  | <a href="#W"><strong>W</strong></a>
  
 </div>
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ipfml/ipfml.filters.kernels.html#ipfml.filters.kernels.bilateral_diff">bilateral_diff() (in module ipfml.filters.kernels)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -180,6 +189,8 @@
   </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>
+      <li><a href="ipfml/ipfml.filters.convolution.html#ipfml.filters.convolution.convolution2D">convolution2D() (in module ipfml.filters.convolution)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -275,12 +286,16 @@
 </li>
       <li><a href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions">ipfml.exceptions (module)</a>
 </li>
-      <li><a href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
+      <li><a href="ipfml/ipfml.filters.convolution.html#module-ipfml.filters.convolution">ipfml.filters.convolution (module)</a>
 </li>
-      <li><a href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr">ipfml.iqa.fr (module)</a>
+      <li><a href="ipfml/ipfml.filters.kernels.html#module-ipfml.filters.kernels">ipfml.filters.kernels (module)</a>
+</li>
+      <li><a href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise">ipfml.filters.noise (module)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr">ipfml.iqa.fr (module)</a>
+</li>
       <li><a href="ipfml/ipfml.metrics.html#module-ipfml.metrics">ipfml.metrics (module)</a>
 </li>
       <li><a href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression">ipfml.processing.compression (module)</a>
@@ -347,6 +362,12 @@
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ipfml/ipfml.filters.kernels.html#ipfml.filters.kernels.plane_max_error">plane_max_error() (in module ipfml.filters.kernels)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ipfml/ipfml.filters.kernels.html#ipfml.filters.kernels.plane_mean">plane_mean() (in module ipfml.filters.kernels)</a>
+</li>
       <li><a href="ipfml/ipfml.iqa.fr.html#ipfml.iqa.fr.psnr">psnr() (in module ipfml.iqa.fr)</a>
 </li>
   </ul></td>

+ 4 - 2
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.3 documentation</title>
+  <title>Image Processing For Machine Learning &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -173,6 +173,8 @@
 <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>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.kernels.html">ipfml.filters.kernels</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.noise.html">ipfml.filters.noise</a></li>
 </ul>
 </li>

+ 10 - 2
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.3 documentation</title>
+  <title>Documentation &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -90,6 +90,8 @@
 <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>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.kernels.html">ipfml.filters.kernels</a></li>
 <li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.filters.noise.html">ipfml.filters.noise</a></li>
 </ul>
 </li>
@@ -202,6 +204,12 @@
 <col width="90%" />
 </colgroup>
 <tbody valign="top">
+<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.filters.convolution.html#module-ipfml.filters.convolution" title="ipfml.filters.convolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.convolution</span></code></a></td>
+<td>Convolution functions to apply on images</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.filters.kernels.html#module-ipfml.filters.kernels" title="ipfml.filters.kernels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.kernels</span></code></a></td>
+<td>Kernel to apply on images using convolution</td>
+</tr>
 <tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.filters.noise.html#module-ipfml.filters.noise" title="ipfml.filters.noise"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.filters.noise</span></code></a></td>
 <td>Noise filters to apply on images</td>
 </tr>

+ 4 - 4
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.3 documentation</title>
+  <title>ipfml.exceptions &mdash; ipfml v0.4.4 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="ipfml.filters.noise" href="ipfml.filters.noise.html" />
+    <link rel="next" title="ipfml.filters.convolution" href="ipfml.filters.convolution.html" />
     <link rel="prev" title="ipfml.utils" href="ipfml.utils.html" /> 
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -204,7 +204,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="ipfml.filters.noise.html" class="btn btn-neutral float-right" title="ipfml.filters.noise" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="ipfml.filters.convolution.html" class="btn btn-neutral float-right" title="ipfml.filters.convolution" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="ipfml.utils.html" class="btn btn-neutral" title="ipfml.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

+ 280 - 0
docs/build/html/ipfml/ipfml.filters.convolution.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>ipfml.filters.convolution &mdash; ipfml v0.4.4 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="ipfml.filters.kernels" href="ipfml.filters.kernels.html" />
+    <link rel="prev" title="ipfml.exceptions" href="ipfml.exceptions.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.4
+              </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 current"><a class="reference internal" href="../ipfml.html">Documentation</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.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">
+<li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.filters.convolution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.kernels.html">ipfml.filters.kernels</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.noise.html">ipfml.filters.noise</a></li>
+</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>
+<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="../ipfml.html">Documentation</a> &raquo;</li>
+        
+      <li>ipfml.filters.convolution</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.filters.convolution.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="module-ipfml.filters.convolution">
+<span id="ipfml-filters-convolution"></span><h1>ipfml.filters.convolution<a class="headerlink" href="#module-ipfml.filters.convolution" title="Permalink to this headline">¶</a></h1>
+<p>Convolution functions to apply on images</p>
+<p class="rubric">Functions</p>
+<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.filters.convolution.convolution2D" title="ipfml.filters.convolution.convolution2D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convolution2D</span></code></a>(image,&nbsp;kernel[,&nbsp;kernel_size])</td>
+<td>Apply 2D convolution on image using specific kernel from <cite>ipfml.filters.kernels</cite></td>
+</tr>
+</tbody>
+</table>
+<dl class="function">
+<dt id="ipfml.filters.convolution.convolution2D">
+<code class="descclassname">ipfml.filters.convolution.</code><code class="descname">convolution2D</code><span class="sig-paren">(</span><em>image</em>, <em>kernel</em>, <em>kernel_size=(5</em>, <em>5)</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/convolution.html#convolution2D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.convolution.convolution2D" title="Permalink to this definition">¶</a></dt>
+<dd><p>Apply 2D convolution on image using specific kernel from <cite>ipfml.filters.kernels</cite></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"><ul class="first simple">
+<li><strong>image</strong> – 2D image to apply convolution on</li>
+<li><strong>kernel</strong> – specific kernel from <cite>ipfml.filters.kernels</cite> to use</li>
+<li><strong>kernel_size</strong> – window size to use (default (5, 5))</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">2D numpy array obtained from image using kernel</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</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">ipfml.filters.convolution</span> <span class="k">import</span> <span class="n">convolution2D</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">plane_mean</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">image</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">81</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">9</span><span class="p">,</span> <span class="mi">9</span><span class="p">])</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">convolved_image</span> <span class="o">=</span> <span class="n">convolution2D</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">plane_mean</span><span class="p">,</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">convolved_image</span><span class="o">.</span><span class="n">shape</span>
+<span class="go">(7, 7)</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="ipfml.filters.kernels.html" class="btn btn-neutral float-right" title="ipfml.filters.kernels" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="ipfml.exceptions.html" class="btn btn-neutral" title="ipfml.exceptions" 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>

+ 337 - 0
docs/build/html/ipfml/ipfml.filters.kernels.html

@@ -0,0 +1,337 @@
+
+
+<!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.filters.kernels &mdash; ipfml v0.4.4 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="ipfml.filters.noise" href="ipfml.filters.noise.html" />
+    <link rel="prev" title="ipfml.filters.convolution" href="ipfml.filters.convolution.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.4
+              </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 current"><a class="reference internal" href="../ipfml.html">Documentation</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.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">
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.filters.kernels</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.noise.html">ipfml.filters.noise</a></li>
+</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>
+<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="../ipfml.html">Documentation</a> &raquo;</li>
+        
+      <li>ipfml.filters.kernels</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.filters.kernels.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="module-ipfml.filters.kernels">
+<span id="ipfml-filters-kernels"></span><h1>ipfml.filters.kernels<a class="headerlink" href="#module-ipfml.filters.kernels" title="Permalink to this headline">¶</a></h1>
+<p>Kernel to apply on images using convolution</p>
+<p class="rubric">Functions</p>
+<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.filters.kernels.bilateral_diff" title="ipfml.filters.kernels.bilateral_diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bilateral_diff</span></code></a>(window[,&nbsp;func])</td>
+<td>Bilaeral difference kernel to use with convolution process on image</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_max_error" title="ipfml.filters.kernels.plane_max_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_max_error</span></code></a>(window)</td>
+<td>Plane max error kernel to use with convolution process on image</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="#ipfml.filters.kernels.plane_mean" title="ipfml.filters.kernels.plane_mean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plane_mean</span></code></a>(window)</td>
+<td>Plane mean kernel to use with convolution process on image</td>
+</tr>
+</tbody>
+</table>
+<dl class="function">
+<dt id="ipfml.filters.kernels.bilateral_diff">
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">bilateral_diff</code><span class="sig-paren">(</span><em>window</em>, <em>func=&lt;built-in function max&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#bilateral_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.bilateral_diff" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="docutils">
+<dt>Bilaeral difference kernel to use with convolution process on image</dt>
+<dd>Apply difference pixel to pixel and keep max on min difference before applying mean</dd>
+</dl>
+<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"><ul class="first simple">
+<li><strong>window</strong> – the window part to use from image</li>
+<li><strong>func</strong> – max or min function to get difference between pixels</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">mean of max or min difference of pixels</p>
+</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</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">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">bilateral_diff</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">window</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">bilateral_diff</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span>
+<span class="go">3.0</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="ipfml.filters.kernels.plane_max_error">
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">plane_max_error</code><span class="sig-paren">(</span><em>window</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#plane_max_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.plane_max_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Plane max error kernel to use with convolution process on image</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>window</strong> – the window part to use from image</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Difference between max and min error from mean plane</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</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">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">plane_max_error</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">window</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">plane_max_error</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">result</span> <span class="o">&lt;</span> <span class="mf">0.0001</span><span class="p">)</span>
+<span class="go">True</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="ipfml.filters.kernels.plane_mean">
+<code class="descclassname">ipfml.filters.kernels.</code><code class="descname">plane_mean</code><span class="sig-paren">(</span><em>window</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/filters/kernels.html#plane_mean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.filters.kernels.plane_mean" title="Permalink to this definition">¶</a></dt>
+<dd><p>Plane mean kernel to use with convolution process on image</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>window</strong> – the window part to use from image</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Normalized residual error from mean plane</td>
+</tr>
+</tbody>
+</table>
+<p>Example:</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">ipfml.filters.kernels</span> <span class="k">import</span> <span class="n">plane_mean</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">window</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">9</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">result</span> <span class="o">=</span> <span class="n">plane_mean</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">result</span> <span class="o">&lt;</span> <span class="mf">0.0001</span><span class="p">)</span>
+<span class="go">True</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="ipfml.filters.noise.html" class="btn btn-neutral float-right" title="ipfml.filters.noise" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="ipfml.filters.convolution.html" class="btn btn-neutral" title="ipfml.filters.convolution" 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>

+ 6 - 4
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.3 documentation</title>
+  <title>ipfml.filters.noise &mdash; ipfml v0.4.4 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="ipfml.iqa.fr" href="ipfml.iqa.fr.html" />
-    <link rel="prev" title="ipfml.exceptions" href="ipfml.exceptions.html" /> 
+    <link rel="prev" title="ipfml.filters.kernels" href="ipfml.filters.kernels.html" /> 
 
   
   <script src="../_static/js/modernizr.min.js"></script>
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -90,6 +90,8 @@
 <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">
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.convolution.html">ipfml.filters.convolution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ipfml.filters.kernels.html">ipfml.filters.kernels</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.filters.noise</a></li>
 </ul>
 </li>
@@ -444,7 +446,7 @@
         <a href="ipfml.iqa.fr.html" class="btn btn-neutral float-right" title="ipfml.iqa.fr" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="ipfml.exceptions.html" class="btn btn-neutral" title="ipfml.exceptions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="ipfml.filters.kernels.html" class="btn btn-neutral" title="ipfml.filters.kernels" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.iqa.fr &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
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.3 documentation</title>
+  <title>ipfml.metrics &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/ipfml.processing.compression.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.compression &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.compression &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/ipfml.processing.movement.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.movement &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.movement &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/ipfml.processing.reconstruction.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.reconstruction &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.reconstruction &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/ipfml.processing.segmentation.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.segmentation &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.segmentation &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/ipfml.processing.transform.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>ipfml.processing.transform &mdash; ipfml v0.4.3 documentation</title>
+  <title>ipfml.processing.transform &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml/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.3 documentation</title>
+  <title>ipfml.utils &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

BIN
docs/build/html/objects.inv


+ 12 - 2
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.4.3 documentation</title>
+  <title>Python Module Index &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -59,7 +59,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           
@@ -171,6 +171,16 @@
        <td>&#160;&#160;&#160;
        <a href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions"><code class="xref">ipfml.exceptions</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="ipfml/ipfml.filters.convolution.html#module-ipfml.filters.convolution"><code class="xref">ipfml.filters.convolution</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="ipfml/ipfml.filters.kernels.html#module-ipfml.filters.kernels"><code class="xref">ipfml.filters.kernels</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

+ 2 - 2
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.4.3 documentation</title>
+  <title>Search &mdash; ipfml v0.4.4 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.4.3
+                0.4.4
               </div>
             
           

File diff suppressed because it is too large
+ 1 - 1
docs/build/html/searchindex.js


+ 2 - 2
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.4.3'
+version = '0.4.4'
 # The full version, including alpha/beta/rc tags
-release = 'v0.4.3'
+release = 'v0.4.4'
 
 
 # -- General configuration ---------------------------------------------------

+ 3 - 1
docs/source/ipfml.rst

@@ -13,7 +13,9 @@ ipfml.filters
 
 .. autosummary::
    :toctree: ipfml
-  
+   
+   ipfml.filters.convolution
+   ipfml.filters.kernels
    ipfml.filters.noise
 
 ipfml.iqa

+ 22 - 0
docs/source/ipfml/ipfml.filters.convolution.rst

@@ -0,0 +1,22 @@
+ipfml.filters.convolution
+=========================
+
+.. automodule:: ipfml.filters.convolution
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      convolution2D
+   
+   
+
+   
+   
+   
+
+   
+   
+   

+ 24 - 0
docs/source/ipfml/ipfml.filters.kernels.rst

@@ -0,0 +1,24 @@
+ipfml.filters.kernels
+=====================
+
+.. automodule:: ipfml.filters.kernels
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      bilateral_diff
+      plane_max_error
+      plane_mean
+   
+   
+
+   
+   
+   
+
+   
+   
+   

+ 1 - 1
ipfml/filters/convolution.py

@@ -12,7 +12,7 @@ def convolution2D(image, kernel, kernel_size=(5, 5)):
     Args:
         image: 2D image to apply convolution on
         kernel: specific kernel from `ipfml.filters.kernels` to use
-        kernel_size: 
+        kernel_size: window size to use (default (5, 5))
 
     Returns:
         2D numpy array obtained from image using kernel

+ 1 - 1
setup.py

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