added custom figure class hook

jdh2358 · jdh2358 · commit d346f28dd95e · 2006-06-21T13:22:31.000Z
svn path=/trunk/matplotlib/; revision=2502
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2006-06-20 Added custom FigureClass hook to pylab interface - see
+           examples/custom_figure_class.py
+
 2006-06-16 Added colormaps from gist (gist_earth, gist_stern, 
            gist_rainbow, gist_gray, gist_yarg, gist_heat, gist_ncar) - JW
 
diff --git a/examples/custom_figure_class.py b/examples/custom_figure_class.py
@@ -0,0 +1,22 @@
+"""
+You can pass a custom Figure constructor to figure if youy want to derive from the default Figure.  This simple example creates a figure with a figure title
+"""
+from pylab import figure, show, nx
+from matplotlib.figure import Figure
+
+class MyFigure(Figure):
+    def __init__(self, *args, **kwargs):
+        """
+        custom kwarg figtitle is passed on to 
+        """
+        Figure.__init__(self, *args, **kwargs)
+        figtitle = kwargs.get('figtitle', 'hi mom')
+        self.text(0.5, 0.95, figtitle, ha='center')
+
+fig = figure(FigureClass=MyFigure)
+ax = fig.add_subplot(111)
+ax.plot([1,2,3])
+fig.savefig('test.png')
+fig.savefig('test.ps')
+show()
+            
diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -355,7 +355,9 @@ def new_figure_manager(num, *args, **kwargs):
     if __debug__: verbose.report('backend_agg.new_figure_manager',
                                  'debug-annoying')
 
-    thisFig = Figure(*args, **kwargs)
+
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasAgg(thisFig)
     manager = FigureManagerBase(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_agg2.py b/lib/matplotlib/backends/backend_agg2.py
@@ -138,8 +138,8 @@ def new_figure_manager(num, *args, **kwargs):
     Create a new figure manager instance
     """
     if __debug__: verbose.report('backend_agg.new_figure_manager', 'debug-annoying')
-
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasAgg(thisFig)
     manager = FigureManagerBase(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_cairo.py b/lib/matplotlib/backends/backend_cairo.py
@@ -510,7 +510,8 @@ def new_figure_manager(num, *args, **kwargs): # called by backends/__init__.py
     Create a new figure manager instance
     """
     if _debug: print '%s.%s()' % (self.__class__.__name__, _fn_name())
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas  = FigureCanvasCairo(thisFig)
     manager = FigureManagerBase(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_cocoaagg.py b/lib/matplotlib/backends/backend_cocoaagg.py
@@ -36,7 +36,8 @@
 mplBundle = NSBundle.bundleWithPath_(matplotlib.get_data_path())
 
 def new_figure_manager(num, *args, **kwargs):
-    thisFig = Figure( *args, **kwargs )
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass( *args, **kwargs )
     canvas = FigureCanvasCocoaAgg(thisFig)
     return FigureManagerCocoaAgg(canvas, num)
 
diff --git a/lib/matplotlib/backends/backend_emf.py b/lib/matplotlib/backends/backend_emf.py
@@ -576,8 +576,8 @@ def new_figure_manager(num, *args, **kwargs):
     # do it -- see backend_wx, backend_wxagg and backend_tkagg for
     # examples.  Not all GUIs require explicit instantiation of a
     # main-level app (egg backend_gtk, backend_gtkagg) for pylab
-
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasEMF(thisFig)
     manager = FigureManagerEMF(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_fltkagg.py b/lib/matplotlib/backends/backend_fltkagg.py
@@ -111,7 +111,8 @@ def new_figure_manager(num, *args, **kwargs):
     """
     Create a new figure manager instance
     """
-    figure = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    figure = FigureClass(*args, **kwargs)
     window = Fltk.Fl_Double_Window(10,10,30,30)
     canvas = FigureCanvasFltkAgg(figure)   
     window.end()    
diff --git a/lib/matplotlib/backends/backend_gd.py b/lib/matplotlib/backends/backend_gd.py
@@ -321,7 +321,8 @@ def new_figure_manager(num, *args, **kwargs):
     backends, you'll need to instantiate a new window and embed
     the figure in it.
     """
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasGD(thisFig)
     manager = FigureManagerGD(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_gdk.py b/lib/matplotlib/backends/backend_gdk.py
@@ -460,7 +460,8 @@ def new_figure_manager(num, *args, **kwargs):
     """
     Create a new figure manager instance
     """
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas  = FigureCanvasGDK(thisFig)
     manager = FigureManagerBase(canvas, num)
     # equals:
diff --git a/lib/matplotlib/backends/backend_gtk.py b/lib/matplotlib/backends/backend_gtk.py
@@ -82,7 +82,8 @@ def new_figure_manager(num, *args, **kwargs):
     """
     Create a new figure manager instance
     """
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)    
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasGTK(thisFig)
     manager = FigureManagerGTK(canvas, num)
     # equals:
diff --git a/lib/matplotlib/backends/backend_gtkagg.py b/lib/matplotlib/backends/backend_gtkagg.py
@@ -38,7 +38,8 @@ def new_figure_manager(num, *args, **kwargs):
     Create a new figure manager instance
     """
     if DEBUG: print 'backend_gtkagg.new_figure_manager'
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasGTKAgg(thisFig)
     return FigureManagerGTKAgg(canvas, num)
     if DEBUG: print 'backend_gtkagg.new_figure_manager done'
diff --git a/lib/matplotlib/backends/backend_gtkcairo.py b/lib/matplotlib/backends/backend_gtkcairo.py
@@ -22,7 +22,8 @@ def new_figure_manager(num, *args, **kwargs):
     Create a new figure manager instance
     """
     if _debug: print 'backend_gtkcairo.%s()' % fn_name()
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasGTKCairo(thisFig)
     return FigureManagerGTK(canvas, num)
 
diff --git a/lib/matplotlib/backends/backend_paint.py b/lib/matplotlib/backends/backend_paint.py
@@ -279,7 +279,8 @@ def new_figure_manager_paint(num, *args, **kwargs):
     backends, you'll need to instantiate a new window and embed
     the figure in it.
     """
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasPaint(thisFig)
     manager = FigureManagerBase(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -685,8 +685,8 @@ def new_figure_manager(num, *args, **kwargs):
     # do it -- see backend_wx, backend_wxagg and backend_tkagg for
     # examples.  Not all GUIs require explicit instantiation of a
     # main-level app (egg backend_gtk, backend_gtkagg) for pylab
-
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasPdf(thisFig)
     manager = FigureManagerPdf(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_ps.py b/lib/matplotlib/backends/backend_ps.py
@@ -873,7 +873,8 @@ def get_joinstyle(self):
 
 
 def new_figure_manager(num, *args, **kwargs):
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasPS(thisFig)
     manager = FigureManagerPS(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_qt.py b/lib/matplotlib/backends/backend_qt.py
@@ -63,7 +63,8 @@ def new_figure_manager( num, *args, **kwargs ):
     """
     Create a new figure manager instance
     """
-    thisFig = Figure( *args, **kwargs )
+    FigureClass = kwargs.pop('FigureClass', Figure)    
+    thisFig = FigureClass( *args, **kwargs )
     canvas = FigureCanvasQT( thisFig )
     manager = FigureManagerQT( canvas, num )
     return manager
diff --git a/lib/matplotlib/backends/backend_qtagg.py b/lib/matplotlib/backends/backend_qtagg.py
@@ -20,7 +20,8 @@ def new_figure_manager( num, *args, **kwargs ):
     Create a new figure manager instance
     """
     if DEBUG: print 'backend_qtagg.new_figure_manager'
-    thisFig = Figure( *args, **kwargs )
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass( *args, **kwargs )
     canvas = FigureCanvasQTAgg( thisFig )
     return FigureManagerQT( canvas, num )
 
diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -14,7 +14,8 @@
 backend_version = __version__
 
 def new_figure_manager(num, *args):
-    thisFig = Figure(*args)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args)
     canvas  = FigureCanvasSVG(thisFig)
     manager = FigureManagerSVG(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py
@@ -166,8 +166,8 @@ def new_figure_manager(num, *args, **kwargs):
     # do it -- see backend_wx, backend_wxagg and backend_tkagg for
     # examples.  Not all GUIs require explicit instantiation of a
     # main-level app (egg backend_gtk, backend_gtkagg) for pylab
-
-    thisFig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    thisFig = FigureClass(*args, **kwargs)
     canvas = FigureCanvasTemplate(thisFig)
     manager = FigureManagerTemplate(canvas, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -83,7 +83,8 @@ def new_figure_manager(num, *args, **kwargs):
     Create a new figure manager instance
     """
     _focus = windowing.FocusManager()
-    figure = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    figure = FigureClass(*args, **kwargs)
     window = Tk.Tk()
     canvas = FigureCanvasTkAgg(figure, master=window)    
     figManager = FigureManagerTkAgg(canvas, num, window)
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -1210,7 +1210,8 @@ def new_figure_manager(num, *args, **kwargs):
         wxapp = wx.PySimpleApp()
         wxapp.SetExitOnFrameDelete(True)
 
-    fig = Figure(*args, **kwargs)
+    FigureClass = kwargs.pop('FigureClass', Figure)
+    fig = FigureClass(*args, **kwargs)
     frame = FigureFrameWx(num, fig)
     figmgr = frame.get_figure_manager()
     if matplotlib.is_interactive():
diff --git a/lib/matplotlib/backends/backend_wxagg.py b/lib/matplotlib/backends/backend_wxagg.py
@@ -132,8 +132,9 @@ def new_figure_manager(num, *args, **kwargs):
         if backend_wx.wxapp is None:
             backend_wx.wxapp = wx.PySimpleApp()
             backend_wx.wxapp.SetExitOnFrameDelete(True)
-    
-    fig = Figure(*args, **kwargs)
+
+    FigureClass = kwargs.pop('FigureClass', Figure)    
+    fig = FigureClass(*args, **kwargs)
     frame = FigureFrameWxAgg(num, fig)
     figmgr = frame.get_figure_manager()
     if matplotlib.is_interactive():
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -819,6 +819,8 @@ def figure(num=None, # autoincrement if None, else integer from 1-N
            facecolor = None, # defaults to rc figure.facecolor
            edgecolor = None, # defaults to rc figure.edgecolor
            frameon = True,
+           FigureClass = Figure,
+           **kwargs
            ):
     """
     figure(num = None, figsize=(8, 6), dpi=80, facecolor='w', edgecolor='k')
@@ -846,6 +848,11 @@ def figure(num=None, # autoincrement if None, else integer from 1-N
       edgecolor - the border color; defaults to rc figure.edgecolor
 
     rcParams gives the default values from the .matplotlibrc file
+
+    FigureClass is a Figure or derived class that will be passed on to
+    new_figure_manager in the backends which allows you to hook custom
+    Figureclasses into the pylab interface.  Additional kwargs will be
+    passed on to your figure init function
     """
 
     if figsize is None   : figsize   = rcParams['figure.figsize']
@@ -863,7 +870,8 @@ def figure(num=None, # autoincrement if None, else integer from 1-N
     figManager = _pylab_helpers.Gcf.get_fig_manager(num)
     if figManager is None:
         if get_backend()=='PS':  dpi = 72
-        figManager = new_figure_manager(num, figsize, dpi, facecolor, edgecolor, frameon)
+        
+        figManager = new_figure_manager(num, figsize, dpi, facecolor, edgecolor, frameon, FigureClass=FigureClass, **kwargs)
         _pylab_helpers.Gcf.set_active(figManager)
         figManager.canvas.figure.number = num
 
