Changeset 283

Timestamp:

11/04/08 20:31:18 (2 months ago)

Author:

bruederle

Message:

Formatted, documented and marginally extended the functions and classes included in module 'plotting' so far. Added working unit tests for everything.

Files:

• trunk/src/plotting.py (modified) (9 diffs)
• trunk/test/test_plotting.py (modified) (1 diff)

trunk/src/plotting.py

@@ -1 @@
-
-import numpy, pylab, sys
-from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
-from matplotlib.figure import Figure
-from matplotlib.lines import Line2D
-"""
-
+
+
+
-"""
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    inches_per_pt = 1.0/72.27               # Convert pt to inch
-    fig_width = fig_width_pt*inches_per_pt  # width in inches
-
+      
-    fig_size =  [fig_width,fig_height]
-
-    params = {
-
-
-
-
-
-
+
+
+
+
+
+
+
-    return params
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-def get_display(display):
-    """
-
+s
-    
-    Inputs:
@@ -74 +104 @@
-    else:
-        return display
-
+
+
+
-def set_labels(subplot, xlabel, ylabel):
-    """
-Function to put some labels on a plot
+Defines the axis labels in a plot.
-    
-    Inputs:
@@ -87 +119 @@
-        subplot.xlabel(xlabel)
-        subplot.ylabel(ylabel)
-se
+if hasattr(subplot, 'set_xlabel')
-        subplot.set_xlabel(xlabel)
-        subplot.set_ylabel(ylabel)
+    else: 
+        raise Exception('ERROR: The plot passed to function NeuroTools.plotting.set_label(...) does not provide labelling functions.')
+
-
-
-def set_axis_limits(subplot, xmin, xmax, ymin, ymax):
-    """
-Function to set the axis on a plot
+Defines the axis limits in a plot.
-    
-    Inputs:
-
+    
-        xmin, xmax  - the limits of the x axis
-        ymin, ymax  - the limits of the y axis
@@ -104 +139 @@
-        subplot.xlim(xmin, xmax)
-        subplot.ylim(ymin, ymax)
-se
+if hasattr(subplot, 'set_xlim')
-        subplot.set_xlim(xmin, xmax)
-        subplot.set_ylim(ymin, ymax)
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
@@ -121 +158 @@
-    the same x-range.
-    """
-    
-    def __init__(self, nrows, ncolumns, title="", xlabel=None, ylabel=None,
-                 scaling=('linear','linear')):
@@ -149 +185 @@
-            for i in range(nrows):
-                ax = self.fig.add_axes([leftlist[j],bottomlist[i],panelwidth,panelheight])
-
+lf.se
-                ax.xaxis.tick_bottom()
-                ax.yaxis.tick_left()
@@ -170 +206 @@
-        else:
-            raise Exception("Invalid value for scaling parameter")
-
+
-    def finalise(self):
-        """Adjustments to be made after all panels have been plotted."""
@@ -179 +215 @@
-            ax.xaxis.set_ticklabels([])
-
-
-
+
+
+
+
+
+
-        self.finalise()
-        self.canvas.print_figure(filename)
-
+
-    def next_panel(self):
+        """Changes to next panel within figure."""
-        ax = self.axes[self._curr_panel]
-        self._curr_panel += 1
@@ -191 +232 @@
-        ax.plot1 = getattr(ax, self.plot_function)
-        return ax
-
-
-
+
+ 
+s
-        ax = self.axes[i]
-        ax.plot1 = getattr(ax, self.plot_function)
-        return ax
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

trunk/test/test_plotting.py

@@ -2 +2 @@
-Unit tests for the NeuroTools.plotting module
-"""
+
+import unittest
+from NeuroTools import plotting
+import pylab
+import os
+
+class PylabParamsTest(unittest.TestCase):
+
+    def runTest(self):
+        
+        # define arbitrary values
+        fig_width_pt =  123.4
+        ratio = 0.1234
+        text_fontsize = 10 
+        tick_labelsize = 8
+        useTex = True
+
+        inches_per_pt = 1.0/72.27               # Convert pt to inch
+        fig_width = fig_width_pt*inches_per_pt  # width in inches
+        fig_height = fig_width*ratio            # height in inches
+
+        testDict = {
+            'axes.labelsize'  : text_fontsize,
+            'text.fontsize'   : text_fontsize,
+            'xtick.labelsize' : tick_labelsize,
+            'ytick.labelsize' : tick_labelsize,
+            'text.usetex'     : useTex,
+            'figure.figsize'  : [fig_width, fig_height]}
+
+        plotting.set_pylab_params(fig_width_pt=fig_width_pt, ratio=ratio, text_fontsize=text_fontsize, \
+            tick_labelsize=tick_labelsize, useTex=useTex)
+        for k in testDict.keys():
+            assert pylab.rcParams.has_key(k)
+            assert pylab.rcParams[k] == testDict[k]
+
+
+
+class GetDisplayTest(unittest.TestCase):
+
+    def runTest(self):
+        
+        a = plotting.get_display(True)
+        assert a != None
+        a = plotting.get_display(False)
+        assert a == None
+        a = plotting.get_display(1234)
+        assert a == 1234
+
+
+
+class SetLabelsTest(unittest.TestCase):
+
+    def runTest(self):
+
+        f = plotting.get_display(True)
+        x = range(10)
+        p = pylab.plot(x)
+        plotting.set_labels(pylab, 'the x axis', 'the y axis')
+
+        # set up a SimpleMultiplot with arbitrary values
+        self.nrows = 1
+        self.ncolumns = 1
+        title = 'testMultiplot'
+        xlabel = 'testXlabel'
+        ylabel = 'testYlabel'
+        scaling = ('linear','log')
+        self.smt = plotting.SimpleMultiplot(nrows=self.nrows, ncolumns=self.ncolumns, title=title, xlabel=xlabel, ylabel=ylabel, scaling=scaling)
+        plotting.set_labels(self.smt.panel(0), 'the x axis', 'the y axis')
+
+
+
+
+class SetAxisLimitsTest(unittest.TestCase):
+
+    def runTest(self):
+
+        f = plotting.get_display(True)
+        x = range(10)
+        pylab.plot(x)
+        plotting.set_axis_limits(pylab, 0., 123., -123., 456.)
+
+        # set up a SimpleMultiplot with arbitrary values
+        self.nrows = 1
+        self.ncolumns = 1
+        title = 'testMultiplot'
+        xlabel = 'testXlabel'
+        ylabel = 'testYlabel'
+        scaling = ('linear','log')
+        self.smt = plotting.SimpleMultiplot(nrows=self.nrows, ncolumns=self.ncolumns, title=title, xlabel=xlabel, ylabel=ylabel, scaling=scaling)
+        plotting.set_axis_limits(self.smt.panel(0), 0., 123., -123., 456.)
+
+
+
+class SimpleMultiplotTest(unittest.TestCase):
+
+    def setUp(self):
+    
+        # define arbitrary values
+        self.nrows = 4
+        self.ncolumns = 5
+        title = 'testMultiplot'
+        xlabel = 'testXlabel'
+        ylabel = 'testYlabel'
+        scaling = ('linear','log')
+        self.smt = plotting.SimpleMultiplot(nrows=self.nrows, ncolumns=self.ncolumns, title=title, xlabel=xlabel, ylabel=ylabel, scaling=scaling)
+
+
+
+class SimpleMultiplotSaveTest(SimpleMultiplotTest):
+
+    def runTest(self):
+    
+        filename = "deleteme.png"
+        if os.path.exists(filename): os.remove(filename)
+        self.smt.save(filename)
+        assert os.path.exists(filename)
+        os.remove(filename)
+
+
+
+class SimpleMultiplotSetFrameTest(SimpleMultiplotTest):
+
+    def runTest(self):
+    
+        numPanels = self.nrows * self.ncolumns
+        boollist = [True,False,False,True]
+        for i in range(numPanels):
+            ax_indexed = self.smt.panel(i)
+            ax_next = self.smt.next_panel()
+            assert ax_indexed == ax_next
+            self.smt.set_frame(ax_indexed,boollist,linewidth=4)
+
+
+
+if __name__ == "__main__":
+    unittest.main()