ipfml.processing.movement.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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>ipfml.processing.movement &mdash; ipfml v0.4.4 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="ipfml.processing.reconstruction" href="ipfml.processing.reconstruction.html" />
  13. <link rel="prev" title="ipfml.processing.compression" href="ipfml.processing.compression.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.4.4
  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"><a class="reference internal" href="../description.html">Description</a></li>
  38. <li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation</a><ul class="current">
  39. <li class="toctree-l2"><a class="reference internal" href="ipfml.metrics.html">ipfml.metrics</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
  44. <li class="toctree-l2 current"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a><ul class="current">
  45. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.compression.html">ipfml.processing.compression</a></li>
  46. <li class="toctree-l3 current"><a class="current reference internal" href="#">ipfml.processing.movement</a></li>
  47. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.reconstruction.html">ipfml.processing.reconstruction</a></li>
  48. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.segmentation.html">ipfml.processing.segmentation</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="ipfml.processing.transform.html">ipfml.processing.transform</a></li>
  50. </ul>
  51. </li>
  52. </ul>
  53. </li>
  54. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  56. </ul>
  57. </div>
  58. </div>
  59. </nav>
  60. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  61. <nav class="wy-nav-top" aria-label="top navigation">
  62. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  63. <a href="../index.html">ipfml</a>
  64. </nav>
  65. <div class="wy-nav-content">
  66. <div class="rst-content">
  67. <div role="navigation" aria-label="breadcrumbs navigation">
  68. <ul class="wy-breadcrumbs">
  69. <li><a href="../index.html">Docs</a> &raquo;</li>
  70. <li><a href="../ipfml.html">Documentation</a> &raquo;</li>
  71. <li>ipfml.processing.movement</li>
  72. <li class="wy-breadcrumbs-aside">
  73. <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.processing.movement.rst" class="fa fa-github"> Edit on GitHub</a>
  74. </li>
  75. </ul>
  76. <hr/>
  77. </div>
  78. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  79. <div itemprop="articleBody">
  80. <div class="section" id="module-ipfml.processing.movement">
  81. <span id="ipfml-processing-movement"></span><h1>ipfml.processing.movement<a class="headerlink" href="#module-ipfml.processing.movement" title="Permalink to this headline">¶</a></h1>
  82. <p>All movements that can be applied on image such as rotations, fusions, flips</p>
  83. <p class="rubric">Functions</p>
  84. <table border="1" class="longtable docutils">
  85. <colgroup>
  86. <col width="10%" />
  87. <col width="90%" />
  88. </colgroup>
  89. <tbody valign="top">
  90. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.processing.movement.fusion_images" title="ipfml.processing.movement.fusion_images"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fusion_images</span></code></a>(images[,&nbsp;pil])</td>
  91. <td>Fusion array of images into single image</td>
  92. </tr>
  93. <tr class="row-even"><td><a class="reference internal" href="#ipfml.processing.movement.rotate_image" title="ipfml.processing.movement.rotate_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rotate_image</span></code></a>(image[,&nbsp;angle,&nbsp;pil])</td>
  94. <td>Rotate image using specific angle</td>
  95. </tr>
  96. </tbody>
  97. </table>
  98. <dl class="function">
  99. <dt id="ipfml.processing.movement.fusion_images">
  100. <code class="descclassname">ipfml.processing.movement.</code><code class="descname">fusion_images</code><span class="sig-paren">(</span><em>images</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/movement.html#fusion_images"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.movement.fusion_images" title="Permalink to this definition">¶</a></dt>
  101. <dd><p>Fusion array of images into single image</p>
  102. <table class="docutils field-list" frame="void" rules="none">
  103. <col class="field-name" />
  104. <col class="field-body" />
  105. <tbody valign="top">
  106. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  107. <li><strong>images</strong> – array of images (PIL Image or Numpy array)</li>
  108. <li><strong>pil</strong> – block type returned as PIL Image (default True)</li>
  109. </ul>
  110. </td>
  111. </tr>
  112. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">merged image from array of images</p>
  113. </td>
  114. </tr>
  115. <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
  116. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if <cite>images</cite> is not an array or is empty</li>
  117. <li><code class="xref py py-exc docutils literal notranslate"><span class="pre">NumpyShapeComparisonException</span></code> – if <cite>images</cite> array contains images with different shapes</li>
  118. </ul>
  119. </td>
  120. </tr>
  121. </tbody>
  122. </table>
  123. <p>Example:</p>
  124. <div class="highlight-default notranslate"><div class="highlight"><pre><span></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>
  125. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">movement</span>
  126. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values_1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
  127. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values_2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">255</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">800</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
  128. <span class="gp">&gt;&gt;&gt; </span><span class="n">merged_image</span> <span class="o">=</span> <span class="n">movement</span><span class="o">.</span><span class="n">fusion_images</span><span class="p">([</span><span class="n">image_values_1</span><span class="p">,</span> <span class="n">image_values_2</span><span class="p">],</span> <span class="n">pil</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  129. <span class="gp">&gt;&gt;&gt; </span><span class="n">merged_image</span><span class="o">.</span><span class="n">shape</span>
  130. <span class="go">(800, 800, 3)</span>
  131. </pre></div>
  132. </div>
  133. </dd></dl>
  134. <dl class="function">
  135. <dt id="ipfml.processing.movement.rotate_image">
  136. <code class="descclassname">ipfml.processing.movement.</code><code class="descname">rotate_image</code><span class="sig-paren">(</span><em>image</em>, <em>angle=90</em>, <em>pil=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/processing/movement.html#rotate_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.processing.movement.rotate_image" title="Permalink to this definition">¶</a></dt>
  137. <dd><p>Rotate image using specific angle</p>
  138. <table class="docutils field-list" frame="void" rules="none">
  139. <col class="field-name" />
  140. <col class="field-body" />
  141. <tbody valign="top">
  142. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  143. <li><strong>image</strong> – PIL Image or Numpy array</li>
  144. <li><strong>angle</strong> – Angle value of the rotation</li>
  145. <li><strong>pil</strong> – block type returned as PIL Image (default True)</li>
  146. </ul>
  147. </td>
  148. </tr>
  149. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Image with rotation applied</p>
  150. </td>
  151. </tr>
  152. </tbody>
  153. </table>
  154. <p>Example:</p>
  155. <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>
  156. <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>
  157. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml.processing</span> <span class="k">import</span> <span class="n">movement</span>
  158. <span class="gp">&gt;&gt;&gt; </span><span class="n">image_values</span> <span class="o">=</span> <span class="n">Image</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;./images/test_img.png&#39;</span><span class="p">)</span>
  159. <span class="gp">&gt;&gt;&gt; </span><span class="n">rotated_image</span> <span class="o">=</span> <span class="n">movement</span><span class="o">.</span><span class="n">rotate_image</span><span class="p">(</span><span class="n">image_values</span><span class="p">,</span> <span class="mi">90</span><span class="p">,</span> <span class="n">pil</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
  160. <span class="gp">&gt;&gt;&gt; </span><span class="n">rotated_image</span><span class="o">.</span><span class="n">shape</span>
  161. <span class="go">(200, 200, 3)</span>
  162. </pre></div>
  163. </div>
  164. </dd></dl>
  165. </div>
  166. </div>
  167. </div>
  168. <footer>
  169. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  170. <a href="ipfml.processing.reconstruction.html" class="btn btn-neutral float-right" title="ipfml.processing.reconstruction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  171. <a href="ipfml.processing.compression.html" class="btn btn-neutral" title="ipfml.processing.compression" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  172. </div>
  173. <hr/>
  174. <div role="contentinfo">
  175. <p>
  176. &copy; Copyright 2019, Jérôme BUISINE
  177. </p>
  178. </div>
  179. 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>.
  180. </footer>
  181. </div>
  182. </div>
  183. </section>
  184. </div>
  185. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  186. <script type="text/javascript" src="../_static/jquery.js"></script>
  187. <script type="text/javascript" src="../_static/underscore.js"></script>
  188. <script type="text/javascript" src="../_static/doctools.js"></script>
  189. <script type="text/javascript" src="../_static/language_data.js"></script>
  190. <script type="text/javascript" src="../_static/js/theme.js"></script>
  191. <script type="text/javascript">
  192. jQuery(function () {
  193. SphinxRtdTheme.Navigation.enable(true);
  194. });
  195. </script>
  196. </body>
  197. </html>