Prise3D
/
ipfml


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
							

<!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>Documentation &mdash; ipfml v0.4.8 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.metrics" href="ipfml/ipfml.metrics.html" />
    <link rel="prev" title="Description" href="description.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.8
              </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="current reference internal" href="#">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.metrics.html">ipfml.metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipfml/ipfml.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>
<li class="toctree-l2"><a class="reference internal" href="#ipfml-iqa">ipfml.iqa</a><ul>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.iqa.fr.html">ipfml.iqa.fr</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ipfml-processing">ipfml.processing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.compression.html">ipfml.processing.compression</a></li>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.movement.html">ipfml.processing.movement</a></li>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="ipfml/ipfml.processing.transform.html">ipfml.processing.transform</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<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>Documentation</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
              <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml.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="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.metrics.html#module-ipfml.metrics" title="ipfml.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.metrics</span></code></a></td>
<td>Contains all metrics used for model results comparisons</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.utils.html#module-ipfml.utils" title="ipfml.utils"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.utils</span></code></a></td>
<td>Utils functions of ipfml package (normalization, integral…)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.exceptions.html#module-ipfml.exceptions" title="ipfml.exceptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.exceptions</span></code></a></td>
<td>Module which contains all customs Exceptions used into ipfml package</td>
</tr>
</tbody>
</table>
<div class="section" id="ipfml-filters">
<h2>ipfml.filters<a class="headerlink" href="#ipfml-filters" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.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>
</tbody>
</table>
</div>
<div class="section" id="ipfml-iqa">
<h2>ipfml.iqa<a class="headerlink" href="#ipfml-iqa" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.iqa.fr.html#module-ipfml.iqa.fr" title="ipfml.iqa.fr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.iqa.fr</span></code></a></td>
<td>Full-reference Image Quality Assessment (FR-IQA) methods</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="ipfml-processing">
<h2>ipfml.processing<a class="headerlink" href="#ipfml-processing" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.compression.html#module-ipfml.processing.compression" title="ipfml.processing.compression"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.compression</span></code></a></td>
<td>Functions for image compression and extraction</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.movement.html#module-ipfml.processing.movement" title="ipfml.processing.movement"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.movement</span></code></a></td>
<td>All movements that can be applied on image such as rotations, fusions, flips</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.reconstruction.html#module-ipfml.processing.reconstruction" title="ipfml.processing.reconstruction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.reconstruction</span></code></a></td>
<td>Functions for reconstruction process of image using reduction/compression methods</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ipfml/ipfml.processing.segmentation.html#module-ipfml.processing.segmentation" title="ipfml.processing.segmentation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.segmentation</span></code></a></td>
<td>All segmentation methods applied on images</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ipfml/ipfml.processing.transform.html#module-ipfml.processing.transform" title="ipfml.processing.transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipfml.processing.transform</span></code></a></td>
<td>Functions which can be used to extract information from image or reduce it</td>
</tr>
</tbody>
</table>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="ipfml/ipfml.metrics.html" class="btn btn-neutral float-right" title="ipfml.metrics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="description.html" class="btn btn-neutral" title="Description" 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>