Use 'dashed' | 'solid' to specify contour negative linestyle

efiring · efiring · commit fd54ced0ca16 · 2007-06-11T00:36:08.000Z
svn path=/trunk/matplotlib/; revision=3384
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2007-06-10 In matplotlibrc file, use 'dashed' | 'solid' instead
+           of a pair of floats for contour.negative_linestyle - EF
+
 2007-06-08 Allow plot and fill fmt string to be any mpl string
             colorspec - EF
 
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -199,6 +199,13 @@ def enumerate(seq):
              yield i, seq[i]
 
 
+def is_string_like(obj):
+    if hasattr(obj, 'shape'): return 0 # this is a workaround
+                                       # for a bug in numeric<23.1
+    try: obj + ''
+    except (TypeError, ValueError): return 0
+    return 1
+
 
 def _is_writable_dir(p):
     """
@@ -697,6 +704,14 @@ def validate_usetex(s):
 
 validate_capstyle = ValidateInStrings(['butt', 'round', 'projecting'], ignorecase=True)
 
+def validate_linecol_linestyle(s):
+    try:
+        dashes = validate_nseq_float(2)(s)
+        warnings.warn("Deprecated negative_linestyle specification; use 'solid' or 'dashed'")
+        return (0, dashes)  # (offset, (solid, blank))
+    except ValueError:
+        V = ValidateInStrings(['solid', 'dashed'], ignorecase=True)
+        return(V(s))
 
 class ValidateInterval:
     """
@@ -791,10 +806,10 @@ def __call__(self, s):
     'image.lut'    : [256, validate_int],  # lookup table
     'image.origin'    : ['upper', str],  # lookup table
 
-    'contour.negative_linestyle' : [(6.0,6.0), validate_nseq_float(2)],
+    'contour.negative_linestyle' : ['dashed', validate_linecol_linestyle],
 
     # axes props
-    'axes.axisbelow'         : [False, validate_bool],
+    'axes.axisbelow'    : [False, validate_bool],
     'axes.hold'         : [True, validate_bool],
     'axes.facecolor'    : ['w', validate_color],    # background color; white
     'axes.edgecolor'    : ['k', validate_color],    # edge color; black
@@ -1143,13 +1158,6 @@ def interactive(b):
     """
     rcParams['interactive'] = b
 
-def is_string_like(obj):
-    if hasattr(obj, 'shape'): return 0 # this is a workaround
-                                       # for a bug in numeric<23.1
-    try: obj + ''
-    except (TypeError, ValueError): return 0
-    return 1
-
 def is_interactive():
     'Return true if plot mode is interactive'
     b = rcParams['interactive']
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -472,7 +472,8 @@ def __init__(self, ax, *args, **kwargs):
                                      linewidths = width)
 
                 if level < 0.0 and self.monochrome:
-                    col.set_linestyle((0, rcParams['contour.negative_linestyle']))
+                    ls = rcParams['contour.negative_linestyle']
+                    col.set_linestyle(ls)
                 col.set_label('_nolegend_')
                 self.ax.add_collection(col)
                 self.collections.append(col)
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -123,27 +123,27 @@ units        : True
 #text.color          : black
 
 ### LaTeX customizations. See http://www.scipy.org/Wiki/Cookbook/Matplotlib/UsingTex
-#text.usetex         : False  # use latex for all text handling. The following fonts 
+#text.usetex         : False  # use latex for all text handling. The following fonts
                               # are supported through the usual rc parameter settings:
                               # new century schoolbook, bookman, times, palatino,
-                              # zapf chancery, charter, serif, sans-serif, helvetica, 
-                              # avant garde, courier, monospace, computer modern roman, 
+                              # zapf chancery, charter, serif, sans-serif, helvetica,
+                              # avant garde, courier, monospace, computer modern roman,
                               # computer modern sans serif, computer modern typewriter
                               # If another font is desired which can loaded using the
-                              # LaTeX \usepackage command, please inquire at the 
+                              # LaTeX \usepackage command, please inquire at the
                               # matplotlib mailing list
 #text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
                             # unicode strings.
 #text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                             # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                             # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.
-                            # preamble is a comma separated list of LaTeX statements 
-                            # that are included in the LaTeX document preamble. 
+                            # preamble is a comma separated list of LaTeX statements
+                            # that are included in the LaTeX document preamble.
                             # An example:
                             # text.latex.preamble : \usepackage{bm},\usepackage{euler}
-                            # The following packages are always loaded with usetex, so 
-                            # beware of package collisions: color, geometry, graphicx, 
-                            # type1cm, textcomp. Adobe Postscript (PSSNFS) font packages 
+                            # The following packages are always loaded with usetex, so
+                            # beware of package collisions: color, geometry, graphicx,
+                            # type1cm, textcomp. Adobe Postscript (PSSNFS) font packages
                             # may also be loaded, depending on your font settings
 #text.dvipnghack     : False  # some versions of dvipng don't handle
                              # alpha channel properly.  Use True to correct and flush
@@ -232,7 +232,7 @@ units        : True
 
 
 ### CONTOUR PLOTS
-#contour.negative_linestyle :  6.0, 6.0 # negative contour dashstyle (size in points)
+#contour.negative_linestyle :  dashed # dashed | solid
 
 ### SAVING FIGURES
 # the default savefig params can be different for the GUI backends.
@@ -257,14 +257,14 @@ units        : True
 
 # pdf backend params
 #pdf.compression   : 6 # integer from 0 to 9
-		      # 0 disables compression (good for debugging)
+                       # 0 disables compression (good for debugging)
 
 # svg backend params
 #svg.image_inline : True       # write raster image data directly into the svg file
 #svg.image_noscale : False     # suppress scaling of raster data embedded in SVG
 
 # Set the verbose flags.  This controls how much information
-# matplotlib gives you at runtime and where it goes.  Ther verbosity
+# matplotlib gives you at runtime and where it goes.  The verbosity
 # levels are: silent, helpful, debug, debug-annoying.  Any level is
 # inclusive of all the levels below it.  If you setting is debug,
 # you'll get all the debug and helpful messages.  When submitting
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -123,27 +123,27 @@ units        : True
 #text.color          : black
 
 ### LaTeX customizations. See http://www.scipy.org/Wiki/Cookbook/Matplotlib/UsingTex
-#text.usetex         : False  # use latex for all text handling. The following fonts 
+#text.usetex         : False  # use latex for all text handling. The following fonts
                               # are supported through the usual rc parameter settings:
                               # new century schoolbook, bookman, times, palatino,
-                              # zapf chancery, charter, serif, sans-serif, helvetica, 
-                              # avant garde, courier, monospace, computer modern roman, 
+                              # zapf chancery, charter, serif, sans-serif, helvetica,
+                              # avant garde, courier, monospace, computer modern roman,
                               # computer modern sans serif, computer modern typewriter
                               # If another font is desired which can loaded using the
-                              # LaTeX \usepackage command, please inquire at the 
+                              # LaTeX \usepackage command, please inquire at the
                               # matplotlib mailing list
 #text.latex.unicode : False # use "ucs" and "inputenc" LaTeX packages for handling
                             # unicode strings.
 #text.latex.preamble :  # IMPROPER USE OF THIS FEATURE WILL LEAD TO LATEX FAILURES
                             # AND IS THEREFORE UNSUPPORTED. PLEASE DO NOT ASK FOR HELP
                             # IF THIS FEATURE DOES NOT DO WHAT YOU EXPECT IT TO.
-                            # preamble is a comma separated list of LaTeX statements 
-                            # that are included in the LaTeX document preamble. 
+                            # preamble is a comma separated list of LaTeX statements
+                            # that are included in the LaTeX document preamble.
                             # An example:
                             # text.latex.preamble : \usepackage{bm},\usepackage{euler}
-                            # The following packages are always loaded with usetex, so 
-                            # beware of package collisions: color, geometry, graphicx, 
-                            # type1cm, textcomp. Adobe Postscript (PSSNFS) font packages 
+                            # The following packages are always loaded with usetex, so
+                            # beware of package collisions: color, geometry, graphicx,
+                            # type1cm, textcomp. Adobe Postscript (PSSNFS) font packages
                             # may also be loaded, depending on your font settings
 #text.dvipnghack     : False  # some versions of dvipng don't handle
                              # alpha channel properly.  Use True to correct and flush
@@ -232,7 +232,7 @@ units        : True
 
 
 ### CONTOUR PLOTS
-#contour.negative_linestyle :  6.0, 6.0 # negative contour dashstyle (size in points)
+#contour.negative_linestyle :  dashed # dashed | solid
 
 ### SAVING FIGURES
 # the default savefig params can be different for the GUI backends.
@@ -257,14 +257,14 @@ units        : True
 
 # pdf backend params
 #pdf.compression   : 6 # integer from 0 to 9
-		      # 0 disables compression (good for debugging)
+                       # 0 disables compression (good for debugging)
 
 # svg backend params
 #svg.image_inline : True       # write raster image data directly into the svg file
 #svg.image_noscale : False     # suppress scaling of raster data embedded in SVG
 
 # Set the verbose flags.  This controls how much information
-# matplotlib gives you at runtime and where it goes.  Ther verbosity
+# matplotlib gives you at runtime and where it goes.  The verbosity
 # levels are: silent, helpful, debug, debug-annoying.  Any level is
 # inclusive of all the levels below it.  If you setting is debug,
 # you'll get all the debug and helpful messages.  When submitting
