autolens.plot.YX1DPlotter#

class autolens.plot.YX1DPlotter(y: autoarray.structures.arrays.uniform_1d.Array1D, x: Optional[Union[autoarray.structures.arrays.uniform_1d.Array1D, autoarray.structures.grids.uniform_1d.Grid1D]] = None, mat_plot_1d: autoarray.plot.mat_wrap.mat_plot.MatPlot1D = <autoarray.plot.mat_wrap.mat_plot.MatPlot1D object>, visuals_1d: autoarray.plot.mat_wrap.visuals.Visuals1D = <autoarray.plot.mat_wrap.visuals.Visuals1D object>, include_1d: autoarray.plot.mat_wrap.include.Include1D = <autoarray.plot.mat_wrap.include.Include1D object>)[source]#
__init__(y: autoarray.structures.arrays.uniform_1d.Array1D, x: Optional[Union[autoarray.structures.arrays.uniform_1d.Array1D, autoarray.structures.grids.uniform_1d.Grid1D]] = None, mat_plot_1d: autoarray.plot.mat_wrap.mat_plot.MatPlot1D = <autoarray.plot.mat_wrap.mat_plot.MatPlot1D object>, visuals_1d: autoarray.plot.mat_wrap.visuals.Visuals1D = <autoarray.plot.mat_wrap.visuals.Visuals1D object>, include_1d: autoarray.plot.mat_wrap.include.Include1D = <autoarray.plot.mat_wrap.include.Include1D object>)[source]#

Plots two 1D objects using the matplotlib method plot() (or a similar method) and many other matplotlib functions which customize the plot’s appearance.

The mat_plot_1d 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 MatPlot1d to customize the figure’s appearance.

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

Parameters
  • y – The 1D y values the plotter plot.

  • x – The 1D x values the plotter plot.

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

Methods

__init__(y[, x, mat_plot_1d, visuals_1d, …])

Plots two 1D objects using the matplotlib method plot() (or a similar method) and many other matplotlib functions which customize the plot’s appearance.

close_subplot_figure()

figure_1d()

Plots the plotter’s y and x values in 1D.

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

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_of_plotters_figure(plotter_list, name)

Attributes

get_1d

get_2d

is_for_subplot