- class matplotlib.colors.SymLogNorm(linthresh, linscale=1.0, vmin=None, vmax=None, clip=False, *, base=10)#
The symmetrical logarithmic scale is logarithmic in both the positive and negative directions from the origin.
Since the values close to zero tend toward infinity, there is a need to have a range around zero that is linear. The parameter linthresh allows the user to specify the size of this range (-linthresh, linthresh).
The range within which the plot is linear (to avoid having the plot go to infinity around zero).
- linscalefloat, default: 1
This allows the linear range (-linthresh to linthresh) to be stretched relative to the logarithmic range. Its value is the number of decades to use for each half of the linear range. For example, when linscale == 1.0 (the default), the space used for the positive and negative halves of the linear range will be equal to one decade in the logarithmic range.
- basefloat, default: 10
- vmin, vmaxfloat or None
If vmin and/or vmax is not given, they are initialized from the minimum and maximum value, respectively, of the first input processed; i.e.,
- clipbool, default: False
Determines the behavior for mapping values outside the range
If clipping is off, values outside the range
[vmin, vmax]are also transformed linearly, resulting in values outside
[0, 1]. For a standard use with colormaps, this behavior is desired because colormaps mark these outside values with specific colors for over or under.
Truevalues falling outside the range
[vmin, vmax], are mapped to 0 or 1, whichever is closer. This makes these values indistinguishable from regular boundary values and can lead to misinterpretation of the data.
Returns 0 if
vmin == vmax.
- __call__(value, clip=None)#
Normalize value data in the
[vmin, vmax]interval into the
[0.0, 1.0]interval and return it.
Data to normalize.
- clipbool, optional
See the description of the parameter clip in
None, defaults to
self.clip(which defaults to
If not already initialized,
self.vmaxare initialized using
If vmin or vmax are not set, use the min/max of A to set them.