autogalaxy.plot.VoronoiDrawer#

class VoronoiDrawer[source]#

Bases: AbstractMatWrap2D

An abstract base class for wrapping matplotlib plotting methods.

Classes are used to wrap matplotlib so that the data structures in the autoarray.structures package can be plotted in standardized withs. This exploits how these structures have specific formats, units, properties etc. This allows us to make a simple API for plotting structures, for example to plot an Array2D structure:

import autoarray as aa import autoarray.plot as aplt

arr = aa.Array2D.no_mask(values=[[1.0, 1.0], [2.0, 2.0]], pixel_scales=2.0) aplt.Array2D(values=arr)

The wrapped Mat objects make it simple to customize how matplotlib visualizes this data structure, for example we can customize the figure size and colormap using the Figure and Cmap objects.

figure = aplt.Figure(figsize=(7,7), aspect=”square”) cmap = aplt.Cmap(cmap=”jet”, vmin=1.0, vmax=2.0)

plotter = aplt.MatPlot2D(figure=figure, cmap=cmap)

aplt.Array2D(values=arr, plotter=plotter)

The Plotter object is detailed in the autoarray.plot.plotter package.

The matplotlib wrapper objects in ths module also use configuration files to choose their default settings. For example, in autoarray.config.visualize.mat_base.Figure.ini you will note the section:

figure: figsize=(7, 7)

subplot: figsize=auto

This specifies that when a data structure (like the Array2D above) is plotted, the figsize will always be (7,7) when a single figure is plotted and it will be chosen automatically if a subplot is plotted. This allows one to customize the matplotlib settings of every plot in a project.

Methods

draw_voronoi_pixels

Draws the Voronoi pixels of the input mapper using its mesh_grid which contains the (y,x) coordinate of the centre of every Voronoi cell.

Attributes

config_category

config_dict

config_folder

log10_min_value

draw_voronoi_pixels(mapper, pixel_values, units, cmap, colorbar, colorbar_tickparams=None, ax=None, use_log10=False)[source]#

Draws the Voronoi pixels of the input mapper using its mesh_grid which contains the (y,x) coordinate of the centre of every Voronoi cell. This uses the method plt.fill.

Parameters:

  • mapper (MapperVoronoiNoInterp) – A mapper object which contains the Voronoi mesh.

  • pixel_values (Optional[ndarray]) – An array used to compute the color values that every Voronoi cell is plotted using.

  • cmap (Optional[Cmap]) – The colormap used to plot each Voronoi cell.

  • colorbar (Optional[Colorbar]) – The Colorbar object in mat_base used to set the colorbar of the figure the Voronoi mesh is plotted on.

  • colorbar_tickparams (Optional[ColorbarTickParams]) – The ColorbarTickParams object in mat_base used to set the tick labels of the colorbar.

  • ax – The matplotlib axis the Voronoi mesh is plotted on.

  • use_log10 (bool) – If True, the colorbar is plotted using a log10 scale.