autogalaxy.plot.Grid2DPlotter#

class Grid2DPlotter[source]#

Bases: Plotter

Plots Grid2D objects using the matplotlib method scatter() and many other matplotlib functions which customize the plot’s appearance.

The mat_plot_2d attribute wraps matplotlib function calls to make the figure. By default, the settings passed to every matplotlib function called are those specified in the config/visualize/mat_wrap/*.ini files, but a user can manually input values into MatPlot2d to customize the figure’s appearance.

Overlaid on the figure are visuals, contained in the Visuals2D object. Attributes may be extracted from the Grid2D and plotted via the visuals object, if the corresponding entry is True in the Include2D object or the config/visualize/include.ini file.

Parameters:

  • grid (Grid2D) – The 2D grid the plotter plot.

  • mat_plot_2d (MatPlot2D) – Contains objects which wrap the matplotlib function calls that make 2D plots.

  • visuals_2d (Visuals2D) – Contains 2D visuals that can be overlaid on 2D plots.

  • include_2d (Include2D) – Specifies which attributes of the Grid2D are extracted and plotted as visuals for 2D plots.

Methods

close_subplot_figure

figure_2d

Plots the plotter's Grid2D object in 2D.

get_subplot_figsize

Get the size of a sub plotter in (total_y_pixels, total_x_pixels), based on the number of subplots that are going to be plotted.

get_visuals_2d

open_subplot_figure

Setup a figure for plotting an image.

set_filename

set_format

set_mat_plot_1d_for_multi_plot

set_mat_plots_for_subplot

set_title

subplot_of_plotters_figure

Attributes

get_1d

get_2d

is_for_subplot

figure_2d(color_array=None, plot_grid_lines=False, plot_over_sampled_grid=False)[source]#

Plots the plotter’s Grid2D object in 2D.

Parameters:

  • color_array (ndarray) – An array of RGB color values which can be used to give the plotted 2D grid a colorscale (w/ colorbar).

  • plot_grid_lines (bool) – If True, a rectangular grid of lines is plotted on the figure showing the pixels which the grid coordinates are centred on.

  • plot_over_sampled_grid (bool) – If True, the grid is plotted with over-sampled sub-gridded coordinates based on the sub_size attribute of the grid’s over-sampling object.