<!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>ImageMorph Module — Pillow (PIL Fork) 5.4.1 documentation</title>
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<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/script.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="ImageOps Module" href="ImageOps.html" />
<link rel="prev" title="ImageMath Module" href="ImageMath.html" />
</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"> Pillow (PIL Fork)
</a>
<div class="version">
5.4.1
</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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../handbook/index.html">Handbook</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="Image.html"><code class="docutils literal notranslate"><span class="pre">Image</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageChops.html"><code class="docutils literal notranslate"><span class="pre">ImageChops</span></code> (“Channel Operations”) Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageColor.html"><code class="docutils literal notranslate"><span class="pre">ImageColor</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageCms.html"><code class="docutils literal notranslate"><span class="pre">ImageCms</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageDraw.html"><code class="docutils literal notranslate"><span class="pre">ImageDraw</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageEnhance.html"><code class="docutils literal notranslate"><span class="pre">ImageEnhance</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageFile.html"><code class="docutils literal notranslate"><span class="pre">ImageFile</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageFilter.html"><code class="docutils literal notranslate"><span class="pre">ImageFilter</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageFont.html"><code class="docutils literal notranslate"><span class="pre">ImageFont</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageGrab.html"><code class="docutils literal notranslate"><span class="pre">ImageGrab</span></code> Module (macOS and Windows only)</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageMath.html"><code class="docutils literal notranslate"><span class="pre">ImageMath</span></code> Module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">ImageMorph</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageOps.html"><code class="docutils literal notranslate"><span class="pre">ImageOps</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImagePalette.html"><code class="docutils literal notranslate"><span class="pre">ImagePalette</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImagePath.html"><code class="docutils literal notranslate"><span class="pre">ImagePath</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageQt.html"><code class="docutils literal notranslate"><span class="pre">ImageQt</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageSequence.html"><code class="docutils literal notranslate"><span class="pre">ImageSequence</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageStat.html"><code class="docutils literal notranslate"><span class="pre">ImageStat</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageTk.html"><code class="docutils literal notranslate"><span class="pre">ImageTk</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="ImageWin.html"><code class="docutils literal notranslate"><span class="pre">ImageWin</span></code> Module (Windows-only)</a></li>
<li class="toctree-l2"><a class="reference internal" href="ExifTags.html"><code class="docutils literal notranslate"><span class="pre">ExifTags</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="TiffTags.html"><code class="docutils literal notranslate"><span class="pre">TiffTags</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PSDraw.html"><code class="docutils literal notranslate"><span class="pre">PSDraw</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PixelAccess.html"><code class="docutils literal notranslate"><span class="pre">PixelAccess</span></code> Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="PyAccess.html"><code class="docutils literal notranslate"><span class="pre">PyAccess</span></code> Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../PIL.html">PIL Package (autodoc of remaining modules)</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html">Plugin reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="internal_design.html">Internal Reference Docs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../porting.html">Porting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releasenotes/index.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../deprecations.html">Deprecations and removals</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">Pillow (PIL Fork)</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> »</li>
<li><a href="index.html">Reference</a> »</li>
<li><code class="docutils literal notranslate"><span class="pre">ImageMorph</span></code> Module</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/reference/ImageMorph.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="module-PIL.ImageMorph"></span><div class="section" id="imagemorph-module">
<h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">ImageMorph</span></code> Module<a class="headerlink" href="#imagemorph-module" title="Permalink to this headline">¶</a></h1>
<p>The <code class="xref py py-mod docutils literal notranslate"><span class="pre">ImageMorph</span></code> module provides morphology operations on images.</p>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">PIL.ImageMorph.</code><code class="descname">LutBuilder</code><span class="sig-paren">(</span><em>patterns=None</em>, <em>op_name=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#LutBuilder"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class for building a MorphLut from a descriptive language</p>
<p>The input patterns is a list of a strings sequences like these:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">4</span><span class="p">:(</span><span class="o">...</span>
<span class="o">.</span><span class="mf">1.</span>
<span class="mi">111</span><span class="p">)</span><span class="o">-></span><span class="mi">1</span>
</pre></div>
</div>
<p>(whitespaces including linebreaks are ignored). The option 4
describes a series of symmetry operations (in this case a
4-rotation), the pattern is described by:</p>
<ul class="simple">
<li>. or X - Ignore</li>
<li>1 - Pixel is on</li>
<li>0 - Pixel is off</li>
</ul>
<p>The result of the operation is described after “->” string.</p>
<p>The default is to return the current pixel value, which is
returned if no other match is found.</p>
<p>Operations:</p>
<ul class="simple">
<li>4 - 4 way rotation</li>
<li>N - Negate</li>
<li>1 - Dummy op for no other operation (an op must always be given)</li>
<li>M - Mirroring</li>
</ul>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">lb</span> <span class="o">=</span> <span class="n">LutBuilder</span><span class="p">(</span><span class="n">patterns</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"4:(... .1. 111)->1"</span><span class="p">])</span>
<span class="n">lut</span> <span class="o">=</span> <span class="n">lb</span><span class="o">.</span><span class="n">build_lut</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt>
<code class="descname">add_patterns</code><span class="sig-paren">(</span><em>patterns</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#LutBuilder.add_patterns"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<code class="descname">build_default_lut</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#LutBuilder.build_default_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="method">
<dt>
<code class="descname">build_lut</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#LutBuilder.build_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Compile all patterns into a morphology lut.</p>
<p>TBD :Build based on (file) morphlut:modify_lut</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">get_lut</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#LutBuilder.get_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">PIL.ImageMorph.</code><code class="descname">MorphOp</code><span class="sig-paren">(</span><em>lut=None</em>, <em>op_name=None</em>, <em>patterns=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class for binary morphological operators</p>
<dl class="method">
<dt>
<code class="descname">apply</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.apply"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Run a single morphological operation on an image</p>
<p>Returns a tuple of the number of changed pixels and the
morphed image</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">get_on_pixels</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.get_on_pixels"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Get a list of all turned on pixels in a binary image</p>
<p>Returns a list of tuples of (x,y) coordinates
of all matching pixels. See <a class="reference internal" href="../handbook/concepts.html#coordinate-system"><span class="std std-ref">Coordinate System</span></a>.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">load_lut</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.load_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Load an operator from an mrl file</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">match</code><span class="sig-paren">(</span><em>image</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.match"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Get a list of coordinates matching the morphological operation on
an image.</p>
<p>Returns a list of tuples of (x,y) coordinates
of all matching pixels. See <a class="reference internal" href="../handbook/concepts.html#coordinate-system"><span class="std std-ref">Coordinate System</span></a>.</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">save_lut</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.save_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Save an operator to an mrl file</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">set_lut</code><span class="sig-paren">(</span><em>lut</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/PIL/ImageMorph.html#MorphOp.set_lut"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Set the lut from an external source</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="ImageOps.html" class="btn btn-neutral float-right" title="ImageOps Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="ImageMath.html" class="btn btn-neutral float-left" title="ImageMath Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 1995-2011 Fredrik Lundh, 2010-2018 Alex Clark and Contributors
</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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
