autolens.plot.PlanePlotter#

class autolens.plot.PlanePlotter(plane: ~autogalaxy.plane.plane.Plane, grid: ~typing.Union[~numpy.ndarray, Grid1D, ~autoarray.structures.grids.uniform_2d.Grid2D, ~autoarray.structures.grids.iterate_2d.Grid2DIterate, ~autoarray.structures.grids.irregular_2d.Grid2DIrregular], mat_plot_1d: ~autogalaxy.plot.mat_plot.one_d.MatPlot1D = <autogalaxy.plot.mat_plot.one_d.MatPlot1D object>, visuals_1d: ~autogalaxy.plot.visuals.one_d.Visuals1D = <autogalaxy.plot.visuals.one_d.Visuals1D object>, include_1d: ~autogalaxy.plot.include.one_d.Include1D = <autogalaxy.plot.include.one_d.Include1D object>, mat_plot_2d: ~autogalaxy.plot.mat_plot.two_d.MatPlot2D = <autogalaxy.plot.mat_plot.two_d.MatPlot2D object>, visuals_2d: ~autogalaxy.plot.visuals.two_d.Visuals2D = <autogalaxy.plot.visuals.two_d.Visuals2D object>, include_2d: ~autogalaxy.plot.include.two_d.Include2D = <autogalaxy.plot.include.two_d.Include2D object>)[source]#
__init__(plane: ~autogalaxy.plane.plane.Plane, grid: ~typing.Union[~numpy.ndarray, Grid1D, ~autoarray.structures.grids.uniform_2d.Grid2D, ~autoarray.structures.grids.iterate_2d.Grid2DIterate, ~autoarray.structures.grids.irregular_2d.Grid2DIrregular], mat_plot_1d: ~autogalaxy.plot.mat_plot.one_d.MatPlot1D = <autogalaxy.plot.mat_plot.one_d.MatPlot1D object>, visuals_1d: ~autogalaxy.plot.visuals.one_d.Visuals1D = <autogalaxy.plot.visuals.one_d.Visuals1D object>, include_1d: ~autogalaxy.plot.include.one_d.Include1D = <autogalaxy.plot.include.one_d.Include1D object>, mat_plot_2d: ~autogalaxy.plot.mat_plot.two_d.MatPlot2D = <autogalaxy.plot.mat_plot.two_d.MatPlot2D object>, visuals_2d: ~autogalaxy.plot.visuals.two_d.Visuals2D = <autogalaxy.plot.visuals.two_d.Visuals2D object>, include_2d: ~autogalaxy.plot.include.two_d.Include2D = <autogalaxy.plot.include.two_d.Include2D object>)[source]#

Plots the attributes of Plane objects using the matplotlib methods plot() and imshow() and many other matplotlib functions which customize the plot’s appearance.

The mat_plot_1d and mat_plot_2d attributes wrap 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 Visuals1D and Visuals2D objects. Attributes may be extracted from the MassProfile and plotted via the visuals object, if the corresponding entry is True in the Include1D or Include2D object or the config/visualize/include.ini file.

Parameters
  • plane – The plane the plotter plots.

  • grid – The 2D (y,x) grid of coordinates used to evaluate the plane’s light and mass quantities that are plotted.

  • mat_plot_1d – Contains objects which wrap the matplotlib function calls that make 1D plots.

  • visuals_1d – Contains 1D visuals that can be overlaid on 1D plots.

  • include_1d – Specifies which attributes of the MassProfile are extracted and plotted as visuals for 1D plots.

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

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

  • include_2d – Specifies which attributes of the MassProfile are extracted and plotted as visuals for 2D plots.

Methods

__init__(plane, grid[, mat_plot_1d, ...])

Plots the attributes of Plane objects using the matplotlib methods plot() and imshow() and many other matplotlib functions which customize the plot's appearance.

close_subplot_figure()

figures_2d([image, plane_image, plane_grid, ...])

Plots the individual attributes of the plotter's Plane object in 2D, which are computed via the plotter's 2D grid object.

figures_2d_of_galaxies([image, galaxy_index])

Plots galaxy images for each individual Galaxy in the plotter's Plane in 2D, which are computed via the plotter's 2D grid object.

galaxy_indexes_from(galaxy_index)

Returns a list of all indexes of the galaxys in the fit, which is iterated over in figures that plot individual figures of each galaxy in a plane.

galaxy_plotter_from(galaxy_index)

Returns an GalaxyPlotter corresponding to a Galaxy in the Tracer.

get_subplot_figsize(number_subplots)

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()

get_visuals_2d_of_galaxy(galaxy_index)

open_subplot_figure(number_subplots[, ...])

Setup a figure for plotting an image.

set_filename(filename)

set_format(format)

set_mat_plot_1d_for_multi_plot(...)

set_mat_plots_for_subplot(is_for_subplot[, ...])

set_title(label)

subplot([image, plane_image, plane_grid, ...])

Plots the individual attributes of the plotter's Plane object in 2D on a subplot, which are computed via the plotter's 2D grid object.

subplot_galaxy_images()

Subplot of the image of every galaxy in the plane.

subplot_of_plotters_figure(plotter_list, name)

subplot_plane()

Standard subplot of the attributes of the plotter's Plane object.

Attributes

get_1d

get_2d

is_for_subplot