File: ImageEnhance.rst

package info (click to toggle)
pillow 12.0.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 72,636 kB
  • sloc: python: 49,518; ansic: 38,787; makefile: 302; sh: 168; javascript: 85
file content (81 lines) | stat: -rw-r--r-- 2,497 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.. 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:

.. _enhancement-factor:

.. 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 colour balance of an image, in a
    manner similar to the controls on a colour 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.