autogalaxy.plot.LightProfilePlotter#

class LightProfilePlotter[source]#

Bases: Plotter

Plots the attributes of LightProfile 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 LightProfile 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:
  • light_profile (LightProfile) – The light profile the plotter plots.

  • grid (Union[ndarray, Grid1D, Grid2D, Grid2DIterate, Grid2DIrregular]) – The 2D (y,x) grid of coordinates used to evaluate the light profile quantities that are plotted.

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

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

  • include_1d (Include1D) – Specifies which attributes of the LightProfile are extracted and plotted as visuals for 1D plots.

  • 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 LightProfile are extracted and plotted as visuals for 2D plots.

Methods

close_subplot_figure

figures_1d

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

figures_2d

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

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_1d

rtype:

Visuals1D

get_visuals_2d

rtype:

Visuals2D

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

figures_1d(image=False)[source]#

Plots the individual attributes of the plotter’s LightProfile object in 1D, which are computed via the plotter’s grid object.

If the plotter has a 1D grid object this is used to evaluate each quantity. If it has a 2D grid, a 1D grid is computed from the light profile. This is performed by aligning a 1D grid with the major-axis of the light profile in projection, uniformly computing 1D values based on the 2D grid’s size and pixel-scale.

The API is such that every plottable attribute of the LightProfile object is an input parameter of type bool of the function, which if switched to True means that it is plotted.

Parameters:

image (bool) – Whether to make a 1D plot (via plot) of the image.

figures_2d(image=False)[source]#

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

The API is such that every plottable attribute of the LightProfile object is an input parameter of type bool of the function, which if switched to True means that it is plotted.

Parameters:

image (bool) – Whether to make a 2D plot (via imshow) of the image.