From cea84e6b2d7df6d74f46532b18e40eef1debcc41 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Tue, 23 Nov 2021 20:35:35 +1100 Subject: [PATCH] Improved explanation of fromarray "mode" parameter --- src/PIL/Image.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/PIL/Image.py b/src/PIL/Image.py index 3b4e1e720..0fca3fa5c 100644 --- a/src/PIL/Image.py +++ b/src/PIL/Image.py @@ -2773,7 +2773,7 @@ def fromarray(obj, mode=None): from PIL import Image import numpy as np - im = Image.open('hopper.jpg') + im = Image.open("hopper.jpg") a = np.asarray(im) Then this can be used to convert it to a Pillow image:: @@ -2781,8 +2781,21 @@ def fromarray(obj, mode=None): im = Image.fromarray(a) :param obj: Object with array interface - :param mode: Mode to use (will be determined from type if None) - See: :ref:`concept-modes`. + :param mode: Optional mode to use when reading ``obj``. Will be determined from + type if ``None``. + + This will not be used to convert the data after reading, but will be used to + change how the data is read:: + + from PIL import Image + import numpy as np + a = np.full((1, 1), 300) + im = Image.fromarray(a, mode="L") + im.getpixel((0, 0)) # 44 + im = Image.fromarray(a, mode="RGB") + im.getpixel((0, 0)) # (44, 1, 0) + + See: :ref:`concept-modes` for general information about modes. :returns: An image object. .. versionadded:: 1.1.6