autocti.plot.Cmap

class autocti.plot.Cmap(symmetric: bool = False, **kwargs)

Bases: AbstractMatWrap

Customizes the Matplotlib colormap and its normalization.

This object wraps the following Matplotlib methods:

• colors.Linear: https://matplotlib.org/3.3.2/tutorials/colors/colormaps.html

• colors.LogNorm: https://matplotlib.org/3.3.2/tutorials/colors/colormapnorms.html

• colors.SymLogNorm: https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.colors.SymLogNorm.html

The cmap that is created is passed into various Matplotlib methods, most notably imshow:

• https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.pyplot.imshow.html

Parameters:

symmetric – If True, the colormap normalization (e.g. vmin and vmax) span the same absolute values producing a symmetric color bar.

Methods

norm_from	Returns the Normalization object which scales of the colormap.
symmetric_cmap_from
vmax_from
vmin_from

Attributes

cmap
config_category
config_dict
config_folder
log10_min_value

norm_from(array: ndarray, use_log10: bool = False) → object

Returns the Normalization object which scales of the colormap.

If vmin / vmax are not manually input by the user, the minimum / maximum values of the data being plotted are used.

Parameters:

array – The array of data which is to be plotted.