Skip to content

Commit

Permalink
Merge pull request #7065 from radarhere/imageenhance
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Apr 4, 2023
2 parents 7d3a6aa + 4720774 commit 943a7a8
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions docs/reference/ImageEnhance.rst
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.

0 comments on commit 943a7a8

Please sign in to comment.