Change default to clip=False in Normalize.__init__

efiring · efiring · commit b69acdd9e016 · 2007-06-25T18:06:56.000Z
svn path=/trunk/matplotlib/; revision=3412
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,7 +1,12 @@
-   Made the emit property of set_xlim and set_ylim true by default;
-   removed the Axes custom callback handling into a 'callbacks'
-   attribute which is a cbook.CallbackRegistry instance.  This now
-   supports the xlim_changed and ylim_changed Axes events.
+    Changed default kwarg in colors.Normalize.__init__ to clip=False;
+    clipping silently defeats the purpose of the special over, under,
+    and bad values in the colormap, thereby leading to unexpected
+    behavior.  The new default should reduce such surprises.
+
+    Made the emit property of set_xlim and set_ylim true by default;
+    removed the Axes custom callback handling into a 'callbacks'
+    attribute which is a cbook.CallbackRegistry instance.  This now
+    supports the xlim_changed and ylim_changed Axes events.
 
 0.90.1 released
 
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2007-06-25 Changed default to clip=False in colors.Normalize;
+           modified ColorbarBase for easier colormap display - EF
+
 2007-06-13 Added maskedarray option to rc, numerix - EF
 
 2007-06-11 Python 2.5 compatibility fix for mlab.py - EF
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -561,15 +561,18 @@ class Normalize:
     """
     Normalize a given value to the 0-1 range
     """
-    def __init__(self, vmin=None, vmax=None, clip = True):
+    def __init__(self, vmin=None, vmax=None, clip=False):
         """
         If vmin or vmax is not given, they are taken from the input's
         minimum and maximum value respectively.  If clip is True and
         the given value falls outside the range, the returned value
         will be 0 or 1, whichever is closer. Returns 0 if vmin==vmax.
         Works with scalars or arrays, including masked arrays.  If
         clip is True, masked values are set to 1; otherwise they
-        remain masked.
+        remain masked.  Clipping silently defeats the purpose of setting
+        the over, under, and masked colors in the colormap, so it is
+        likely to lead to surprises; therefore the default is
+        clip=False.
         """
         self.vmin = vmin
         self.vmax = vmax
