Merged revisions 8717-8718,8720 via svnmerge from

leejjoon · leejjoon · commit dee0f95c7158 · 2010-09-27T01:51:50.000Z
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/branches/v1_0_maint ........ r8717 | jdh2358 | 2010-09-24 04:54:34 +0900 (Fri, 24 Sep 2010) | 1 line added citation faq ........ r8718 | jdh2358 | 2010-09-24 05:07:12 +0900 (Fri, 24 Sep 2010) | 1 line wrap the mpl citation abstract ........ r8720 | leejjoon | 2010-09-27 10:30:19 +0900 (Mon, 27 Sep 2010) | 1 line fix bezier.get_parallerls to handle parallel input lines ........ svn path=/trunk/matplotlib/; revision=8721
diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -731,4 +731,34 @@ ellipse, :ref:`search` for ``codex ellipse``.
 
 
 
+.. _how-to-cite-mpl:
+
+Cite Matplotlib
+=================
+
+If you want to refer to matplotlib in a publication, you can use
+"Matplotlib: A 2D Graphics Environment" by J. D. Hunter In Computing in Science &
+Engineering, Vol. 9, No. 3. (2007), pp. 90-95 (see `citeulike <http://www.citeulike.org/user/jabl/article/2878517>`_)::
+
+  @article{Hunter:2007,
+	  Address = {10662 LOS VAQUEROS CIRCLE, PO BOX 3014, LOS ALAMITOS, CA 90720-1314 USA},
+	  Author = {Hunter, John D.},
+	  Date-Added = {2010-09-23 12:22:10 -0700},
+	  Date-Modified = {2010-09-23 12:22:10 -0700},
+	  Isi = {000245668100019},
+	  Isi-Recid = {155389429},
+	  Journal = {Computing In Science \& Engineering},
+	  Month = {May-Jun},
+	  Number = {3},
+	  Pages = {90--95},
+	  Publisher = {IEEE COMPUTER SOC},
+	  Times-Cited = {21},
+	  Title = {Matplotlib: A 2D graphics environment},
+	  Type = {Editorial Material},
+	  Volume = {9},
+	  Year = {2007},
+	  Abstract = {Matplotlib is a 2D graphics package used for Python for application
+                      development, interactive scripting, and publication-quality image
+                      generation across user interfaces and operating systems.},
+	  Bdsk-Url-1 = {http://gateway.isiknowledge.com/gateway/Gateway.cgi?GWVersion=2&SrcAuth=Alerting&SrcApp=Alerting&DestApp=WOS&DestLinkType=FullRecord;KeyUT=000245668100019}}
 
diff --git a/lib/matplotlib/bezier.py b/lib/matplotlib/bezier.py
@@ -9,6 +9,7 @@
 from matplotlib.path import Path
 
 from operator import xor
+import warnings
 
 
 # some functions
@@ -323,6 +324,22 @@ def get_cos_sin(x0, y0, x1, y1):
     d = (dx*dx + dy*dy)**.5
     return dx/d, dy/d
 
+def check_if_parallel(dx1, dy1, dx2, dy2, tolerence=1.e-5):
+    """ returns
+       * 1 if two lines are parralel in same direction
+       * -1 if two lines are parralel in opposite direction
+       * 0 otherwise
+    """
+    theta1 = np.arctan2(dx1, dy1)
+    theta2 = np.arctan2(dx2, dy2)
+    dtheta = np.abs(theta1 - theta2)
+    if  dtheta < tolerence:
+        return 1
+    elif np.abs(dtheta - np.pi) < tolerence:
+        return -1
+    else:
+        return False
+
 
 def get_parallels(bezier2, width):
     """
@@ -338,10 +355,18 @@ def get_parallels(bezier2, width):
     cmx, cmy = bezier2[1]
     c2x, c2y = bezier2[2]
 
-    # t1 and t2 is the anlge between c1 and cm, cm, c2.
-    # They are also a angle of the tangential line of the path at c1 and c2
-    cos_t1, sin_t1 = get_cos_sin(c1x, c1y, cmx, cmy)
-    cos_t2, sin_t2 = get_cos_sin(cmx, cmy, c2x, c2y)
+    parallel_test = check_if_parallel(c1x-cmx, c1y-cmy, cmx-c2x, cmy-c2y)
+
+    if parallel_test == -1:
+        warnings.warn("Lines do not intersect. A straight line is used instead.")
+        #cmx, cmy = 0.5*(c1x+c2x), 0.5*(c1y+c2y)
+        cos_t1, sin_t1 = get_cos_sin(c1x, c1y, c2x, c2y)
+        cos_t2, sin_t2 = cos_t1, sin_t1
+    else:
+        # t1 and t2 is the anlge between c1 and cm, cm, c2.  They are
+        # also a angle of the tangential line of the path at c1 and c2
+        cos_t1, sin_t1 = get_cos_sin(c1x, c1y, cmx, cmy)
+        cos_t2, sin_t2 = get_cos_sin(cmx, cmy, c2x, c2y)
 
     # find c1_left, c1_right which are located along the lines
     # throught c1 and perpendicular to the tangential lines of the
@@ -355,11 +380,21 @@ def get_parallels(bezier2, width):
     # find cm_left which is the intersectng point of a line through
     # c1_left with angle t1 and a line throught c2_left with angle
     # t2. Same with cm_right.
-    cmx_left, cmy_left = get_intersection(c1x_left, c1y_left, cos_t1, sin_t1,
-                                        c2x_left, c2y_left, cos_t2, sin_t2)
+    if parallel_test != 0:
+        # a special case for a straight line, i.e., angle between two
+        # lines are smaller than some (arbitrtay) value.
+        cmx_left, cmy_left = \
+                  0.5*(c1x_left+c2x_left), 0.5*(c1y_left+c2y_left)
+        cmx_right, cmy_right = \
+                   0.5*(c1x_right+c2x_right), 0.5*(c1y_right+c2y_right)
+    else:
+        cmx_left, cmy_left = \
+                  get_intersection(c1x_left, c1y_left, cos_t1, sin_t1,
+                                   c2x_left, c2y_left, cos_t2, sin_t2)
 
-    cmx_right, cmy_right = get_intersection(c1x_right, c1y_right, cos_t1, sin_t1,
-                                          c2x_right, c2y_right, cos_t2, sin_t2)
+        cmx_right, cmy_right = \
+                   get_intersection(c1x_right, c1y_right, cos_t1, sin_t1,
+                                    c2x_right, c2y_right, cos_t2, sin_t2)
 
     # the parralel bezier lines are created with control points of
     # [c1_left, cm_left, c2_left] and [c1_right, cm_right, c2_right]
