Merge pull request #4315 from alimehdi92/3420_feature

tacaswell · tacaswell · commit 1b11d9de9e5c · 2015-04-11T19:08:02.000-04:00
ENH : added resize parameter figimage

Match the figure size to image size
diff --git a/doc/users/whats_new/updated_figimage.rst b/doc/users/whats_new/updated_figimage.rst
@@ -0,0 +1,8 @@
+updated figimage to take optional resize parameter
+----------------------------------------------------
+Added the ability to plot simple 2D-Array using plt.figimage(X, resize=True).
+This is useful for plotting simple 2D-Array without the Axes or whitespacing
+around the image.
+Example:
+	data = np.random.random( [500, 500] )
+	plt.figimage(data, resize=True)
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -576,6 +576,7 @@ def figimage(self, X,
                  vmin=None,
                  vmax=None,
                  origin=None,
+                 resize=False,
                  **kwargs):
         """
         Adds a non-resampled image to the figure.
@@ -603,6 +604,8 @@ def figimage(self, X,
           =========   =========================================================
           Keyword     Description
           =========   =========================================================
+          resize      a boolean, True or False. If "True", then re-size the
+                      Figure to match the given image size.
           xo or yo    An integer, the *x* and *y* image offset in pixels
           cmap        a :class:`matplotlib.colors.Colormap` instance, e.g.,
                       cm.jet. If *None*, default to the rc ``image.cmap``
@@ -637,6 +640,11 @@ def figimage(self, X,
         if not self._hold:
             self.clf()
 
+        if resize:
+            dpi = self.get_dpi()
+            figsize = [x / float(dpi) for x in (X.shape[1], X.shape[0])]
+            self.set_size_inches(figsize, forward=True)
+
         im = FigureImage(self, cmap, norm, xo, yo, origin, **kwargs)
         im.set_array(X)
         im.set_alpha(alpha)
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -1304,10 +1304,10 @@ def imsave(fname, arr, vmin=None, vmax=None, cmap=None, format=None,
     from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
     from matplotlib.figure import Figure
 
-    figsize = [x / float(dpi) for x in (arr.shape[1], arr.shape[0])]
-    fig = Figure(figsize=figsize, dpi=dpi, frameon=False)
+    fig = Figure(dpi=dpi, frameon=False)
     canvas = FigureCanvas(fig)
-    im = fig.figimage(arr, cmap=cmap, vmin=vmin, vmax=vmax, origin=origin)
+    im = fig.figimage(arr, cmap=cmap, vmin=vmin, vmax=vmax, origin=origin,
+                      resize=True)
     fig.savefig(fname, dpi=dpi, format=format, transparent=True)
 
 
