Added links to more information about the enhancement factor

This commit is contained in:
Andrew Murray 2023-04-04 13:23:19 +10:00
parent fada40d2e8
commit 498b475e82

View File

@ -29,6 +29,8 @@ Classes
All enhancement classes implement a common interface, containing a single All enhancement classes implement a common interface, containing a single
method: method:
.. _enhancement-factor:
.. py:class:: _Enhance .. py:class:: _Enhance
.. py:method:: enhance(factor) .. py:method:: enhance(factor)
@ -45,31 +47,33 @@ method:
Adjust image color balance. Adjust image color balance.
This class can be used to adjust the colour balance of an image, in This class can be used to adjust the colour balance of an image, in a
a manner similar to the controls on a colour TV set. An enhancement manner similar to the controls on a colour TV set. An
factor of 0.0 gives a black and white image. A factor of 1.0 gives :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a black and
the original image. white image. A factor of 1.0 gives the original image.
.. py:class:: Contrast(image) .. py:class:: Contrast(image)
Adjust image contrast. Adjust image contrast.
This class can be used to control the contrast of an image, similar This class can be used to control the contrast of an image, similar to the
to the contrast control on a TV set. An enhancement factor of 0.0 contrast control on a TV set. An
gives a solid grey image. A factor of 1.0 gives the original image. :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a solid grey
image. A factor of 1.0 gives the original image.
.. py:class:: Brightness(image) .. py:class:: Brightness(image)
Adjust image brightness. Adjust image brightness.
This class can be used to control the brightness of an image. An 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 :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a black image.
original image. A factor of 1.0 gives the original image.
.. py:class:: Sharpness(image) .. py:class:: Sharpness(image)
Adjust image sharpness. Adjust image sharpness.
This class can be used to adjust the sharpness of an image. An 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 :ref:`enhancement factor <enhancement-factor>` of 0.0 gives a blurred
original image, and a factor of 2.0 gives a sharpened image. image, a factor of 1.0 gives the original image, and a factor of 2.0 gives
a sharpened image.