Committing rewrite of clabel inlining and label rotation code. Also, renaming

dmkaplan2000 · dmkaplan2000 · commit a095b24fc9f7 · 2008-07-24T08:50:43.000Z
ContourLabeler attributes to something like .labelAttribute.  A few of the old
attribute names have been maintained (in addition to new versions) for
backward compatibility, but these should be remove in +1 releases.

Added appropriate comments to CHANGELOG and API_CHANGES.

svn path=/trunk/matplotlib/; revision=5830
diff --git a/API_CHANGES b/API_CHANGES
@@ -8,6 +8,12 @@ Changes for 0.98.x
   Axes.patch, Axes.axesFrame renamed Axes.frame, Axes.get_frame, which
   returns Axes.patch, is deprecated.  Examples and users guide updated
 
+* Changes in the ContourLabeler attributes (clabel function) so that they
+  all have a form like .labelAttribute.  The three attributes that are most
+  likely to be used by end users, .cl, .cl_xy and .cl_cvalues have been
+  maintained for the moment (in addition to their renamed versions), but they
+  are depricated and will eventually be removed.
+
 Changes for 0.98.1
 ==================
 
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,10 +1,13 @@
+2008-07-24 Rewrite of a significant portion of the clabel code (class
+	   ContourLabeler) to improve inlining. - DMK
+
 2008-07-22 Added Barbs polygon collection (similar to Quiver) for plotting
            wind barbs.  Added corresponding helpers to Axes and pyplot as
            well. (examples/pylab_examples/barb_demo.py shows it off.) - RMM
 
 2008-07-21 Added scikits.delaunay as matplotlib.delaunay.  Added griddata
            function in matplotlib.mlab, with example (griddata_demo.py) in
-           pylab_examples. griddata function will use mpl_toolkits._natgrid 
+           pylab_examples. griddata function will use mpl_toolkits._natgrid
            if installed (haven't yet created the toolkit).  - JSW
 
 2008-07-21 Re-introduced offset_copy that works in the context of the
diff --git a/lib/matplotlib/blocking_input.py b/lib/matplotlib/blocking_input.py
@@ -19,8 +19,9 @@
 
 import time
 import numpy as np
+
 from matplotlib import path, verbose
-from cbook import is_sequence_of_strings
+from matplotlib.cbook import is_sequence_of_strings
 
 class BlockingInput(object):
     """
@@ -267,46 +268,38 @@ def button1(self,event):
 
         if event.inaxes == cs.ax:
             conmin,segmin,imin,xmin,ymin = cs.find_nearest_contour(
-                event.x, event.y, cs.label_indices)[:5]
+                event.x, event.y, cs.labelIndiceList)[:5]
 
             # Get index of nearest level in subset of levels used for labeling
-            lmin = cs.label_indices.index(conmin)
+            lmin = cs.labelIndiceList.index(conmin)
 
+            # Coordinates of contour
             paths = cs.collections[conmin].get_paths()
             lc = paths[segmin].vertices
 
-            # Figure out label rotation.  This is very cludgy.
-            # Ideally, there would be one method in ContourLabeler
-            # that would figure out the best rotation for a label at a
-            # point, but the way automatic label rotation is done is
-            # quite mysterious to me and doesn't seem easy to
-            # generalize to non-automatic label placement.  The method
-            # used below is not very robust!  It basically looks one
-            # point before and one point after label location on
-            # contour and takes mean of angles of two vectors formed.
-            # This produces "acceptable" results, but not nearly as
-            # nice as automatic method.
-            ll = lc[max(0,imin-1):imin+2] # Get points around point
-            dd = np.diff(ll,axis=0)
-            rotation = np.mean( np.arctan2(dd[:,1], dd[:,0]) ) * 180 / np.pi
-            if rotation > 90:
-                rotation = rotation -180
-            if rotation < -90:
-                rotation = 180 + rotation
-
-            cs.add_label(xmin,ymin,rotation,cs.label_levels[lmin],
-                         cs.label_cvalues[lmin])
+            # In pixel/screen space
+            slc = cs.ax.transData.transform(lc)
+
+            # Get label width for rotating labels and breaking contours
+            lw = cs.get_label_width(cs.labelLevelList[lmin],
+                                    cs.labelFmt, cs.labelFontSizeList[lmin])
+
+            # Figure out label rotation.
+            rotation,nlc = cs.calc_label_rot_and_inline(
+                slc, imin, lw, lc if self.inline else [],
+                self.inline_spacing )
+
+            cs.add_label(xmin,ymin,rotation,cs.labelLevelList[lmin],
+                         cs.labelCValueList[lmin])
 
             if self.inline:
-                # Get label width for breaking contours
-                lw = cs.get_label_width(cs.label_levels[lmin],
-                                        cs.fmt, cs.fslist[lmin])
-                # Break contour
-                new=cs.break_linecontour(lc,rotation,lw,imin)
-                if len(new[0]):
-                    paths[segmin] = path.Path(new[0])
-                if len(new[1]):
-                    paths.extend([path.Path(new[1])])
+                # Remove old, not looping over paths so we can do this up front
+                paths.pop(segmin)
+
+                # Add paths if not empty or single point
+                for n in nlc:
+                    if len(n)>1:
+                        paths.append( path.Path(n) )
 
             self.fig.canvas.draw()
         else: # Remove event if not valid
@@ -320,14 +313,21 @@ def button3(self,event):
         broken contour - once humpty-dumpty is broken, he can't be put
         back together.  In inline mode, this does nothing.
         """
+        # Remove this last event - not too important for clabel use
+        # since clabel normally doesn't have a maximum number of
+        # events, but best for cleanliness sake.
+        BlockingInput.pop(self)
+
         if self.inline:
             pass
         else:
             self.cs.pop_label()
             self.cs.ax.figure.canvas.draw()
 
-    def __call__(self,inline,n=-1,timeout=-1):
+    def __call__(self,inline,inline_spacing=5,n=-1,timeout=-1):
         self.inline=inline
+        self.inline_spacing=inline_spacing
+
         BlockingMouseInput.__call__(self,n=n,timeout=timeout,
                                     show_clicks=False)
 
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
