Merge pull request #9981 from colour-science/feature/doc_imshow

dstansby · web-flow · commit cfb648f2dfc2 · 2017-12-12T20:46:49.000Z
DOC: Add alpha compositing note to "matplotlib.pyplot.imshow" definition.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -5129,6 +5129,16 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
         coordinates. In other words: the origin will coincide with the center
         of pixel (0, 0).
 
+        Two typical representations are used for RGB images with an alpha
+        channel:
+
+        -   Straight (unassociated) alpha: R, G, and B channels represent the
+            color of the pixel, disregarding its opacity.
+        -   Premultiplied (associated) alpha: R, G, and B channels represent
+            the color of the pixel, adjusted for its opacity by multiplication.
+
+        `~matplotlib.pyplot.imshow` expects RGB images adopting the straight
+        (unassociated) alpha representation.
         """
 
         if not self._hold:
