Additional fixes for improved nonfinite scatter support.

anntzer · anntzer · commit 98e4bcaf45f2 · 2018-11-14T03:16:02.000+01:00
diff --git a/doc/api/next_api_changes/2018-11-14-AL-scatter.rst b/doc/api/next_api_changes/2018-11-14-AL-scatter.rst
@@ -0,0 +1,14 @@
+PathCollections created with `~.Axes.scatter` now keep track of invalid points
+``````````````````````````````````````````````````````````````````````````````
+
+Previously, points with nonfinite (infinite or nan) coordinates would not be
+included in the offsets (as returned by `PathCollection.get_offsets`) of a
+`PathCollection` created by `~.Axes.scatter`, and points with nonfinite values
+(as specified by the *c* kwarg) would not be included in the array (as returned
+by `PathCollection.get_array`)
+
+Such points are now included, but masked out by returning a masked array.
+
+If the *plotinvalid* kwarg to `~.Axes.scatter` is set, then points with
+nonfinite values are plotted using the bad color of the `PathCollection`\ 's
+colormap (as set by `Colormap.set_bad`).
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4169,7 +4169,7 @@ def _parse_scatter_color_args(self, c, edgecolors, kwargs, xshape, yshape):
                       label_namer="y")
     def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
                 vmin=None, vmax=None, alpha=None, linewidths=None,
-                verts=None, edgecolors=None, plotinvalid=False,
+                verts=None, edgecolors=None, *, plotinvalid=False,
                 **kwargs):
         """
         A scatter plot of *y* vs *x* with varying marker size and/or color.
@@ -4302,25 +4302,14 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             self._parse_scatter_color_args(c, edgecolors, kwargs,
                                            xshape, yshape)
 
-        # if plotinvalid and colors == None:
-        #     # Do full color mapping; don't remove invalid c entries.
-        #     ind = np.arange(len(c))
-        #     x, y, s, ind, colors, edgecolors, linewidths =\
-        #        cbook.delete_masked_points(
-        #            x, y, s, ind, colors, edgecolors, linewidths)
-        #     c = np.ma.masked_invalid(c[ind])
-        # else:
-        #     x, y, s, c, colors, edgecolors, linewidths =\
-        #        cbook.delete_masked_points(
-        #            x, y, s, c, colors, edgecolors, linewidths)
-
-        if plotinvalid and colors == None:
+        if plotinvalid and colors is None:
             c = np.ma.masked_invalid(c)
-            x, y, s, colors, edgecolors, linewidths =\
-                cbook.combine_masks(x, y, s, colors, edgecolors, linewidths)
+            x, y, s, colors, edgecolors, linewidths = \
+                cbook._combine_masks(x, y, s, colors, edgecolors, linewidths)
         else:
-            x, y, s, c, colors, edgecolors, linewidths =\
-                cbook.combine_masks(x, y, s, c, colors, edgecolors, linewidths)
+            x, y, s, c, colors, edgecolors, linewidths = \
+                cbook._combine_masks(
+                    x, y, s, c, colors, edgecolors, linewidths)
 
         scales = s   # Renamed for readability below.
 
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -1044,7 +1044,7 @@ def delete_masked_points(*args):
     return margs
 
 
-def combine_masks(*args):
+def _combine_masks(*args):
     """
     Find all masked and/or non-finite points in a set of arguments,
     and return the arguments as masked arrays with a common mask.
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2835,7 +2835,7 @@ def quiverkey(Q, X, Y, U, label, **kw):
 def scatter(
         x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         vmin=None, vmax=None, alpha=None, linewidths=None, verts=None,
-        edgecolors=None, plotinvalid=False, *, data=None, **kwargs):
+        edgecolors=None, *, plotinvalid=False, data=None, **kwargs):
     __ret = gca().scatter(
         x, y, s=s, c=c, marker=marker, cmap=cmap, norm=norm,
         vmin=vmin, vmax=vmax, alpha=alpha, linewidths=linewidths,
diff --git a/lib/matplotlib/tests/test_colorbar.py b/lib/matplotlib/tests/test_colorbar.py
@@ -197,7 +197,7 @@ def test_colorbar_single_scatter():
     # the norm scaling within the colorbar must ensure a
     # finite range, otherwise a zero denominator will occur in _locate.
     plt.figure()
-    x =  y = [0]
+    x = y = [0]
     z = [50]
     cmap = plt.get_cmap('jet', 16)
     cs = plt.scatter(x, y, z, c=z, cmap=cmap)
