autolens.plot.Array2DPlotter

class autolens.plot.Array2DPlotter(array: autoarray.structures.arrays.two_d.array_2d.Array2D, mat_plot_2d: autoarray.plot.mat_wrap.mat_plot.MatPlot2D = <autoarray.plot.mat_wrap.mat_plot.MatPlot2D object>, visuals_2d: autoarray.plot.mat_wrap.visuals.Visuals2D = <autoarray.plot.mat_wrap.visuals.Visuals2D object>, include_2d: autoarray.plot.mat_wrap.include.Include2D = <autoarray.plot.mat_wrap.include.Include2D object>)
__init__(array: autoarray.structures.arrays.two_d.array_2d.Array2D, mat_plot_2d: autoarray.plot.mat_wrap.mat_plot.MatPlot2D = <autoarray.plot.mat_wrap.mat_plot.MatPlot2D object>, visuals_2d: autoarray.plot.mat_wrap.visuals.Visuals2D = <autoarray.plot.mat_wrap.visuals.Visuals2D object>, include_2d: autoarray.plot.mat_wrap.include.Include2D = <autoarray.plot.mat_wrap.include.Include2D object>)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(array, mat_plot_2d, visuals_2d, …) Initialize self.
close_subplot_figure()
extract_1d(name, value[, include_name]) Extracts an attribute for plotting in a Visuals1D object based on the following criteria:
extract_2d(name, value[, include_name]) Extracts an attribute for plotting in a Visuals2D object based on the following criteria:
figure_2d()
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.
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

is_for_subplot
visuals_with_include_2d Extracts from an Array2D attributes that can be plotted and returns them in a Visuals object.
visuals_with_include_2d

Extracts from an Array2D attributes that can be plotted and returns them in a Visuals object.

Only attributes already in self.visuals_2d or with True entries in the Include object are extracted for plotting.

From an Array2D the following attributes can be extracted for plotting:

  • origin: the (y,x) origin of the structure’s coordinate system.
  • mask: the mask of the structure.
  • border: the border of the structure’s mask.
Parameters:array (Array2D) – The array whose attributes are extracted for plotting.
Returns:The collection of attributes that can be plotted by a Plotter2D object.
Return type:Visuals2D