Miscellaneous fixes mentioned in the PR

Author: mdboom

doc/users/whats_new.rst

@@ -24,14 +24,19 @@ new in matplotlib-1.3
 `xkcd`-style sketch plotting
 ----------------------------
 
-To gives your plots a sense of authority that they may be missing,
-Michael Droettboom (inspired by the work of many others in `issue
-#1329 <https://github.com/matplotlib/matplotlib/pull/1329>`_) has
-added an `xkcd-style <xkcd.com>`_ sketch plotting mode.  To use it,
-simply call `pyplot.xkcd` before creating your plot.
+To give your plots a sense of authority that they may be missing,
+Michael Droettboom (inspired by the work of many others in
+:ghpull:`1329`) has added an `xkcd-style <http://xkcd.com/>`_ sketch
+plotting mode.  To use it, simply call `pyplot.xkcd` before creating
+your plot.
 
 .. plot:: mpl_examples/showcase/xkcd.py
 
+Path effects on lines
+---------------------
+Thanks to Jae-Joon Lee, path effects now also work on plot lines.
+
+.. plot:: mpl_examples/pylab_examples/patheffect_demo.py
 
 Changes to font rcParams
 ------------------------

examples/pylab_examples/patheffect_demo.py

@@ -13,9 +13,9 @@
 
     txt.set_path_effects([PathEffects.withStroke(linewidth=3,
                                                  foreground="w")])
-    txt.arrow_patch.set_path_effects([PathEffects.Stroke(linewidth=5,
-                                                         foreground="w"),
-                                      PathEffects.Normal()])
+    txt.arrow_patch.set_path_effects([
+        PathEffects.Stroke(linewidth=5, foreground="w"),
+        PathEffects.Normal()])
 
     ax1.grid(True, linestyle="-")
 
@@ -29,16 +29,12 @@
     ax2.imshow(arr)
     cntr = ax2.contour(arr, colors="k")
 
-    plt.setp(cntr.collections,
-             path_effects=[PathEffects.withStroke(linewidth=3,
-                                                  foreground="w")])
-
+    plt.setp(cntr.collections, path_effects=[
+        PathEffects.withStroke(linewidth=3, foreground="w")])
 
     clbls = ax2.clabel(cntr, fmt="%2.0f", use_clabeltext=True)
-    plt.setp(clbls,
-             path_effects=[PathEffects.withStroke(linewidth=3,
-                                                  foreground="w")])
-
+    plt.setp(clbls, path_effects=[
+        PathEffects.withStroke(linewidth=3, foreground="w")])
 
     # shadow as a path effect
     ax3 = plt.subplot(133)
@@ -47,4 +43,3 @@
     leg.legendPatch.set_path_effects([PathEffects.withSimplePatchShadow()])
 
     plt.show()
-

examples/pylab_examples/to_numeric.py

@@ -30,4 +30,7 @@
 X.shape = h, w, 3
 
 im = Image.fromstring( "RGB", (w,h), s)
+
+# Uncomment this line to display the image using ImageMagick's
+# `display` tool.
 # im.show()

lib/matplotlib/__init__.py

@@ -1188,6 +1188,7 @@ def tk_window_focus():
     'matplotlib.tests.test_mathtext',
     'matplotlib.tests.test_mlab',
     'matplotlib.tests.test_patches',
+    'matplotlib.tests.test_patheffects',
     'matplotlib.tests.test_pickle',
     'matplotlib.tests.test_rcparams',
     'matplotlib.tests.test_scale',

lib/matplotlib/artist.py

@@ -460,14 +460,20 @@ def set_snap(self, snap):
 
     def get_sketch_params(self):
         """
-        Returns the sketch parameters, which is a tuple with three elements:
+        Returns the sketch parameters for the artist.
 
-          * *scale*: The amplitude of the wiggle perpendicular to the
+        Returns
+        -------
+        sketch_params : tuple or `None`
+
+        A 3-tuple with the following elements:
+
+          * `scale`: The amplitude of the wiggle perpendicular to the
             source line.
 
-          * *length*: The length of the wiggle along the line.
+          * `length`: The length of the wiggle along the line.
 
-          * *randomness*: The scale factor by which the length is
+          * `randomness`: The scale factor by which the length is
             shrunken or expanded.
 
         May return `None` if no sketch parameters were set.
@@ -476,18 +482,23 @@ def get_sketch_params(self):
 
     def set_sketch_params(self, scale=None, length=None, randomness=None):
         """
-        Sets the the sketch parameters:
+        Sets the the sketch parameters.
 
-          * *scale*: The amplitude of the wiggle perpendicular to the
-            source line, in pixels.
+        Parameters
+        ----------
 
-          * *length*: The length of the wiggle along the line, in
-             pixels (default 128.0)
+        scale : float, optional
+            The amplitude of the wiggle perpendicular to the source
+            line, in pixels.  If scale is `None`, or not provided, no
+            sketch filter will be provided.
 
-          * *randomness*: The scale factor by which the length is
-            shrunken or expanded (default 16.0)
+        length : float, optional
+             The length of the wiggle along the line, in pixels
+             (default 128.0)
 
-        If *scale* is None, no wiggling will be set.
+        randomness : float, optional
+            The scale factor by which the length is shrunken or
+            expanded (default 16.0)
         """
         if scale is None:
             self._sketch = None

lib/matplotlib/backend_bases.py

@@ -1007,14 +1007,20 @@ def get_hatch_path(self, density=6.0):
 
     def get_sketch_params(self):
         """
-        Returns the sketch parameters, which is a tuple with three elements:
+        Returns the sketch parameters for the artist.
 
-          * *scale*: The amplitude of the wiggle perpendicular to the
+        Returns
+        -------
+        sketch_params : tuple or `None`
+
+        A 3-tuple with the following elements:
+
+          * `scale`: The amplitude of the wiggle perpendicular to the
             source line.
 
-          * *length*: The length of the wiggle along the line.
+          * `length`: The length of the wiggle along the line.
 
-          * *randomness*: The scale factor by which the length is
+          * `randomness`: The scale factor by which the length is
             shrunken or expanded.
 
         May return `None` if no sketch parameters were set.
@@ -1023,18 +1029,23 @@ def get_sketch_params(self):
 
     def set_sketch_params(self, scale=None, length=None, randomness=None):
         """
-        Sets the the sketch parameters:
+        Sets the the sketch parameters.
 
-          * *scale*: The amplitude of the wiggle perpendicular to the
-            source line.
+        Parameters
+        ----------
 
-          * *length*: The length of the wiggle along the line, in
-             pixels.
+        scale : float, optional
+            The amplitude of the wiggle perpendicular to the source
+            line, in pixels.  If scale is `None`, or not provided, no
+            sketch filter will be provided.
 
-          * *randomness*: The scale factor by which the length is
-            shrunken or expanded, in pixels.
+        length : float, optional
+             The length of the wiggle along the line, in pixels
+             (default 128.0)
 
-        If *scale* is None, no wiggling will be set.
+        randomness : float, optional
+            The scale factor by which the length is shrunken or
+            expanded (default 16.0)
         """
         if scale is None:
             self._sketch = None

lib/matplotlib/collections.py

@@ -264,15 +264,13 @@ def draw(self, renderer):
             gc.set_sketch_params(*self.get_sketch_params())
 
         if self.get_path_effects():
-            #from patheffects import PathEffectsRenderer
             for pe in self.get_path_effects():
                 pe.draw_path_collection(renderer,
                     gc, transform.frozen(), paths, self.get_transforms(),
                     offsets, transOffset, self.get_facecolor(), self.get_edgecolor(),
                     self._linewidths, self._linestyles, self._antialiaseds, self._urls,
                     self._offset_position)
         else:
-
             renderer.draw_path_collection(
                 gc, transform.frozen(), paths, self.get_transforms(),
                 offsets, transOffset, self.get_facecolor(), self.get_edgecolor(),

lib/matplotlib/patheffects.py

@@ -22,8 +22,7 @@ def __init__(self):
         super(_Base, self).__init__()
 
     def get_proxy_renderer(self, renderer):
-        pe_renderer = ProxyRenderer(self, renderer)
-        return pe_renderer
+        return ProxyRenderer(self, renderer)
 
     def _update_gc(self, gc, new_gc_dict):
         new_gc_dict = new_gc_dict.copy()
@@ -96,7 +95,6 @@ def draw_path_collection(self, renderer,
             transform = transforms.Affine2D(transform.get_matrix()).translate(xo, yo)
             self.draw_path(renderer, gc0, path, transform, rgbFace)
 
-
     def draw_tex(self, renderer, gc, x, y, s, prop, angle, ismath='TeX!'):
         self._draw_text_as_path(renderer, gc, x, y, s, prop, angle, ismath="TeX")