autolens.plot.PlanePlotter

class autolens.plot.PlanePlotter(plane: autogalaxy.plane.plane.Plane, grid: autoarray.structures.grids.two_d.grid_2d.Grid2D, mat_plot_1d: autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot1D = <autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot1D object>, visuals_1d: autogalaxy.plot.mat_wrap.lensing_visuals.Visuals1D = <autogalaxy.plot.mat_wrap.lensing_visuals.Visuals1D object>, include_1d: autogalaxy.plot.mat_wrap.lensing_include.Include1D = <autogalaxy.plot.mat_wrap.lensing_include.Include1D object>, mat_plot_2d: autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot2D = <autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot2D object>, visuals_2d: autogalaxy.plot.mat_wrap.lensing_visuals.Visuals2D = <autogalaxy.plot.mat_wrap.lensing_visuals.Visuals2D object>, include_2d: autogalaxy.plot.mat_wrap.lensing_include.Include2D = <autogalaxy.plot.mat_wrap.lensing_include.Include2D object>)
__init__(plane: autogalaxy.plane.plane.Plane, grid: autoarray.structures.grids.two_d.grid_2d.Grid2D, mat_plot_1d: autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot1D = <autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot1D object>, visuals_1d: autogalaxy.plot.mat_wrap.lensing_visuals.Visuals1D = <autogalaxy.plot.mat_wrap.lensing_visuals.Visuals1D object>, include_1d: autogalaxy.plot.mat_wrap.lensing_include.Include1D = <autogalaxy.plot.mat_wrap.lensing_include.Include1D object>, mat_plot_2d: autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot2D = <autogalaxy.plot.mat_wrap.lensing_mat_plot.MatPlot2D object>, visuals_2d: autogalaxy.plot.mat_wrap.lensing_visuals.Visuals2D = <autogalaxy.plot.mat_wrap.lensing_visuals.Visuals2D object>, include_2d: autogalaxy.plot.mat_wrap.lensing_include.Include2D = <autogalaxy.plot.mat_wrap.lensing_include.Include2D object>)

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

Methods

__init__(plane, grid, mat_plot_1d, …) 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:
figures_2d(image, plane_image, plane_grid, …)
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(image, plane_image, plane_grid, …)
subplot_of_plotters_figure(plotter_list, name)
subplot_with_source_grid()

Attributes

grid
is_for_subplot
lensing_obj
visuals_with_include_1d Extract from the LensingObj attributes that can be plotted and return them in a Visuals1D object.
visuals_with_include_2d Extracts from a Structure attributes that can be plotted and return them in a Visuals object.
visuals_with_include_2d

Extracts from a Structure attributes that can be plotted and return them in a Visuals object.

Only attributes with True entries in the Include object are extracted for plotting.

From an AbstractStructure 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:structure (abstract_structure.AbstractStructure) – The structure whose attributes are extracted for plotting.
Returns:The collection of attributes that can be plotted by a Plotter2D object.
Return type:vis.Visuals2D