Skip to content

Commit

Permalink
Document format limitations of ImageStat.Stat.extrema (#3661)
Browse files Browse the repository at this point in the history
Document format limitations of ImageStat.Stat.extrema
  • Loading branch information
hugovk committed May 3, 2019
2 parents 5343341 + 09c320e commit c15dc4d
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/reference/ImageStat.rst
Expand Up @@ -20,6 +20,13 @@ 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, for non-8-bit modes, the histogram
method uses :py:meth:`~PIL.Image.getextrema` to determine the bins used.

.. py:attribute:: count
Total number of pixels for each band in the image.
Expand Down

0 comments on commit c15dc4d

Please sign in to comment.