@@ -1245,21 +1245,19 @@ def __init__(self, vmin=None, vmax=None, clip=False):
1245
1245
provided, they default to the minimum and maximum values of the input,
1246
1246
respectively.
1247
1247
1248
-
1249
1248
clip : bool, default: False
1250
1249
Determines the behavior for mapping values outside the range
1251
1250
``[vmin, vmax]``.
1252
1251
1253
- If *clip* is ``False``, values outside ``[vmin, vmax]`` are also transformed
1254
- linearly, leading to results outside ``[0, 1]``. For a standard use with
1255
- colormaps, this behavior is desired because colormaps mark these outside
1256
- values with specific colors for over or under.
1257
-
1258
- If *clip* is ``True``, values outside ``[vmin, vmax]`` are set to 0 or 1,
1259
- depending on which boundary they're closer to. This makes these values
1260
- indistinguishable from regular boundary values and can lead to
1261
- misinterpretation of the data.
1252
+ If clipping is off, values outside the range ``[vmin, vmax]`` are
1253
+ also transformed, resulting in values outside ``[0, 1]``. This
1254
+ behavior is usually desirable, as colormaps can mark these *under*
1255
+ and *over* values with specific colors.
1262
1256
1257
+ If clipping is on, values below *vmin* are mapped to 0 and values
1258
+ above *vmax* are mapped to 1. Such values become indistinguishable
1259
+ from regular boundary values, which may cause misinterpretation of
1260
+ the data.
1263
1261
1264
1262
Notes
1265
1263
-----
@@ -1567,15 +1565,15 @@ def __init__(self, vcenter=0, halfrange=None, clip=False):
1567
1565
Determines the behavior for mapping values outside the range
1568
1566
``[vmin, vmax]``.
1569
1567
1570
- If clipping is off, values outside the range ``[vmin, vmax]`` are also
1571
- transformed, resulting in values outside ``[0, 1]``. For a
1572
- standard use with colormaps, this behavior is desired because colormaps
1573
- mark these outside values with specific colors for *over* or *under* .
1568
+ If clipping is off, values outside the range ``[vmin, vmax]`` are
1569
+ also transformed, resulting in values outside ``[0, 1]``. This
1570
+ behavior is usually desirable, as colormaps can mark these *under*
1571
+ and *over* values with specific colors.
1574
1572
1575
- If ``True`` values falling outside the range ``[vmin, vmax]``,
1576
- are mapped to 0 or 1, whichever is closer. This makes these values
1577
- indistinguishable from regular boundary values and can lead to
1578
- misinterpretation of the data.
1573
+ If clipping is on, values below *vmin* are mapped to 0 and values
1574
+ above *vmax* are mapped to 1. Such values become indistinguishable
1575
+ from regular boundary values, which may cause misinterpretation of
1576
+ the data.
1579
1577
1580
1578
Examples
1581
1579
--------
@@ -1852,14 +1850,13 @@ def forward(values: array-like) -> array-like
1852
1850
``[vmin, vmax]``.
1853
1851
1854
1852
If clipping is off, values outside the range ``[vmin, vmax]`` are also
1855
- transformed by the function, resulting in values outside ``[0, 1]``. For a
1856
- standard use with colormaps, this behavior is desired because colormaps
1857
- mark these outside values with specific colors for *over* or *under*.
1858
-
1859
- If ``True`` values falling outside the range ``[vmin, vmax]``,
1860
- are mapped to 0 or 1, whichever is closer. This makes these values
1861
- indistinguishable from regular boundary values and can lead to
1862
- misinterpretation of the data.
1853
+ transformed by the function, resulting in values outside ``[0, 1]``.
1854
+ This behavior is usually desirable, as colormaps can mark these *under*
1855
+ and *over* values with specific colors.
1856
+
1857
+ If clipping is on, values below *vmin* are mapped to 0 and values above
1858
+ *vmax* are mapped to 1. Such values become indistinguishable from
1859
+ regular boundary values, which may cause misinterpretation of the data.
1863
1860
"""
1864
1861
1865
1862
@@ -1957,14 +1954,13 @@ class PowerNorm(Normalize):
1957
1954
``[vmin, vmax]``.
1958
1955
1959
1956
If clipping is off, values outside the range ``[vmin, vmax]`` are also
1960
- transformed by the power function, resulting in values outside ``[0, 1]``. For
1961
- a standard use with colormaps, this behavior is desired because colormaps
1962
- mark these outside values with specific colors for *over* or *under*.
1963
-
1964
- If ``True`` values falling outside the range ``[vmin, vmax]``,
1965
- are mapped to 0 or 1, whichever is closer. This makes these values
1966
- indistinguishable from regular boundary values and can lead to
1967
- misinterpretation of the data.
1957
+ transformed by the power function, resulting in values outside ``[0, 1]``.
1958
+ This behavior is usually desirable, as colormaps can mark these *under*
1959
+ and *over* values with specific colors.
1960
+
1961
+ If clipping is on, values below *vmin* are mapped to 0 and values above
1962
+ *vmax* are mapped to 1. Such values become indistinguishable from
1963
+ regular boundary values, which may cause misinterpretation of the data.
1968
1964
1969
1965
Notes
1970
1966
-----
0 commit comments