Skip to content

ImageEnhance.rst

Latest commit

 

History

History
81 lines (54 loc) · 2.44 KB

ImageEnhance.rst

File metadata and controls

81 lines (54 loc) · 2.44 KB
.. py:module:: PIL.ImageEnhance

.. py:currentmodule:: PIL.ImageEnhance

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

The :py:mod:`~PIL.ImageEnhance` module contains a number of classes that can be used for image enhancement.

Example: Vary the sharpness of an image

from PIL import ImageEnhance

enhancer = ImageEnhance.Sharpness(image)

for i in range(8):
    factor = i / 4.0
    enhancer.enhance(factor).show(f"Sharpness {factor:f}")

Also see the :file:`enhancer.py` demo program in the :file:`Scripts/` directory.

Classes

All enhancement classes implement a common interface, containing a single method:

.. py:class:: _Enhance

    .. py:method:: enhance(factor)

        Returns an enhanced image.

        :param factor: A floating point value controlling the enhancement.
                       Factor 1.0 always returns a copy of the original image,
                       lower factors mean less color (brightness, contrast,
                       etc), and higher values more. There are no restrictions
                       on this value.


.. py:class:: Color(image)

    Adjust image color balance.

    This class can be used to adjust the color balance of an image, in a
    manner similar to the controls on a color TV set. An
    :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a black and
    white image. A factor of 1.0 gives the original image.


.. py:class:: Contrast(image)

    Adjust image contrast.

    This class can be used to control the contrast of an image, similar to the
    contrast control on a TV set. An
    :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a solid gray
    image, a factor of 1.0 gives the original image, and greater values
    increase the contrast of the image.


.. py:class:: Brightness(image)

    Adjust image brightness.

    This class can be used to control the brightness of an image. An
    :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a black image,
    a factor of 1.0 gives the original image, and greater values increase the
    brightness of the image.


.. py:class:: Sharpness(image)

    Adjust image sharpness.

    This class can be used to adjust the sharpness of an image. An
    :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a blurred
    image, a factor of 1.0 gives the original image, and a factor of 2.0 gives
    a sharpened image.