Merge pull request #6430 from efiring/merge_from_1.5

efiring · efiring · commit 846b95f6c974 · 2016-05-15T15:28:27.000-10:00
Merge from 1.5
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -35,10 +35,11 @@
     from base64 import encodestring as encodebytes
 import contextlib
 import tempfile
+import warnings
 from matplotlib.cbook import iterable, is_string_like
 from matplotlib.compat import subprocess
 from matplotlib import verbose
-from matplotlib import rcParams, rcParamsDefault
+from matplotlib import rcParams, rcParamsDefault, rc_context
 
 # Process creation flag for subprocess to prevent it raising a terminal
 # window. See for example:
@@ -109,6 +110,11 @@ class MovieWriter(object):
     frame_format: string
         The format used in writing frame data, defaults to 'rgba'
     '''
+
+    # Specifies whether the size of all frames need to be identical
+    # i.e. whether we can use savefig.bbox = 'tight'
+    frame_size_can_vary = False
+
     def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
                  metadata=None):
         '''
@@ -127,8 +133,8 @@ def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
             automatically by the underlying utility.
         extra_args: list of strings or None
             A list of extra string arguments to be passed to the underlying
-            movie utiltiy. The default is None, which passes the additional
-            argurments in the 'animation.extra_args' rcParam.
+            movie utility. The default is None, which passes the additional
+            arguments in the 'animation.extra_args' rcParam.
         metadata: dict of string:string or None
             A dictionary of keys and values for metadata to include in the
             output file. Some keys that may be of use include:
@@ -283,6 +289,11 @@ def isAvailable(cls):
 
 class FileMovieWriter(MovieWriter):
     '`MovieWriter` subclass that handles writing to a file.'
+
+    # In general, if frames are writen to files on disk, it's not important
+    # that they all be identically sized
+    frame_size_can_vary = True
+
     def __init__(self, *args, **kwargs):
         MovieWriter.__init__(self, *args, **kwargs)
         self.frame_format = rcParams['animation.frame_format']
@@ -409,15 +420,15 @@ class FFMpegBase(object):
 
     @property
     def output_args(self):
-        # The %dk adds 'k' as a suffix so that ffmpeg treats our bitrate as in
-        # kbps
         args = ['-vcodec', self.codec]
         # For h264, the default format is yuv444p, which is not compatible
         # with quicktime (and others). Specifying yuv420p fixes playback on
         # iOS,as well as HTML5 video in firefox and safari (on both Win and
         # OSX). Also fixes internet explorer. This is as of 2015/10/29.
         if self.codec == 'h264' and '-pix_fmt' not in self.extra_args:
             args.extend(['-pix_fmt', 'yuv420p'])
+        # The %dk adds 'k' as a suffix so that ffmpeg treats our bitrate as in
+        # kbps
         if self.bitrate > 0:
             args.extend(['-b', '%dk' % self.bitrate])
         if self.extra_args:
@@ -691,8 +702,8 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
         `animation.bitrate`.
 
         *extra_args* is a list of extra string arguments to be passed to the
-        underlying movie utiltiy. The default is None, which passes the
-        additional argurments in the 'animation.extra_args' rcParam.
+        underlying movie utility. The default is None, which passes the
+        additional arguments in the 'animation.extra_args' rcParam.
 
         *metadata* is a dictionary of keys and values for metadata to include
         in the output file. Some keys that may be of use include:
@@ -712,29 +723,6 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
         if savefig_kwargs is None:
             savefig_kwargs = {}
 
-        # FIXME: Using 'bbox_inches' doesn't currently work with
-        # writers that pipe the data to the command because this
-        # requires a fixed frame size (see Ryan May's reply in this
-        # thread: [1]). Thus we drop the 'bbox_inches' argument if it
-        # exists in savefig_kwargs.
-        #
-        # [1] (http://matplotlib.1069221.n5.nabble.com/
-        # Animation-class-let-save-accept-kwargs-which-
-        # are-passed-on-to-savefig-td39627.html)
-        #
-        if 'bbox_inches' in savefig_kwargs:
-            if not (writer in ['ffmpeg_file', 'mencoder_file'] or
-                    isinstance(writer,
-                               (FFMpegFileWriter, MencoderFileWriter))):
-                print("Warning: discarding the 'bbox_inches' argument in "
-                      "'savefig_kwargs' as it is only currently supported "
-                      "with the writers 'ffmpeg_file' and 'mencoder_file' "
-                      "(writer used: "
-                      "'{0}').".format(
-                          writer if isinstance(writer, six.string_types)
-                          else writer.__class__.__name__))
-                savefig_kwargs.pop('bbox_inches')
-
         # Need to disconnect the first draw callback, since we'll be doing
         # draws. Otherwise, we'll end up starting the animation.
         if self._first_draw_id is not None:
@@ -778,7 +766,6 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
                                          extra_args=extra_args,
                                          metadata=metadata)
             else:
-                import warnings
                 warnings.warn("MovieWriter %s unavailable" % writer)
 
                 try:
@@ -792,22 +779,48 @@ def save(self, filename, writer=None, fps=None, dpi=None, codec=None,
 
         verbose.report('Animation.save using %s' % type(writer),
                        level='helpful')
+
+        # FIXME: Using 'bbox_inches' doesn't currently work with
+        # writers that pipe the data to the command because this
+        # requires a fixed frame size (see Ryan May's reply in this
+        # thread: [1]). Thus we drop the 'bbox_inches' argument if it
+        # exists in savefig_kwargs.
+        #
+        # [1] (http://matplotlib.1069221.n5.nabble.com/
+        # Animation-class-let-save-accept-kwargs-which-
+        # are-passed-on-to-savefig-td39627.html)
+        #
+        if 'bbox_inches' in savefig_kwargs and not writer.frame_size_can_vary:
+            warnings.warn("Warning: discarding the 'bbox_inches' argument in "
+                          "'savefig_kwargs' as it not supported by "
+                          "{0}).".format(writer.__class__.__name__))
+            savefig_kwargs.pop('bbox_inches')
+
         # Create a new sequence of frames for saved data. This is different
         # from new_frame_seq() to give the ability to save 'live' generated
         # frame information to be saved later.
         # TODO: Right now, after closing the figure, saving a movie won't work
         # since GUI widgets are gone. Either need to remove extra code to
-        # allow for this non-existant use case or find a way to make it work.
-        with writer.saving(self._fig, filename, dpi):
-            for anim in all_anim:
-                # Clear the initial frame
-                anim._init_draw()
-            for data in zip(*[a.new_saved_frame_seq()
-                              for a in all_anim]):
-                for anim, d in zip(all_anim, data):
-                    # TODO: Need to see if turning off blit is really necessary
-                    anim._draw_next_frame(d, blit=False)
-                writer.grab_frame(**savefig_kwargs)
+        # allow for this non-existent use case or find a way to make it work.
+        with rc_context():
+            # See above about bbox_inches savefig kwarg
+            if (not writer.frame_size_can_vary and
+                    rcParams['savefig.bbox'] == 'tight'):
+                verbose.report("Disabling savefig.bbox = 'tight', as it is "
+                               "not supported by "
+                               "{0}.".format(writer.__class__.__name__),
+                               level='helpful')
+                rcParams['savefig.bbox'] = None
+            with writer.saving(self._fig, filename, dpi):
+                for anim in all_anim:
+                    # Clear the initial frame
+                    anim._init_draw()
+                for data in zip(*[a.new_saved_frame_seq()
+                                  for a in all_anim]):
+                    for anim, d in zip(all_anim, data):
+                        # TODO: See if turning off blit is really necessary
+                        anim._draw_next_frame(d, blit=False)
+                    writer.grab_frame(**savefig_kwargs)
 
         # Reconnect signal for first draw if necessary
         if reconnect_first_draw:
@@ -935,7 +948,7 @@ def to_html5_video(self):
         directly into the HTML5 video tag. This respects the rc parameters
         for the writer as well as the bitrate. This also makes use of the
         ``interval`` to control the speed, and uses the ``repeat``
-        paramter to decide whether to loop.
+        parameter to decide whether to loop.
         '''
         VIDEO_TAG = r'''<video {size} {options}>
   <source type="video/mp4" src="data:video/mp4;base64,{video}">
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -1503,8 +1503,8 @@ def issubclass_safe(x, klass):
         return False
 
 
-def safe_masked_invalid(x):
-    x = np.asanyarray(x)
+def safe_masked_invalid(x, copy=False):
+    x = np.array(x, subok=True, copy=copy)
     try:
         xm = np.ma.masked_invalid(x, copy=False)
         xm.shrink_mask()
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -1132,7 +1132,7 @@ def changed(self):
         # add label colors
         cm.ScalarMappable.changed(self)
 
-    def _autolev(self, z, N):
+    def _autolev(self, N):
         """
         Select contour levels to span the data.
 
@@ -1168,12 +1168,12 @@ def _contour_level_args(self, z, args):
         self._auto = False
         if self.levels is None:
             if len(args) == 0:
-                lev = self._autolev(z, 7)
+                lev = self._autolev(7)
             else:
                 level_arg = args[0]
                 try:
                     if type(level_arg) == int:
-                        lev = self._autolev(z, level_arg)
+                        lev = self._autolev(level_arg)
                     else:
                         lev = np.asarray(level_arg).astype(np.float64)
                 except:
@@ -1533,12 +1533,12 @@ def _contour_args(self, args, kwargs):
             raise TypeError("Too many arguments to %s; see help(%s)" %
                             (fn, fn))
         z = ma.masked_invalid(z, copy=False)
-        self.zmax = ma.maximum(z)
-        self.zmin = ma.minimum(z)
+        self.zmax = float(z.max())
+        self.zmin = float(z.min())
         if self.logscale and self.zmin <= 0:
             z = ma.masked_where(z <= 0, z)
             warnings.warn('Log scale: values of z <= 0 have been masked')
-            self.zmin = z.min()
+            self.zmin = float(z.min())
         self._contour_level_args(z, args)
         return (x, y, z)
 
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -513,7 +513,7 @@ def set_data(self, A):
         if hasattr(A, 'getpixel'):
             self._A = pil_to_array(A)
         else:
-            self._A = cbook.safe_masked_invalid(A)
+            self._A = cbook.safe_masked_invalid(A, copy=True)
 
         if (self._A.dtype != np.uint8 and
                 not np.can_cast(self._A.dtype, np.float)):
@@ -822,9 +822,9 @@ def set_data(self, x, y, A):
             colormapped, or a (M,N,3) RGB array, or a (M,N,4) RGBA
             array.
         """
-        x = np.asarray(x, np.float32)
-        y = np.asarray(y, np.float32)
-        A = cbook.safe_masked_invalid(A)
+        x = np.array(x, np.float32)
+        y = np.array(y, np.float32)
+        A = cbook.safe_masked_invalid(A, copy=True)
         if len(x.shape) != 1 or len(y.shape) != 1\
            or A.shape[0:2] != (y.shape[0], x.shape[0]):
             raise TypeError("Axes don't match array shape")
@@ -899,7 +899,8 @@ def __init__(self, ax,
         """
         super(PcolorImage, self).__init__(ax, norm=norm, cmap=cmap)
         self.update(kwargs)
-        self.set_data(x, y, A)
+        if A is not None:
+            self.set_data(x, y, A)
 
     def make_image(self, renderer, magnification=1.0, unsampled=False):
         if self._A is None:
@@ -934,15 +935,15 @@ def _check_unsampled_image(self, renderer):
         return False
 
     def set_data(self, x, y, A):
-        A = cbook.safe_masked_invalid(A)
+        A = cbook.safe_masked_invalid(A, copy=True)
         if x is None:
             x = np.arange(0, A.shape[1]+1, dtype=np.float64)
         else:
-            x = np.asarray(x, np.float64).ravel()
+            x = np.array(x, np.float64).ravel()
         if y is None:
             y = np.arange(0, A.shape[0]+1, dtype=np.float64)
         else:
-            y = np.asarray(y, np.float64).ravel()
+            y = np.array(y, np.float64).ravel()
 
         if A.shape[:2] != (y.size-1, x.size-1):
             raise ValueError(
@@ -1016,6 +1017,12 @@ def make_image(self, renderer, magnification=1.0, unsampled=False):
             self._A, bbox, bbox, clip, magnification=magnification,
             unsampled=unsampled, round_to_pixel_border=False)
 
+    def set_data(self, A):
+        """Set the image array."""
+        cm.ScalarMappable.set_array(self,
+                                    cbook.safe_masked_invalid(A, copy=True))
+        self.stale = True
+
 
 class BboxImage(_ImageBase):
     """The Image class whose size is determined by the given bbox."""
diff --git a/lib/matplotlib/tests/test_image.py b/lib/matplotlib/tests/test_image.py
@@ -12,7 +12,8 @@
 
 from matplotlib.testing.decorators import (image_comparison,
                                            knownfailureif, cleanup)
-from matplotlib.image import BboxImage, imread, NonUniformImage
+from matplotlib.image import (BboxImage, imread, NonUniformImage,
+                              AxesImage, FigureImage, PcolorImage)
 from matplotlib.transforms import Bbox, Affine2D, TransformedBbox
 from matplotlib import rcParams
 from matplotlib import patches
@@ -486,6 +487,50 @@ def test_nonuniformimage_setnorm():
     im.set_norm(plt.Normalize())
 
 
+@cleanup
+def test_nonuniformimage_setdata():
+    ax = plt.gca()
+    im = NonUniformImage(ax)
+    x = np.arange(3, dtype=np.float64)
+    y = np.arange(4, dtype=np.float64)
+    z = np.arange(12, dtype=np.float64).reshape((4, 3))
+    im.set_data(x, y, z)
+    x[0] = y[0] = z[0, 0] = 9.9
+    assert im._A[0, 0] == im._Ax[0] == im._Ay[0] == 0, 'value changed'
+
+
+@cleanup
+def test_axesimage_setdata():
+    ax = plt.gca()
+    im = AxesImage(ax)
+    z = np.arange(12, dtype=np.float64).reshape((4, 3))
+    im.set_data(z)
+    z[0, 0] = 9.9
+    assert im._A[0, 0] == 0, 'value changed'
+
+
+@cleanup
+def test_figureimage_setdata():
+    fig = plt.gcf()
+    im = FigureImage(fig)
+    z = np.arange(12, dtype=np.float64).reshape((4, 3))
+    im.set_data(z)
+    z[0, 0] = 9.9
+    assert im._A[0, 0] == 0, 'value changed'
+
+
+@cleanup
+def test_pcolorimage_setdata():
+    ax = plt.gca()
+    im = PcolorImage(ax)
+    x = np.arange(3, dtype=np.float64)
+    y = np.arange(4, dtype=np.float64)
+    z = np.arange(6, dtype=np.float64).reshape((3, 2))
+    im.set_data(x, y, z)
+    x[0] = y[0] = z[0, 0] = 9.9
+    assert im._A[0, 0] == im._Ax[0] == im._Ay[0] == 0, 'value changed'
+
+
 @cleanup
 def test_minimized_rasterized():
     # This ensures that the rasterized content in the colorbars is
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1665,6 +1665,7 @@ def __init__(self, base=10.0, subs=[1.0], numdecs=4, numticks=15):
         """
         self.base(base)
         self.subs(subs)
+        # this needs to be validated > 1 with traitlets
         self.numticks = numticks
         self.numdecs = numdecs
 
@@ -1737,6 +1738,9 @@ def tick_values(self, vmin, vmax):
             subs = self._subs
 
         stride = 1
+        if not self.numticks > 1:
+            raise RuntimeError('The number of ticks must be greater than 1 '
+                               'for LogLocator.')
         while numdec / stride + 1 > self.numticks:
             stride += 1
 
