autogalaxy.plot.Colorbar#
- class Colorbar[source]#
Bases:
AbstractMatWrap
Customizes the colorbar of the plotted figure.
This object wraps the following Matplotlib method:
The colorbar object cb that is created is also customized using the following methods:
cb.set_yticklabels: https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.axes.Axes.set_yticklabels.html
- Parameters
Methods
Set the figure's colorbar, optionally overriding the tick labels and values with manual inputs.
Set the figure's colorbar using an array of already known color values.
Attributes
config_dict
config_folder
- set(ax=None)[source]#
Set the figure’s colorbar, optionally overriding the tick labels and values with manual inputs.
- set_with_color_values(cmap, color_values, ax=None)[source]#
Set the figure’s colorbar using an array of already known color values.
This method is used for producing the color bar on a Voronoi mesh plot, which is unable to use the in-built Matplotlib colorbar method.
- Parameters
cmap (
str
) – The colormap used to map normalized data values to RGBA colors (see https://matplotlib.org/3.3.2/api/cm_api.html).color_values (
ndarray
) – The values of the pixels on the Voronoi mesh which are used to create the colorbar.