From 498b475e82105fcad0b78465dd259973849fbd55 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Tue, 4 Apr 2023 13:23:19 +1000 Subject: [PATCH 1/2] Added links to more information about the enhancement factor --- docs/reference/ImageEnhance.rst | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/reference/ImageEnhance.rst b/docs/reference/ImageEnhance.rst index b27228ec924..746f18cd2c0 100644 --- a/docs/reference/ImageEnhance.rst +++ b/docs/reference/ImageEnhance.rst @@ -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) @@ -45,31 +47,33 @@ 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 ` 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 ` of 0.0 gives a solid grey + image. A factor of 1.0 gives the original 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 ` of 0.0 gives a black image. + A factor of 1.0 gives the original 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 ` 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. From 4720774a8523e69bbca5b9fb71c1f38c0ba38151 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Tue, 4 Apr 2023 14:59:26 +1000 Subject: [PATCH 2/2] Describe the effect of brightness and contrast factors above 1 --- docs/reference/ImageEnhance.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/reference/ImageEnhance.rst b/docs/reference/ImageEnhance.rst index 746f18cd2c0..457f0d4df1b 100644 --- a/docs/reference/ImageEnhance.rst +++ b/docs/reference/ImageEnhance.rst @@ -59,15 +59,17 @@ method: 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 ` of 0.0 gives a solid grey - image. A factor of 1.0 gives the original image. + 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 ` of 0.0 gives a black image. - A factor of 1.0 gives the original image. + :ref:`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)