Skip to content

Improve ImageEnhance factor documentation #7065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 4, 2023
Merged

Improve ImageEnhance factor documentation #7065

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
498b475
Added links to more information about the enhancement factor
radarhere Apr 4, 2023
4720774
Describe the effect of brightness and contrast factors above 1
radarhere Apr 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions docs/reference/ImageEnhance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Classes
All enhancement classes implement a common interface, containing a single
method:

.. _enhancement-factor:

.. py:class:: _Enhance

.. py:method:: enhance(factor)
Expand All @@ -45,31 +47,35 @@ method:

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 enhancement
factor of 0.0 gives a black and white image. A factor of 1.0 gives
the original image.
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 enhancement factor of 0.0
gives a solid grey image. A factor of 1.0 gives the original image.
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 grey
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
enhancement factor of 0.0 gives a black image. A factor of 1.0 gives the
original image.
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
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.
: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.