DOC/ENH : get/set_size_inches

tacaswell · tacaswell · commit 640d05f6b408 · 2014-02-24T21:04:43.000-05:00
Added links between `get_size_inches` and `set_size_inches` Added an `np.array` call to `get_size_inches` to return a copy of the size, instead of a reference to the internal np.array. Closes matplotlib#2303
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -635,6 +635,8 @@ def set_size_inches(self, *args, **kwargs):
         from the shell
 
         ACCEPTS: a w,h tuple with w,h in inches
+
+        .. seealso:: :func:`~matplotlib.Figure.get_size_inches`
         """
 
         forward = kwargs.get('forward', False)
@@ -655,7 +657,17 @@ def set_size_inches(self, *args, **kwargs):
                 manager.resize(int(canvasw), int(canvash))
 
     def get_size_inches(self):
-        return self.bbox_inches.p1
+        """
+        Returns the current size of the figure in inches as an numpy array.
+
+        Returns
+        -------
+        size : ndarray
+           The size of the figure in inches
+
+        .. seealso:: :func:`~matplotlib.Figure.set_size_inches`
+        """
+        return np.array(self.bbox_inches.p1)
 
     def get_edgecolor(self):
         'Get the edge color of the Figure rectangle'
