Merge branch 'dmcdouggall-trisurf'

WeatherGod · WeatherGod · commit 391f5093ebe6 · 2012-03-13T14:31:15.000-05:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,6 +1,9 @@
 2012-02-29 errorevery keyword added to errorbar to enable errorbar
            subsampling. fixes issue #600.
 
+2012-02-28 Added plot_trisurf to the mplot3d toolkit. This supports plotting
+           three dimensional surfaces on an irregular grid. - Damon McDougall
+
 2012-01-23 The radius labels in polar plots no longer use a fixed
            padding, but use a different alignment depending on the
            quadrant they are in.  This fixes numerical problems when
diff --git a/doc/mpl_toolkits/mplot3d/tutorial.rst b/doc/mpl_toolkits/mplot3d/tutorial.rst
@@ -64,6 +64,15 @@ Surface plots
 .. plot:: mpl_examples/mplot3d/surface3d_demo2.py
 .. plot:: mpl_examples/mplot3d/surface3d_demo3.py
 
+.. _trisurface:
+
+Tri-Surface plots
+=================
+.. automethod:: Axes3D.plot_trisurface
+
+.. plot:: mpl_examples/mplot3d/trisurf3d_demo.py
+
+
 .. _contour3d:
 
 Contour plots
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -12,6 +12,20 @@ This page just covers the highlights -- for the full story, see the
    versions 2.4 to 2.7.  matplotlib 1.2 and later require
    versions 2.6, 2.7, and 3.1 and higher.
 
+.. _whats-new-1-2:
+
+new in matplotlib-1.2
+=====================
+
+Tri-Surface Plots
+-----------------
+
+Damon McDougall added a new plotting method for the
+:mod:`~mpl_toolkits.mplot3d` toolkit called
+:meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf`.
+
+.. plot:: mpl_examples/mplot3d/trisurf3d_demo.py
+
 .. _whats-new-1-1:
 
 new in matplotlib-1.1
diff --git a/examples/mplot3d/trisurf3d_demo.py b/examples/mplot3d/trisurf3d_demo.py
@@ -0,0 +1,32 @@
+from mpl_toolkits.mplot3d import Axes3D
+from matplotlib import cm
+import matplotlib.pyplot as plt
+import numpy as np
+
+n_angles = 36
+n_radii = 8
+
+# An array of radii
+# Does not include radius r=0, this is to eliminate duplicate points
+radii = np.linspace(0.125, 1.0, n_radii)
+
+# An array of angles
+angles = np.linspace(0, 2*np.pi, n_angles, endpoint=False)
+
+# Repeat all angles for each radius
+angles = np.repeat(angles[...,np.newaxis], n_radii, axis=1)
+
+# Convert polar (radii, angles) coords to cartesian (x, y) coords
+# (0, 0) is added here. There are no duplicate points in the (x, y) plane
+x = np.append(0, (radii*np.cos(angles)).flatten())
+y = np.append(0, (radii*np.sin(angles)).flatten())
+
+# Pringle surface
+z = np.sin(-x*y)
+
+fig = plt.figure()
+ax = fig.gca(projection='3d')
+
+ax.plot_trisurf(x, y, z, cmap=cm.jet, linewidth=0.2)
+
+plt.show()
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -19,6 +19,7 @@
 import matplotlib.collections as mcoll
 from matplotlib import docstring
 import matplotlib.scale as mscale
+from matplotlib.tri.triangulation import Triangulation
 import numpy as np
 from matplotlib.colors import Normalize, colorConverter, LightSource
 
@@ -1570,6 +1571,97 @@ def plot_wireframe(self, X, Y, Z, *args, **kwargs):
 
         return linec
 
+    def plot_trisurf(self, X, Y, Z, *args, **kwargs):
+        """
+        ============= ================================================
+        Argument      Description
+        ============= ================================================
+        *X*, *Y*, *Z* Data values as 1D arrays
+        *color*       Color of the surface patches
+        *cmap*        A colormap for the surface patches.
+        *norm*        An instance of Normalize to map values to colors
+        *vmin*        Minimum value to map
+        *vmax*        Maximum value to map
+        *shade*       Whether to shade the facecolors
+        ============= ================================================
+
+        Other arguments are passed on to
+        :class:`~mpl_toolkits.mplot3d.art3d.Poly3DCollection`
+
+        .. versionadded:: 1.2.0
+            This plotting function was added for the v1.2.0 release.
+        """
+
+        had_data = self.has_data()
+
+        # TODO: Support custom face colours
+        color = np.array(colorConverter.to_rgba(kwargs.pop('color', 'b')))
+
+        cmap = kwargs.get('cmap', None)
+        norm = kwargs.pop('norm', None)
+        vmin = kwargs.pop('vmin', None)
+        vmax = kwargs.pop('vmax', None)
+        linewidth = kwargs.get('linewidth', None)
+        shade = kwargs.pop('shade', cmap is None)
+        lightsource = kwargs.pop('lightsource', None)
+
+        # TODO: Support masked triangulations
+        tri = Triangulation(X, Y)
+        x = tri.x
+        y = tri.y
+        triangles = tri.triangles
+
+        xt = x[triangles][...,np.newaxis]
+        yt = y[triangles][...,np.newaxis]
+        zt = np.array(Z)[triangles][...,np.newaxis]
+
+        verts = np.concatenate((xt, yt, zt), axis=2)
+
+        # Only need these vectors to shade if there is no cmap
+        if cmap is None and shade:
+            totpts = len(verts)
+            v1 = np.empty((totpts, 3))
+            v2 = np.empty((totpts, 3))
+            # This indexes the vertex points
+            which_pt = 0
+
+        colset = []
+        for i in xrange(len(verts)):
+            avgzsum = verts[i,0,2] + verts[i,1,2] + verts[i,2,2]
+            colset.append(avgzsum / 3.0)
+
+            # Only need vectors to shade if no cmap
+            if cmap is None and shade:
+                v1[which_pt] = np.array(verts[i,0]) - np.array(verts[i,1])
+                v2[which_pt] = np.array(verts[i,1]) - np.array(verts[i,2])
+                which_pt += 1
+
+        if cmap is None and shade:
+            normals = np.cross(v1, v2)
+        else:
+            normals = []
+
+        polyc = art3d.Poly3DCollection(verts, *args, **kwargs)
+
+        if cmap:
+            colset = np.array(colset)
+            polyc.set_array(colset)
+            if vmin is not None or vmax is not None:
+                polyc.set_clim(vmin, vmax)
+            if norm is not None:
+                polyc.set_norm(norm)
+        else:
+            if shade:
+                colset = self._shade_colors(color, normals)
+            else:
+                colset = color
+            polyc.set_facecolors(colset)
+
+        self.add_collection(polyc)
+        self.auto_scale_xyz(X, Y, Z, had_data)
+
+        return polyc
+
     def _3d_extend_contour(self, cset, stride=5):
         '''
         Extend a contour in 3D by creating
