<!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>PIL.ImageChops — 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" />
</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>
<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"><a class="reference internal" href="../../reference/index.html">Reference</a></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">Module code</a> »</li>
<li>PIL.ImageChops</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for PIL.ImageChops</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># The Python Imaging Library.</span>
<span class="c1"># $Id$</span>
<span class="c1">#</span>
<span class="c1"># standard channel operations</span>
<span class="c1">#</span>
<span class="c1"># History:</span>
<span class="c1"># 1996-03-24 fl Created</span>
<span class="c1"># 1996-08-13 fl Added logical operations (for "1" images)</span>
<span class="c1"># 2000-10-12 fl Added offset method (from Image.py)</span>
<span class="c1">#</span>
<span class="c1"># Copyright (c) 1997-2000 by Secret Labs AB</span>
<span class="c1"># Copyright (c) 1996-2000 by Fredrik Lundh</span>
<span class="c1">#</span>
<span class="c1"># See the README file for information on usage and redistribution.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">Image</span>
<div class="viewcode-block" id="constant"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.constant">[docs]</a><span class="k">def</span> <span class="nf">constant</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Fill a channel with a given grey level.</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">Image</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s2">"L"</span><span class="p">,</span> <span class="n">image</span><span class="o">.</span><span class="n">size</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div>
<div class="viewcode-block" id="duplicate"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.duplicate">[docs]</a><span class="k">def</span> <span class="nf">duplicate</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
<span class="sd">"""Copy a channel. Alias for :py:meth:`PIL.Image.Image.copy`.</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">image</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span></div>
<div class="viewcode-block" id="invert"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.invert">[docs]</a><span class="k">def</span> <span class="nf">invert</span><span class="p">(</span><span class="n">image</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Invert an image (channel).</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = MAX - image</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_invert</span><span class="p">())</span></div>
<div class="viewcode-block" id="lighter"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.lighter">[docs]</a><span class="k">def</span> <span class="nf">lighter</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Compares the two images, pixel by pixel, and returns a new image containing</span>
<span class="sd"> the lighter values. At least one of the images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = max(image1, image2)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_lighter</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="darker"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.darker">[docs]</a><span class="k">def</span> <span class="nf">darker</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Compares the two images, pixel by pixel, and returns a new image containing</span>
<span class="sd"> the darker values. At least one of the images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = min(image1, image2)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_darker</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="difference"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.difference">[docs]</a><span class="k">def</span> <span class="nf">difference</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the absolute value of the pixel-by-pixel difference between the two</span>
<span class="sd"> images. At least one of the images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = abs(image1 - image2)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_difference</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="multiply"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.multiply">[docs]</a><span class="k">def</span> <span class="nf">multiply</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Superimposes two images on top of each other.</span>
<span class="sd"> If you multiply an image with a solid black image, the result is black. If</span>
<span class="sd"> you multiply with a solid white image, the image is unaffected. At least</span>
<span class="sd"> one of the images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = image1 * image2 / MAX</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_multiply</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="screen"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.screen">[docs]</a><span class="k">def</span> <span class="nf">screen</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Superimposes two inverted images on top of each other. At least one of the</span>
<span class="sd"> images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = MAX - ((MAX - image1) * (MAX - image2) / MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_screen</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="add"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.add">[docs]</a><span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Adds two images, dividing the result by scale and adding the</span>
<span class="sd"> offset. If omitted, scale defaults to 1.0, and offset to 0.0.</span>
<span class="sd"> At least one of the images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 + image2) / scale + offset)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_add</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">,</span> <span class="n">scale</span><span class="p">,</span> <span class="n">offset</span><span class="p">))</span></div>
<div class="viewcode-block" id="subtract"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.subtract">[docs]</a><span class="k">def</span> <span class="nf">subtract</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Subtracts two images, dividing the result by scale and adding the offset.</span>
<span class="sd"> If omitted, scale defaults to 1.0, and offset to 0.0. At least one of the</span>
<span class="sd"> images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 - image2) / scale + offset)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_subtract</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">,</span> <span class="n">scale</span><span class="p">,</span> <span class="n">offset</span><span class="p">))</span></div>
<div class="viewcode-block" id="add_modulo"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.add_modulo">[docs]</a><span class="k">def</span> <span class="nf">add_modulo</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""Add two images, without clipping the result. At least one of the images</span>
<span class="sd"> must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 + image2) % MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_add_modulo</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="subtract_modulo"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.subtract_modulo">[docs]</a><span class="k">def</span> <span class="nf">subtract_modulo</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""Subtract two images, without clipping the result. At least one of the</span>
<span class="sd"> images must have mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 - image2) % MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_subtract_modulo</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="logical_and"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.logical_and">[docs]</a><span class="k">def</span> <span class="nf">logical_and</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""Logical AND between two images. At least one of the images must have</span>
<span class="sd"> mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 and image2) % MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_and</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="logical_or"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.logical_or">[docs]</a><span class="k">def</span> <span class="nf">logical_or</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""Logical OR between two images. At least one of the images must have</span>
<span class="sd"> mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((image1 or image2) % MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_or</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="logical_xor"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.logical_xor">[docs]</a><span class="k">def</span> <span class="nf">logical_xor</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">):</span>
<span class="sd">"""Logical XOR between two images. At least one of the images must have</span>
<span class="sd"> mode "1".</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> out = ((bool(image1) != bool(image2)) % MAX)</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="n">image1</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="n">image2</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image1</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image1</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">chop_xor</span><span class="p">(</span><span class="n">image2</span><span class="o">.</span><span class="n">im</span><span class="p">))</span></div>
<div class="viewcode-block" id="blend"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.blend">[docs]</a><span class="k">def</span> <span class="nf">blend</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">alpha</span><span class="p">):</span>
<span class="sd">"""Blend images using constant transparency weight. Alias for</span>
<span class="sd"> :py:meth:`PIL.Image.Image.blend`.</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">Image</span><span class="o">.</span><span class="n">blend</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">alpha</span><span class="p">)</span></div>
<div class="viewcode-block" id="composite"><a class="viewcode-back" href="../../reference/ImageChops.html#PIL.ImageChops.composite">[docs]</a><span class="k">def</span> <span class="nf">composite</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">mask</span><span class="p">):</span>
<span class="sd">"""Create composite using transparency mask. Alias for</span>
<span class="sd"> :py:meth:`PIL.Image.Image.composite`.</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">Image</span><span class="o">.</span><span class="n">composite</span><span class="p">(</span><span class="n">image1</span><span class="p">,</span> <span class="n">image2</span><span class="p">,</span> <span class="n">mask</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">offset</span><span class="p">(</span><span class="n">image</span><span class="p">,</span> <span class="n">xoffset</span><span class="p">,</span> <span class="n">yoffset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Returns a copy of the image where data has been offset by the given</span>
<span class="sd"> distances. Data wraps around the edges. If **yoffset** is omitted, it</span>
<span class="sd"> is assumed to be equal to **xoffset**.</span>
<span class="sd"> :param xoffset: The horizontal distance.</span>
<span class="sd"> :param yoffset: The vertical distance. If omitted, both</span>
<span class="sd"> distances are set to the same value.</span>
<span class="sd"> :rtype: :py:class:`~PIL.Image.Image`</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">yoffset</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">yoffset</span> <span class="o">=</span> <span class="n">xoffset</span>
<span class="n">image</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
<span class="k">return</span> <span class="n">image</span><span class="o">.</span><span class="n">_new</span><span class="p">(</span><span class="n">image</span><span class="o">.</span><span class="n">im</span><span class="o">.</span><span class="n">offset</span><span class="p">(</span><span class="n">xoffset</span><span class="p">,</span> <span class="n">yoffset</span><span class="p">))</span>
</pre></div>
</div>
</div>
<footer>
<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>
