description.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>Description &mdash; IPFML v0.2.6 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="genindex.html" />
  11. <link rel="search" title="Search" href="search.html" />
  12. <link rel="next" title="Documentation" href="ipfml.html" />
  13. <link rel="prev" title="Image Processing For Machine Learning" href="index.html" />
  14. <script src="_static/js/modernizr.min.js"></script>
  15. </head>
  16. <body class="wy-body-for-nav">
  17. <div class="wy-grid-for-nav">
  18. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  19. <div class="wy-side-scroll">
  20. <div class="wy-side-nav-search">
  21. <a href="index.html" class="icon icon-home"> IPFML
  22. </a>
  23. <div class="version">
  24. 0.2.6
  25. </div>
  26. <div role="search">
  27. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  28. <input type="text" name="q" placeholder="Search docs" />
  29. <input type="hidden" name="check_keywords" value="yes" />
  30. <input type="hidden" name="area" value="default" />
  31. </form>
  32. </div>
  33. </div>
  34. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  35. <p class="caption"><span class="caption-text">Contents:</span></p>
  36. <ul class="current">
  37. <li class="toctree-l1 current"><a class="current reference internal" href="#">Description</a><ul>
  38. <li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
  39. <li class="toctree-l2"><a class="reference internal" href="#how-to-use">How to use ?</a></li>
  40. </ul>
  41. </li>
  42. <li class="toctree-l1"><a class="reference internal" href="ipfml.html">Documentation</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
  45. </ul>
  46. </div>
  47. </div>
  48. </nav>
  49. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  50. <nav class="wy-nav-top" aria-label="top navigation">
  51. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  52. <a href="index.html">IPFML</a>
  53. </nav>
  54. <div class="wy-nav-content">
  55. <div class="rst-content">
  56. <div role="navigation" aria-label="breadcrumbs navigation">
  57. <ul class="wy-breadcrumbs">
  58. <li><a href="index.html">Docs</a> &raquo;</li>
  59. <li>Description</li>
  60. <li class="wy-breadcrumbs-aside">
  61. <a href="https://github.com/jbuisine/IPFML/blob/master/docs/source/description.rst" class="fa fa-github"> Edit on GitHub</a>
  62. </li>
  63. </ul>
  64. <hr/>
  65. </div>
  66. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  67. <div itemprop="articleBody">
  68. <div class="section" id="description">
  69. <h1>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h1>
  70. <a class="reference internal image-reference" href="_images/ipfml_logo.png"><img alt="_images/ipfml_logo.png" class="align-center" src="_images/ipfml_logo.png" style="width: 400px;" /></a>
  71. <div class="section" id="installation">
  72. <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
  73. <p>Just install package using pip</p>
  74. <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>
  75. </pre></div>
  76. </div>
  77. </div>
  78. <div class="section" id="how-to-use">
  79. <h2>How to use ?<a class="headerlink" href="#how-to-use" title="Permalink to this headline">¶</a></h2>
  80. <p>To use, simply do :</p>
  81. <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>
  82. <span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">processing</span>
  83. <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>
  84. <span class="n">s</span> <span class="o">=</span> <span class="n">processing</span><span class="o">.</span><span class="n">get_LAB_L_SVD_s</span><span class="p">(</span><span class="n">img</span><span class="p">)</span>
  85. </pre></div>
  86. </div>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. <footer>
  92. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  93. <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>
  94. <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>
  95. </div>
  96. <hr/>
  97. <div role="contentinfo">
  98. <p>
  99. &copy; Copyright 2019, Jérôme BUISINE
  100. </p>
  101. </div>
  102. 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>.
  103. </footer>
  104. </div>
  105. </div>
  106. </section>
  107. </div>
  108. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  109. <script type="text/javascript" src="_static/jquery.js"></script>
  110. <script type="text/javascript" src="_static/underscore.js"></script>
  111. <script type="text/javascript" src="_static/doctools.js"></script>
  112. <script type="text/javascript" src="_static/language_data.js"></script>
  113. <script type="text/javascript" src="_static/js/theme.js"></script>
  114. <script type="text/javascript">
  115. jQuery(function () {
  116. SphinxRtdTheme.Navigation.enable(true);
  117. });
  118. </script>
  119. </body>
  120. </html>