AxesGrid: add modified version of colorbar

svn path=/trunk/matplotlib/; revision=7753

Author: leejjoon

CHANGELOG

@@ -1,3 +1,6 @@
+2009-09-13 AxesGrid : add modified version of colorbar. Add colorbar 
+           location howto. - JJL
+
 2009-09-07 AxesGrid : implemented axisline style. 
            Added a demo examples/axes_grid/demo_axisline_style.py- JJL
 

doc/mpl_toolkits/axes_grid/figures/demo_colorbar_of_inset_axes.py

@@ -0,0 +1,49 @@
+import matplotlib.pyplot as plt
+
+from mpl_toolkits.axes_grid.inset_locator import inset_axes, zoomed_inset_axes
+from mpl_toolkits.axes_grid.colorbar import colorbar
+
+def get_demo_image():
+    from matplotlib.cbook import get_sample_data
+    import numpy as np
+    f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
+    z = np.load(f)
+    # z is a numpy array of 15x15
+    return z, (-3,4,-4,3)
+
+
+fig = plt.figure(1, [5,4])
+ax = fig.add_subplot(111)
+
+Z, extent = get_demo_image()
+
+ax.set(aspect=1,
+       xlim=(-15, 15),
+       ylim=(-20, 5))
+
+
+axins = zoomed_inset_axes(ax, 2, loc=2) # zoom = 6
+im = axins.imshow(Z, extent=extent, interpolation="nearest",
+                  origin="lower")
+
+plt.xticks(visible=False)
+plt.yticks(visible=False)
+
+
+# colorbar
+cax = inset_axes(axins,
+                 width="5%", # width = 10% of parent_bbox width
+                 height="100%", # height : 50%
+                 loc=3,
+                 bbox_to_anchor=(1.05, 0., 1, 1),
+                 bbox_transform=axins.transAxes,
+                 borderpad=0,
+                 )
+
+
+colorbar(im, cax=cax) #, ticks=[1,2,3])
+
+
+plt.draw()
+plt.show()
+

doc/mpl_toolkits/axes_grid/figures/demo_colorbar_with_axes_divider.py

@@ -0,0 +1,25 @@
+import matplotlib.pyplot as plt
+from mpl_toolkits.axes_grid.axes_divider import make_axes_locatable
+
+from mpl_toolkits.axes_grid.colorbar import colorbar
+# from matplotlib.pyplot import colorbar
+
+fig = plt.figure(1, figsize=(6, 3))
+fig.subplots_adjust(wspace=0.5)
+
+ax1 = fig.add_subplot(121)
+im1 = ax1.imshow([[1,2],[3,4]])
+
+ax1_divider = make_axes_locatable(ax1)
+cax1 = ax1_divider.append_axes("right", size="7%", pad="2%")
+cb1 = colorbar(im1, cax=cax1)
+
+ax2 = fig.add_subplot(122)
+im2 = ax2.imshow([[1,2],[3,4]])
+
+ax2_divider = make_axes_locatable(ax2)
+cax2 = ax2_divider.append_axes("top", size="7%", pad="2%")
+cb2 = colorbar(im2, cax=cax2, orientation="horizontal")
+cax2.xaxis.set_ticks_position("top")
+plt.show()
+

doc/mpl_toolkits/axes_grid/figures/demo_colorbar_with_inset_locator.py

@@ -0,0 +1,40 @@
+import matplotlib.pyplot as plt
+
+from mpl_toolkits.axes_grid.inset_locator import inset_axes
+from mpl_toolkits.axes_grid.colorbar import colorbar
+
+fig = plt.figure(1, [6, 3])
+
+# first subplot
+ax1 = fig.add_subplot(121)
+
+axins1 = inset_axes(ax1,
+                    width="50%", # width = 10% of parent_bbox width
+                    height="5%", # height : 50%
+                    loc=1)
+
+im1=ax1.imshow([[1,2],[2, 3]])
+colorbar(im1, cax=axins1, orientation="horizontal", ticks=[1,2,3])
+axins1.xaxis.set_ticks_position("bottom")
+
+# first subplot
+ax = fig.add_subplot(122)
+
+axins = inset_axes(ax,
+                   width="5%", # width = 10% of parent_bbox width
+                   height="50%", # height : 50%
+                   loc=3,
+                   bbox_to_anchor=(1.05, 0., 1, 1),
+                   bbox_transform=ax.transAxes,
+                   borderpad=0,
+                   )
+
+# Controlling the placement of the inset axes is basically same as that
+# of the legend.  you may want to play with the borderpad value and
+# the bbox_to_anchor coordinate.
+
+im=ax.imshow([[1,2],[2, 3]])
+colorbar(im, cax=axins, ticks=[1,2,3])
+
+plt.draw()
+plt.show()

doc/mpl_toolkits/axes_grid/figures/demo_new_colorbar.py

@@ -0,0 +1,21 @@
+import matplotlib.pyplot as plt
+
+plt.rcParams["text.usetex"]=False
+
+fig = plt.figure(1, figsize=(6, 3))
+
+ax1 = fig.add_subplot(121)
+im1 = ax1.imshow([[1,2],[3,4]])
+cb1 = plt.colorbar(im1)
+cb1.ax.set_yticks([1, 3])
+ax1.set_title("Original MPL's colorbar w/\nset_yticks([1,3])", size=10)
+
+from mpl_toolkits.axes_grid.colorbar import colorbar
+ax2 = fig.add_subplot(122)
+im2 = ax2.imshow([[1,2],[3,4]])
+cb2 = colorbar(im2)
+cb2.ax.set_yticks([1, 3])
+ax2.set_title("AxesGrid's colorbar w/\nset_yticks([1,3])", size=10)
+
+plt.show()
+

doc/mpl_toolkits/axes_grid/index.rst

@@ -8,9 +8,11 @@ The matplotlib AxesGrid toolkit is a collection of helper classes to
 ease displaying multiple images in matplotlib.  While the aspect
 parameter in matplotlib adjust the position of the single axes,
 AxesGrid toolkit provides a framework to adjust the position of
-multiple axes according to their aspects. 
+multiple axes according to their aspects.
 
 
+.. image:: ../../_static/demo_axes_grid.png
+
 
 Documentation
 =============
@@ -19,4 +21,5 @@ Documentation
    :maxdepth: 2
 
    users/index.rst
+   howtos/index.rst
    api/index.rst

doc/mpl_toolkits/axes_grid/users/axes_divider.rst

@@ -81,12 +81,12 @@ may consider it as [0:2, 1].
 
 See the example,
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axes_divider2.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_axes_divider2.py
    :include-source:
 
 You can adjust the size of the each axes accroding to their x or y
 data limits (AxesX and AxesY), similar to the axes aspect parameter.
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axes_divider3.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_axes_divider3.py
    :include-source:
 

doc/mpl_toolkits/axes_grid/users/axislines.rst

@@ -29,7 +29,7 @@ In summary, all these changes was to support
 * a curvelinear grid.
 * a floating axis
 
-.. plot:: mpl_toolkits/axes_grid/figures/demo_floating_axis.py
+.. plot:: mpl_toolkits/axes_grid/examples/demo_floating_axis.py
 
 
 *axes_grid.axislines.Axes* defines a *axis* attribute, which is a
@@ -211,7 +211,7 @@ coordinates, or you may use Parasite Axes for convenience.::
     ax1.parasites.append(ax2)
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/demo_curvelinear_grid.py
+.. plot:: mpl_toolkits/axes_grid/examples/demo_curvelinear_grid.py
 
 
 

doc/mpl_toolkits/axes_grid/users/overview.rst

@@ -35,7 +35,7 @@ ratio.  For example, displaying images of a same size with some fixed
 padding between them cannot be easily done in matplotlib. AxesGrid is
 used in such case.
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axesgrid.py
+.. plot:: mpl_examples/axes_grid/simple_axesgrid.py
    :include-source:
 
 * The postion of each axes is determined at the drawing time (see
@@ -49,7 +49,7 @@ used in such case.
   height. The widths (height) of the axes in the same row (column) are
   scaled according to their view limits (xlim or ylim).
 
-  .. plot:: mpl_toolkits/axes_grid/figures/simple_axesgrid2.py
+  .. plot:: mpl_toolkits/axes_grid/examples/simple_axesgrid2.py
      :include-source:
 
 * xaxis are shared among axes in a same column. Similarly, yaxis are
@@ -137,7 +137,7 @@ attribute.
 
 The examples below show what you can do with AxesGrid.
 
-.. plot:: mpl_toolkits/axes_grid/figures/demo_axes_grid.py
+.. plot:: mpl_toolkits/axes_grid/examples/demo_axes_grid.py
 
 
 RGB Axes
@@ -158,7 +158,7 @@ yaxis of each axes are shared. ::
                   origin="lower", interpolation="nearest")
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_rgb.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_rgb.py
 
 
 
@@ -219,7 +219,7 @@ The "scatter_hist.py" example in mpl can be rewritten using
 See the full source code below.
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/scatter_hist.py
+.. plot:: mpl_toolkits/axes_grid/examples/scatter_hist.py
 
 
 The scatter_hist using the AxesDivider has some advantage over the
@@ -246,7 +246,7 @@ axes.
 Example 1. twinx
 ----------------
 
-.. plot:: mpl_toolkits/axes_grid/figures/parasite_simple.py
+.. plot:: mpl_toolkits/axes_grid/examples/parasite_simple.py
    :include-source:
 
 Example 2. twin
@@ -257,7 +257,7 @@ x-limit in the host axes, the x-limit of the parasite axes will change
 accordingly.
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/parasite_simple2.py
+.. plot:: mpl_toolkits/axes_grid/examples/parasite_simple2.py
 
 
 
@@ -290,13 +290,13 @@ For example, you can hide right, and top axis by ::
   ax.axis["top"].set_visible(False)
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axisline3.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_axisline3.py
 
 
 SubplotZero gives you two more additional (floating?) axis of x=0 and
 y=0 (in data coordinate)
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axisline2.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_axisline2.py
    :include-source:
 
 
@@ -315,7 +315,7 @@ axis. ::
                        r"$\pi$", r"$\frac{3}{2}\pi$", r"$2\pi$"])
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_axisline4.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_axisline4.py
 
 
 AxisLine Axes lets you create a custom axis, ::
@@ -330,7 +330,7 @@ AxisLine Axes lets you create a custom axis, ::
 And, you can use it with parasiteAxes.
 
 
-.. plot:: mpl_toolkits/axes_grid/figures/demo_parasite_axes2.py
+.. plot:: mpl_toolkits/axes_grid/examples/demo_parasite_axes2.py
 
 
 AnchoredArtists
@@ -343,7 +343,7 @@ limited support for an arbitrary transform. For example, the ellipse
 in the example below will have width and height in the data
 coordinate.
 
-.. plot:: mpl_toolkits/axes_grid/figures/simple_anchored_artists.py
+.. plot:: mpl_toolkits/axes_grid/examples/simple_anchored_artists.py
    :include-source:
 
 
@@ -377,15 +377,15 @@ some factor. For example, ::
 creates an inset axes whose data scale is half of the parent axes.
 Here is complete examples.
 
-.. plot:: mpl_toolkits/axes_grid/figures/inset_locator_demo.py
+.. plot:: mpl_toolkits/axes_grid/examples/inset_locator_demo.py
 
 For example, :func:`zoomed_inset_axes` can be used when you want the
 inset represents the zoom-up of the small portion in the parent axes.
 And :mod:`~mpl_toolkits/axes_grid/inset_locator` provides a helper
 function :func:`mark_inset` to mark the location of the area
 represented by the inset axes.
 
-.. plot:: mpl_toolkits/axes_grid/figures/inset_locator_demo2.py
+.. plot:: mpl_toolkits/axes_grid/examples/inset_locator_demo2.py
    :include-source:
 
 
@@ -395,6 +395,6 @@ Curvelinear Grid
 You can draw a cuvelinear grid and ticks. Also a floating axis can be
 created. See :ref:`axislines-manual` for more details.
 
-.. plot:: mpl_toolkits/axes_grid/figures/demo_floating_axis.py
+.. plot:: mpl_toolkits/axes_grid/examples/demo_floating_axis.py
 
 

examples/axes_grid/demo_axes_grid.py

@@ -44,7 +44,7 @@ def demo_grid_with_single_cbar(fig):
     Z, extent = get_demo_image()
     for i in range(4):
         im = grid[i].imshow(Z, extent=extent, interpolation="nearest")
-    plt.colorbar(im, cax = grid.cbar_axes[0])
+    #plt.colorbar(im, cax = grid.cbar_axes[0])
     grid.cbar_axes[0].colorbar(im)
 
     # This affects all axes as share_all = True.