Merge pull request #11579 from jklymak/doc-examples-use-constrainedlayout

NelleV · web-flow · commit 35083bdde521 · 2018-07-07T10:17:16.000-07:00
DOC update some examples to use constrained_layout=True
diff --git a/examples/color/color_cycler.py b/examples/color/color_cycler.py
@@ -27,7 +27,7 @@
 plt.rc('lines', linewidth=4)
 plt.rc('axes', prop_cycle=(cycler(color=['r', 'g', 'b', 'y']) +
                            cycler(linestyle=['-', '--', ':', '-.'])))
-fig, (ax0, ax1) = plt.subplots(nrows=2)
+fig, (ax0, ax1) = plt.subplots(nrows=2, constrained_layout=True)
 ax0.plot(yy)
 ax0.set_title('Set default color cycle to rgby')
 
@@ -41,8 +41,6 @@
 ax1.plot(yy)
 ax1.set_title('Set axes color cycle to cmyk')
 
-# Tweak spacing between subplots to prevent labels from overlapping
-fig.subplots_adjust(hspace=0.3)
 plt.show()
 
 #############################################################################
diff --git a/examples/images_contours_and_fields/contourf_demo.py b/examples/images_contours_and_fields/contourf_demo.py
@@ -38,7 +38,7 @@
 # occur on nice boundaries, but we do it here for purposes
 # of illustration.
 
-fig1, ax2 = plt.subplots()
+fig1, ax2 = plt.subplots(constrained_layout=True)
 CS = ax2.contourf(X, Y, Z, 10, cmap=plt.cm.bone, origin=origin)
 
 # Note that in the following, we explicitly pass in a subset of
@@ -58,7 +58,7 @@
 # Add the contour line levels to the colorbar
 cbar.add_lines(CS2)
 
-fig2, ax2 = plt.subplots()
+fig2, ax2 = plt.subplots(constrained_layout=True)
 # Now make a contour plot with the levels specified,
 # and with the colormap generated automatically from a list
 # of colors.
@@ -95,12 +95,11 @@
 # no effect:
 # cmap.set_bad("red")
 
-fig3, axs = plt.subplots(2, 2)
-fig3.subplots_adjust(hspace=0.3)
+fig, axs = plt.subplots(2, 2, constrained_layout=True)
 
 for ax, extend in zip(axs.ravel(), extends):
     cs = ax.contourf(X, Y, Z, levels, cmap=cmap, extend=extend, origin=origin)
-    fig3.colorbar(cs, ax=ax, shrink=0.9)
+    fig.colorbar(cs, ax=ax, shrink=0.9)
     ax.set_title("extend = %s" % extend)
     ax.locator_params(nbins=4)
 
diff --git a/examples/images_contours_and_fields/image_nonuniform.py b/examples/images_contours_and_fields/image_nonuniform.py
@@ -25,8 +25,7 @@
 
 z = np.sqrt(x[np.newaxis, :]**2 + y[:, np.newaxis]**2)
 
-fig, axs = plt.subplots(nrows=2, ncols=2)
-fig.subplots_adjust(bottom=0.07, hspace=0.3)
+fig, axs = plt.subplots(nrows=2, ncols=2, constrained_layout=True)
 fig.suptitle('NonUniformImage class', fontsize='large')
 ax = axs[0, 0]
 im = NonUniformImage(ax, interpolation=interp, extent=(-4, 4, -4, 4),
diff --git a/examples/lines_bars_and_markers/psd_demo.py b/examples/lines_bars_and_markers/psd_demo.py
@@ -12,11 +12,11 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import matplotlib.mlab as mlab
+import matplotlib.gridspec as gridspec
 
 # Fixing random state for reproducibility
 np.random.seed(19680801)
 
-
 dt = 0.01
 t = np.arange(0, 10, dt)
 nse = np.random.randn(len(t))
@@ -59,30 +59,32 @@
 y = y + np.random.randn(*t.shape)
 
 # Plot the raw time series
-fig = plt.figure()
-fig.subplots_adjust(hspace=0.45, wspace=0.3)
-ax = fig.add_subplot(2, 1, 1)
+fig = plt.figure(constrained_layout=True)
+gs = gridspec.GridSpec(2, 3, figure=fig)
+ax = fig.add_subplot(gs[0, :])
 ax.plot(t, y)
+ax.set_xlabel('time [s]')
+ax.set_ylabel('signal')
 
 # Plot the PSD with different amounts of zero padding. This uses the entire
 # time series at once
-ax2 = fig.add_subplot(2, 3, 4)
+ax2 = fig.add_subplot(gs[1, 0])
 ax2.psd(y, NFFT=len(t), pad_to=len(t), Fs=fs)
 ax2.psd(y, NFFT=len(t), pad_to=len(t) * 2, Fs=fs)
 ax2.psd(y, NFFT=len(t), pad_to=len(t) * 4, Fs=fs)
 plt.title('zero padding')
 
 # Plot the PSD with different block sizes, Zero pad to the length of the
 # original data sequence.
-ax3 = fig.add_subplot(2, 3, 5, sharex=ax2, sharey=ax2)
+ax3 = fig.add_subplot(gs[1, 1], sharex=ax2, sharey=ax2)
 ax3.psd(y, NFFT=len(t), pad_to=len(t), Fs=fs)
 ax3.psd(y, NFFT=len(t) // 2, pad_to=len(t), Fs=fs)
 ax3.psd(y, NFFT=len(t) // 4, pad_to=len(t), Fs=fs)
 ax3.set_ylabel('')
 plt.title('block size')
 
 # Plot the PSD with different amounts of overlap between blocks
-ax4 = fig.add_subplot(2, 3, 6, sharex=ax2, sharey=ax2)
+ax4 = fig.add_subplot(gs[1, 2], sharex=ax2, sharey=ax2)
 ax4.psd(y, NFFT=len(t) // 2, pad_to=len(t), noverlap=0, Fs=fs)
 ax4.psd(y, NFFT=len(t) // 2, pad_to=len(t),
         noverlap=int(0.05 * len(t) / 2.), Fs=fs)
@@ -106,9 +108,8 @@
 xn = (A * np.sin(2 * np.pi * f * t)).sum(axis=0)
 xn += 5 * np.random.randn(*t.shape)
 
-fig, (ax0, ax1) = plt.subplots(ncols=2)
+fig, (ax0, ax1) = plt.subplots(ncols=2, constrained_layout=True)
 
-fig.subplots_adjust(hspace=0.45, wspace=0.3)
 yticks = np.arange(-50, 30, 10)
 yrange = (yticks[0], yticks[-1])
 xticks = np.arange(0, 550, 100)
@@ -147,9 +148,8 @@
 f = np.array([150, 140]).reshape(-1, 1)
 xn = (A * np.exp(2j * np.pi * f * t)).sum(axis=0) + 5 * prng.randn(*t.shape)
 
-fig, (ax0, ax1) = plt.subplots(ncols=2)
+fig, (ax0, ax1) = plt.subplots(ncols=2, constrained_layout=True)
 
-fig.subplots_adjust(hspace=0.45, wspace=0.3)
 yticks = np.arange(-50, 30, 10)
 yrange = (yticks[0], yticks[-1])
 xticks = np.arange(-500, 550, 200)
diff --git a/examples/subplots_axes_and_figures/figure_title.py b/examples/subplots_axes_and_figures/figure_title.py
@@ -20,19 +20,16 @@ def f(t):
 t3 = np.arange(0.0, 2.0, 0.01)
 
 
-plt.subplot(121)
-plt.plot(t1, f(t1), 'o', t2, f(t2), '-')
-plt.title('subplot 1')
-plt.ylabel('Damped oscillation')
-plt.suptitle('This is a somewhat long figure title', fontsize=16)
-
-
-plt.subplot(122)
-plt.plot(t3, np.cos(2*np.pi*t3), '--')
-plt.xlabel('time (s)')
-plt.title('subplot 2')
-plt.ylabel('Undamped')
-
-plt.subplots_adjust(left=0.2, wspace=0.8, top=0.8)
+fig, axs = plt.subplots(2, 1, constrained_layout=True)
+axs[0].plot(t1, f(t1), 'o', t2, f(t2), '-')
+axs[0].set_title('subplot 1')
+axs[0].set_xlabel('distance (m)')
+axs[0].set_ylabel('Damped oscillation')
+fig.suptitle('This is a somewhat long figure title', fontsize=16)
+
+axs[1].plot(t3, np.cos(2*np.pi*t3), '--')
+axs[1].set_xlabel('time (s)')
+axs[1].set_title('subplot 2')
+axs[1].set_ylabel('Undamped')
 
 plt.show()
diff --git a/examples/text_labels_and_annotations/legend_demo.py b/examples/text_labels_and_annotations/legend_demo.py
@@ -63,7 +63,7 @@
 ###############################################################################
 # Here we attach legends to more complex plots.
 
-fig, axes = plt.subplots(3, 1)
+fig, axes = plt.subplots(3, 1, constrained_layout=True)
 top_ax, middle_ax, bottom_ax = axes
 
 top_ax.bar([0, 1, 2], [0.2, 0.3, 0.1], width=0.4, label="Bar 1",
@@ -81,13 +81,12 @@
 bottom_ax.stem([0.3, 1.5, 2.7], [1, 3.6, 2.7], label="stem test")
 bottom_ax.legend()
 
-plt.subplots_adjust(hspace=0.7)
 plt.show()
 
 ###############################################################################
 # Now we'll showcase legend entries with more than one legend key.
 
-fig, (ax1, ax2) = plt.subplots(2, 1)
+fig, (ax1, ax2) = plt.subplots(2, 1, constrained_layout=True)
 
 # First plot: two legend keys for a single entry
 p1 = ax1.scatter([1], [5], c='r', marker='s', s=100)
@@ -114,7 +113,6 @@
 l = ax2.legend([(rpos, rneg), (rneg, rpos)], ['pad!=0', 'pad=0'],
                handler_map={(rpos, rneg): HandlerTuple(ndivide=None),
                             (rneg, rpos): HandlerTuple(ndivide=None, pad=0.)})
-
 plt.show()
 
 ###############################################################################
@@ -172,7 +170,6 @@ def create_artists(self, legend, orig_handle,
 for i, color, style in zip(range(5), colors, styles):
     ax.plot(x, np.sin(x) - .1 * i, c=color, ls=style)
 
-
 # make proxy artists
 # make list of one line -- doesn't matter what the coordinates are
 line = [[(0, 0)]]
