DivergingNorm¶
- class DivergingNorm(vcenter=0, vmin=None, vmax=None, fair=True, clip=None)[source]¶
Bases:
Normalize
Normalizer that ensures some central data value lies at the central colormap color. The default central value is
0
.- Parameters
vcenter (
float
, default:0
) – The data value corresponding to the central colormap position.vmin (
float
, optional) – The minimum data value.vmax (
float
, optional) – The maximum data value.fair (
bool
, optional) – IfTrue
(default), the speeds of the color gradations on either side of the center point are equal, but colormap colors may be omitted. IfFalse
, all colormap colors are included, but the color gradations on one side may be faster than the other side.False
should be used with great care, as it may result in a misleading interpretation of your data.clip (
bool
, optional) – Whether to clip values falling outside ofvmin
andvmax
.
See also
Methods Summary
__call__
(value[, clip])Normalize the data values to 0-1.
Get vmin and vmax, and then clip at vcenter.