autolens.plot.HyperPlotter

class autolens.plot.HyperPlotter(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__(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__(mat_plot_2d, visuals_2d, include_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_contribution_map(contribution_map_in) Plot the summed contribution maps of a hyper_galaxies-fit.
figure_hyper_galaxy_image(galaxy_image) Plot the image of a hyper_galaxies galaxy image.
figure_hyper_model_image(hyper_model_image) Plot the image of a hyper_galaxies galaxy image.
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_contribution_maps_of_galaxies(…)
subplot_hyper_images_of_galaxies(…)
subplot_of_plotters_figure(plotter_list, name)

Attributes

is_for_subplot
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
figure_hyper_model_image(hyper_model_image: autoarray.structures.arrays.two_d.array_2d.Array2D)

Plot the image of a hyper_galaxies galaxy image.

Set autogalaxy.datas.arrays.mat_plot_2d.mat_plot_2d for a description of all input parameters not described below.

Parameters:
  • hyper_galaxy_image (datas.imaging.datas.Imaging) – The hyper_galaxies galaxy image.
  • origin (True) – If true, the origin of the datas’s coordinate system is plotted as a ‘x’.
figure_hyper_galaxy_image(galaxy_image: autoarray.structures.arrays.two_d.array_2d.Array2D)

Plot the image of a hyper_galaxies galaxy image.

Set autogalaxy.datas.arrays.mat_plot_2d.mat_plot_2d for a description of all input parameters not described below.

Parameters:
  • hyper_galaxy_image (datas.imaging.datas.Imaging) – The hyper_galaxies galaxy image.
  • origin (True) – If true, the origin of the datas’s coordinate system is plotted as a ‘x’.
figure_contribution_map(contribution_map_in: autoarray.structures.arrays.two_d.array_2d.Array2D)

Plot the summed contribution maps of a hyper_galaxies-fit.

Set autogalaxy.datas.arrays.mat_plot_2d.mat_plot_2d for a description of all input parameters not described below.

Parameters:
  • fit (datas.fitting.fitting.AbstractLensHyperFit) – The hyper_galaxies-fit to the datas, which includes a list of every model image, residual_map, chi-squareds, etc.
  • image_index (int) – The index of the datas in the datas-set of which the contribution_maps are plotted.