DOC: add inset axes example

jklymak · jklymak · commit ea75792f36c4 · 2018-04-16T13:39:16.000-07:00
diff --git a/examples/subplots_axes_and_figures/zoom_inset_axes.py b/examples/subplots_axes_and_figures/zoom_inset_axes.py
@@ -0,0 +1,59 @@
+"""
+======================
+Zoom region inset axes
+======================
+
+Example of an inset axes and a rectangle showing where the zoom is located.
+
+"""
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+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, ax = plt.subplots(figsize=[5, 4])
+
+# make data
+Z, extent = get_demo_image()
+Z2 = np.zeros([150, 150], dtype="d")
+ny, nx = Z.shape
+Z2[30:30 + ny, 30:30 + nx] = Z
+
+ax.imshow(Z2, extent=extent, interpolation="nearest",
+          origin="lower")
+
+# inset axes....
+axins = ax.inset_axes([0.5, 0.5, 0.47, 0.47])
+axins.imshow(Z2, extent=extent, interpolation="nearest",
+          origin="lower")
+# sub region of the original image
+x1, x2, y1, y2 = -1.5, -0.9, -2.5, -1.9
+axins.set_xlim(x1, x2)
+axins.set_ylim(y1, y2)
+axins.set_xticklabels('')
+axins.set_yticklabels('')
+
+ax.zoom_inset_rectangle(axins)
+
+plt.show()
+
+#############################################################################
+#
+# ------------
+#
+# References
+# """"""""""
+#
+# The use of the following functions and methods is shown in this example:
+
+import matplotlib
+matplotlib.axes.Axes.inset_axes
+matplotlib.axes.Axes.zoom_inset_rectangle
+matplotlib.axes.Axes.imshow
