Added support for four plots; Renamed from AxesPlot to AxisPlot.

Author: jayanthc

README.rst

@@ -1,17 +1,20 @@
-AxesPlot
+AxisPlot
 ========
 
-AxesPlot extends the functionality of Matplotlib's `imshow()` function by
-appending two plots to the image, at the top or bottom, and on the left or
+AxisPlot extends the functionality of Matplotlib's `imshow()` function by
+appending up to four plots to the image, at the top, bottom, left, and/or
 right. The additional plots contain the output of operations that are performed
-along the two axes. For example, the screenshot below shows an AxesPlot with
-the mean of the image computed along the vertical axis, shown at the top, and
-the sum of the image computed along the horizontal axis, shown on the right.
+along the two axes. Plots at the top and bottom contain the output of
+operations performed along the vertical axis, while plots on the left and right
+contain the output of operations that are performed along the horizontal axis.
+For example, the screenshot below shows an AxisPlot with the mean of the image
+computed along the vertical axis, shown at the top, and the sum of the image
+computed along the horizontal axis, shown on the right.
 
 .. class:: no-web
 
-    .. image:: https://github.com/jayanthc/axesplot/blob/master/examples/example.png
-        :alt: AxesPlot screenshot
+    .. image:: https://github.com/jayanthc/axisplot/blob/master/examples/example.png
+        :alt: AxisPlot screenshot
         :height: 1088px
         :width: 1280px
         :scale: 60%
@@ -24,16 +27,19 @@ Usage
 .. code:: python
 
     import numpy as np
-    import axesplot
+    import matplotlib.pyplot as plt
+    import axisplot as ap
 
     # generate some data
     dim_x = 512
     dim_y = 256
     x = np.linspace(0, 2 * np.pi, dim_x)
     X = np.random.normal(size=(dim_y, dim_x)) + np.sin(x)
-    # create axesplot with mean along the y-axis at the top, and sum along the
+    # create axisplot with mean along the y-axis at the top, and sum along the
     # x-axis on the right
-    axesplot.AxesPlot(X, np.mean, np.sum, cmap='plasma')
+    axisplot = ap.AxisPlot(optop=np.mean, opright=np.sum, cmap='plasma')
+    axisplot.plot(X)
+    plt.show()
 
 Installation
 ------------
@@ -42,21 +48,21 @@ Development mode:
 
 ::
 
-    cd <axesplot-directory>
+    cd <axisplot-directory>
     pip install -e .
 
-Unit Testinig
+Uniit Testinig
 ------------
 
 ::
 
-    cd <axesplot-directory>
+    cd <axisplot-directory>
     python -m unittest
 
 License
 -------
 
-AxesPlot is distributed under WTFPLv2.
+AxisPlot is distributed under WTFPLv2.
 
 
 ----

axesplot/__init__.py

@@ -0,0 +1,77 @@
+import numpy as np
+import matplotlib.pyplot as plt
+import matplotlib as mp
+import mpl_toolkits.axes_grid1 as mag1
+
+
+class AxisPlot:
+    def __init__(self, optop=None, opbottom=None, opleft=None, opright=None,
+                 figsize=None, padtop=0.0, padbottom=0.0, padleft=0.0,
+                 padright=0.0, **imshowkwargs):
+        self.optop = optop
+        self.opbottom = opbottom
+        self.opleft = opleft
+        self.opright = opright
+        self.figsize = figsize
+        self.padtop = padtop
+        self.padbottom = padbottom
+        self.padleft = padleft
+        self.padright = padright
+        self.imshowkwargs = imshowkwargs
+
+        if figsize is None:
+            figsize = mp.rcParams['figure.figsize']
+        # figsize is (width, height)
+        self.aspect_ratio = figsize[0] / figsize[1]
+
+        default_height_frac = 0.2
+        # heights is (y, x)
+        self.heights = [figsize[0] * default_height_frac,
+                        figsize[1] * self.aspect_ratio * default_height_frac]
+
+        return
+
+    def plot(self, X):
+        fig, ax = plt.subplots(figsize=self.figsize)
+        ax.imshow(X, **self.imshowkwargs)
+        divider = mag1.make_axes_locatable(ax)
+
+        x = np.linspace(0, X.shape[1], X.shape[1])
+        y = np.linspace(0, X.shape[0], X.shape[0])
+
+        plot_axes = [ax]
+
+        if self.optop:
+            ax_top = divider.append_axes('top', self.heights[1],
+                                         pad=self.padtop, sharex=ax)
+            ax_top.xaxis.set_tick_params(labelbottom=False)
+            ax_top.plot(x, self.optop(X, axis=0))
+            ax_top.set_xlim(x.min(), x.max())
+            plot_axes.append(ax_top)
+        if self.opbottom:
+            ax_bottom = divider.append_axes('bottom', self.heights[1],
+                                            pad=self.padbottom, sharex=ax)
+            # turn bottom labels off for the image
+            ax.xaxis.set_tick_params(labelbottom=False)
+            ax_bottom.xaxis.set_tick_params(labelbottom=True)
+            ax_bottom.plot(x, self.opbottom(X, axis=0))
+            ax_bottom.set_xlim(x.min(), x.max())
+            plot_axes.append(ax_bottom)
+        if self.opleft:
+            ax_left = divider.append_axes('left', self.heights[0],
+                                          pad=self.padleft, sharey=ax)
+            # turn left labels off for the image
+            ax.yaxis.set_tick_params(labelleft=False)
+            ax_left.yaxis.set_tick_params(labelleft=True)
+            ax_left.plot(self.opleft(X, axis=1), y)
+            ax_left.set_ylim(y.min(), y.max())
+            plot_axes.append(ax_left)
+        if self.opright:
+            ax_right = divider.append_axes('right', self.heights[0],
+                                           pad=self.padright, sharey=ax)
+            ax_right.yaxis.set_tick_params(labelleft=False)
+            ax_right.plot(self.opright(X, axis=1), y)
+            ax_right.set_ylim(y.min(), y.max())
+            plot_axes.append(ax_right)
+
+        return plot_axes

axisplot.ipynb

@@ -1,12 +1,12 @@
 from setuptools import setup
 
-setup(name='axesplot',
+setup(name='axisplot',
       version='1.0',
       description='Matplotlib imshow() Functionality Extension',
-      url='http://github.com/jayanthc/axesplot',
+      url='http://github.com/jayanthc/axisplot',
       author='Jayanth Chennamangalam',
       license='WTFPLv2',
-      packages=['axesplot'],
+      packages=['axisplot'],
       install_requires=[
           'numpy',
           'matplotlib'

axisplot/__init__.py

@@ -1,17 +1,68 @@
 import unittest
 import numpy as np
 import matplotlib.pyplot as plt
-import axesplot
+import axisplot as ap
 
 
-class TestAxesPlot(unittest.TestCase):
-    def test(self):
+class TestAxisPlot(unittest.TestCase):
+    def test_default(self):
         # generate some data
         dim_x = 512
         dim_y = 256
         x = np.linspace(0, 2 * np.pi, dim_x)
         X = np.random.normal(size=(dim_y, dim_x)) + np.sin(x)
-        # create axesplot with mean along the y-axis at the top, and sum along
+        # create axisplot with mean along the y-axis at the top, and sum along
         # the x-axis on the right
-        axesplot.AxesPlot(X, np.mean, np.sum, cmap='plasma')
+        axisplot = ap.AxisPlot(optop=np.mean, opright=np.sum, cmap='plasma')
+        ax, ax_top, ax_right = axisplot.plot(X)
+        ax.set_xlabel('x label')
+        ax.set_ylabel('y label')
+        ax_top.set_title('test_default')
+        plt.show()
+
+    def test_all_plots(self):
+        # generate some data
+        dim_x = 512
+        dim_y = 256
+        x = np.linspace(0, 2 * np.pi, dim_x)
+        X = np.random.normal(size=(dim_y, dim_x)) + np.sin(x)
+        # create axisplot with mean along the y-axis at the top, sum along the
+        # y-axis at the bottom, mean along the x-axis on the left, and sum
+        # along the x-axis on the right
+        axisplot = ap.AxisPlot(optop=np.mean, opbottom=np.sum, opleft=np.mean,
+                               opright=np.sum, cmap='viridis')
+        _, ax_top, _, _, _ = axisplot.plot(X)
+        ax_top.set_title('test_all_plots')
+        plt.show()
+
+    def test_multiple_plots(self):
+        # generate some data
+        dim_x = 512
+        dim_y = 256
+        x = np.linspace(0, 2 * np.pi, dim_x)
+        X = np.random.normal(size=(dim_y, dim_x)) + np.sin(x)
+        # create axisplot
+        axisplot = ap.AxisPlot(optop=np.mean, opright=np.sum)
+        _, ax_top, _ = axisplot.plot(X)
+        ax_top.set_title('test_multiple_plots 0')
+        # create another axisplot with the same settings
+        X = np.random.normal(size=(dim_y, dim_x)) + np.cos(x)
+        _, ax_top, _ = axisplot.plot(X)
+        ax_top.set_title('test_multiple_plots 1')
+        plt.show()
+
+    def test_axislabels(self):
+        # generate some data
+        dim_x = 512
+        dim_y = 256
+        x = np.linspace(0, 2 * np.pi, dim_x)
+        X = np.random.normal(size=(dim_y, dim_x)) + np.sin(x)
+        # create axisplot and update some tick labels
+        axisplot = ap.AxisPlot(optop=np.mean, opright=np.sum)
+        ax, ax_top, ax_right = axisplot.plot(X)
+        ticks = ax.get_xticks()
+        labels = ax.get_xticklabels()
+        ax.set_xticklabels(map(lambda x: '{:.1f}'.format(x), ticks / 100))
+        ax_right.set_xticklabels([])
+        ax_top.set_title('test_axislabels')
         plt.show()