python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-26 18:06:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document format limitations of ImageStat.Stat.extrema and recommend more efficient Image.getextrema

Browse Source
This commit is contained in:
Hugo 2019-02-17 15:06:29 +02:00
parent 8194677516
commit 6f24eda48a
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/ImageStat.rst
View File

@ -20,6 +20,14 @@ for a region of an image.
Min/max values for each band in the image.
.. Note:: This relies on the :py:meth:`~PIL.Image.histogram` method, and simply
returns the low and high bins used. This is correct for images with 8 bits per
channel, but fails for other modes such as ``I`` or ``F``. Instead, use
:py:meth:`~PIL.Image.getextrema` to return per-band extrema for the image.
This is more correct and efficient because :py:meth:`~PIL.Image.getextrema` is
used by the histogram method for non-8-bit modes to return extrema to define the
bins used in the histogram.
.. py:attribute:: count
Total number of pixels for each band in the image.