Skip to content

ImageFilter.rst

Latest commit

 

History

History
93 lines (61 loc) · 2 KB

ImageFilter.rst

File metadata and controls

93 lines (61 loc) · 2 KB
.. py:module:: PIL.ImageFilter

.. py:currentmodule:: PIL.ImageFilter

:py:mod:`~PIL.ImageFilter` module

The :py:mod:`~PIL.ImageFilter` module contains definitions for a pre-defined set of filters, which can be used with the :py:meth:`Image.filter() <PIL.Image.Image.filter>` method.

Example: Filter an image

from PIL import ImageFilter

im1 = im.filter(ImageFilter.BLUR)

im2 = im.filter(ImageFilter.MinFilter(3))
im3 = im.filter(ImageFilter.MinFilter)  # same as MinFilter(3)

Filters

Pillow provides the following set of predefined image enhancement filters:

  • BLUR
  • CONTOUR
  • DETAIL
  • EDGE_ENHANCE
  • EDGE_ENHANCE_MORE
  • EMBOSS
  • FIND_EDGES
  • SHARPEN
  • SMOOTH
  • SMOOTH_MORE
.. autoclass:: PIL.ImageFilter.Color3DLUT
    :members:


.. autoclass:: PIL.ImageFilter.BoxBlur
    :members:


.. autoclass:: PIL.ImageFilter.GaussianBlur
    :members:


.. autoclass:: PIL.ImageFilter.UnsharpMask
    :members:


.. autoclass:: PIL.ImageFilter.Kernel
    :members:


.. autoclass:: PIL.ImageFilter.RankFilter
    :members:


.. autoclass:: PIL.ImageFilter.MedianFilter
    :members:


.. autoclass:: PIL.ImageFilter.MinFilter
    :members:


.. autoclass:: PIL.ImageFilter.MaxFilter
    :members:


.. autoclass:: PIL.ImageFilter.ModeFilter
    :members:

An abstract mixin used for filtering images (for use with :py:meth:`~PIL.Image.Image.filter`).

Implementors must provide the following method:

.. method:: filter(self, image)

    Applies a filter to a single-band image, or a single band of an image.

    :returns: A filtered copy of the image.

An abstract mixin used for filtering multi-band images (for use with :py:meth:`~PIL.Image.Image.filter`).

Implementors must provide the following method:

.. method:: filter(self, image)

    Applies a filter to a multi-band image.

    :returns: A filtered copy of the image.