DOC Cleaning up mplot3d/wire3d* examples: comments/docstrings, tweaks, and refactoring. [MEP12]

TrishGillett · TrishGillett · commit d79c33cd1052 · 2016-07-05T13:49:24.000-04:00
diff --git a/examples/mplot3d/wire3d_animation_demo.py b/examples/mplot3d/wire3d_animation_demo.py
@@ -1,38 +1,45 @@
-from __future__ import print_function
 """
-A very simple 'animation' of a 3D plot
+A very simple 'animation' of a 3D plot.  See also rotate_axes3d_demo.
 """
+
+from __future__ import print_function
+
 from mpl_toolkits.mplot3d import axes3d
 import matplotlib.pyplot as plt
 import numpy as np
 import time
 
 
 def generate(X, Y, phi):
+    '''
+    Generates Z data for the points in the X, Y meshgrid and parameter phi.
+    '''
     R = 1 - np.sqrt(X**2 + Y**2)
     return np.cos(2 * np.pi * X + phi) * R
 
+
 fig = plt.figure()
 ax = fig.add_subplot(111, projection='3d')
 
+# Make the X, Y meshgrid.
 xs = np.linspace(-1, 1, 50)
 ys = np.linspace(-1, 1, 50)
 X, Y = np.meshgrid(xs, ys)
-Z = generate(X, Y, 0.0)
 
+# Set the z axis limits so they aren't recalculated each frame.
+ax.set_zlim(-1, 1)
+
+# Begin plotting.
 wframe = None
 tstart = time.time()
-for phi in np.linspace(0, 360 / 2 / np.pi, 100):
-
-    oldcol = wframe
+for phi in np.linspace(0, 180. / np.pi, 100):
+    # If a line collection is already remove it before drawing.
+    if wframe:
+        ax.collections.remove(wframe)
 
+    # Plot the new wireframe and pause briefly before continuing.
     Z = generate(X, Y, phi)
     wframe = ax.plot_wireframe(X, Y, Z, rstride=2, cstride=2)
-
-    # Remove old line collection before drawing
-    if oldcol is not None:
-        ax.collections.remove(oldcol)
-
     plt.pause(.001)
 
-print('FPS: %f' % (100 / (time.time() - tstart)))
+print('Average FPS: %f' % (100 / (time.time() - tstart)))
diff --git a/examples/mplot3d/wire3d_demo.py b/examples/mplot3d/wire3d_demo.py
@@ -1,10 +1,18 @@
+'''
+A very basic demonstration of a wireframe plot.
+'''
+
 from mpl_toolkits.mplot3d import axes3d
 import matplotlib.pyplot as plt
-import numpy as np
+
 
 fig = plt.figure()
 ax = fig.add_subplot(111, projection='3d')
+
+# Grab some test data.
 X, Y, Z = axes3d.get_test_data(0.05)
+
+# Plot a basic wireframe.
 ax.plot_wireframe(X, Y, Z, rstride=10, cstride=10)
 
 plt.show()
diff --git a/examples/mplot3d/wire3d_zero_stride.py b/examples/mplot3d/wire3d_zero_stride.py
@@ -1,12 +1,24 @@
+'''
+Demonstrates that setting rstride or cstride to 0 causes wires to not be
+generated in the corresponding direction.
+'''
+
 from mpl_toolkits.mplot3d import axes3d
 import matplotlib.pyplot as plt
-import numpy as np
+
 
 fig, [ax1, ax2] = plt.subplots(2, 1, figsize=(8, 12), subplot_kw={'projection': '3d'})
+
+# Get the test data
 X, Y, Z = axes3d.get_test_data(0.05)
+
+# Give the first plot only wireframes of the type y = c
 ax1.plot_wireframe(X, Y, Z, rstride=10, cstride=0)
-ax1.set_title("Column stride 0")
+ax1.set_title("Column (x) stride set to 0")
+
+# Give the second plot only wireframes of the type x = c
 ax2.plot_wireframe(X, Y, Z, rstride=0, cstride=10)
-ax2.set_title("Row stride 0")
+ax2.set_title("Row (y) stride set to 0")
+
 plt.tight_layout()
 plt.show()
