matplotlib.colors.SymLogNorm¶

class
matplotlib.colors.
SymLogNorm
(linthresh, linscale=1.0, vmin=None, vmax=None, clip=False, *, base=None)[source]¶ Bases:
matplotlib.colors.Normalize
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).
Parameters:  linthreshfloat
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 powers of base to use for each half of the linear range.
For example, when linscale == 1.0 (the default) and
base=10
, then space used for the positive and negative halves of the linear range will be equal to a decade in the logarithmic. basefloat, default: None
If not given, defaults to
np.e
(consistent with prior behavior) and warns.In v3.3 the default value will change to 10 to be consistent with
SymLogNorm
.To suppress the warning pass base as a keyword argument.

__call__
(self, value, clip=None)[source]¶ Normalize value data in the
[vmin, vmax]
interval into the[0.0, 1.0]
interval and return it.Parameters:  value
Data to normalize.
 clipbool
If
None
, defaults toself.clip
(which defaults toFalse
).
Notes
If not already initialized,
self.vmin
andself.vmax
are initialized usingself.autoscale_None(value)
.

__init__
(self, linthresh, linscale=1.0, vmin=None, vmax=None, clip=False, *, base=None)[source]¶ Parameters:  linthreshfloat
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 powers of base to use for each half of the linear range.
For example, when linscale == 1.0 (the default) and
base=10
, then space used for the positive and negative halves of the linear range will be equal to a decade in the logarithmic. basefloat, default: None
If not given, defaults to
np.e
(consistent with prior behavior) and warns.In v3.3 the default value will change to 10 to be consistent with
SymLogNorm
.To suppress the warning pass base as a keyword argument.

__module__
= 'matplotlib.colors'¶

__slotnames__
= []¶