eelbrain.plot.soft_threshold_colormap¶
-
eelbrain.plot.
soft_threshold_colormap
(cmap, threshold, vmax, subthreshold=None, symmetric=None)¶ Soft-threshold a colormap to make small values transparent
- Parameters
cmap (
str
) – Base colormap.threshold (
float
) – Value at which to threshold the colormap (i.e., the value at which to start the colormap).vmax (
float
) – Intended largest value of the colormap (used to infer the location of thethreshold
).subthreshold (matplotlib color) – Color of sub-threshold values (the default is the end or middle of the colormap, depending on whether it is symmetric).
symmetric (
Optional
[bool
]) – Whether thecmap
is symmetric (ranging from-vmax
tovmax
) or not (ranging from0
tovmax
). The default isTrue
for known symmetric colormaps andFalse
otherwise.
- Returns
Soft-thresholded colormap.
- Return type
thresholded_cmap