autocti.plot.Dataset1DPlotter#

class autocti.plot.Dataset1DPlotter(dataset: ~autocti.dataset_1d.dataset_1d.dataset_1d.Dataset1D, mat_plot_1d: ~autoarray.plot.mat_plot.one_d.MatPlot1D = <autoarray.plot.mat_plot.one_d.MatPlot1D object>, visuals_1d: ~autoarray.plot.visuals.one_d.Visuals1D = <autoarray.plot.visuals.one_d.Visuals1D object>, include_1d: ~autoarray.plot.include.one_d.Include1D = <autoarray.plot.include.one_d.Include1D object>)[source]#

Bases: Plotter

Plots the attributes of Dataset1D objects using the matplotlib method line() 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 Imaging and plotted via the visuals object, if the corresponding entry is True in the Include1D object or the config/visualize/include.ini file.

Parameters:

  • dataset – The dataset 1d the plotter plots.

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

Methods

close_subplot_figure

figures_1d

Plots the individual attributes of the plotter's Dataset1D object in 1D.

fpr_mask_from

Returns a mask for the FPR of the dataset, where the prescan and overscan regions are also masked.

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

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

should_plot_zero_from

subplot

Plots the individual attributes of the plotter's Dataset1D object in 1D on a subplot.

subplot_dataset

Standard subplot of the attributes of the plotter's Dataset1D object.

subplot_of_plotters_figure

text_manual_dict_from

text_manual_dict_y_from

title_str_2d_from

title_str_from

Attributes

extract_region_from

get_1d

get_2d

is_for_subplot

figures_1d(region: Optional[str] = None, data: bool = False, data_logy: bool = False, noise_map: bool = False, signal_to_noise_map: bool = False, pre_cti_data: bool = False)[source]#

Plots the individual attributes of the plotter’s Dataset1D object in 1D.

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

If a region string is input, the 1D plots correspond to regions in 1D on the 1D dataset, which are binned up to produce a1D plot.

For example, for the input region=fpr, this function extracts the FPR over each charge region and bins them such that the 1D plot shows the average FPR.

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

Parameters:

  • region – The region on the 1D dataset where data is extracted and binned {fpr”, “eper”}

  • data – Whether to make a 1D plot (via plot) of the image data extracted and binned over the region, with the noise-map values included as error bars.

  • data_logy – Whether to make a 1D plot (via plot) of the image data extracted and binned over the region, with the noise-map values included as error bars and the y-axis on a log10 scale.

  • noise_map – Whether to make a 1D plot (via plot) of the noise-map extracted and binned over the region.

  • pre_cti_data – Whether to make a 1D plot (via plot) of the pre-cti data extracted and binned over the region.

  • signal_to_noise_map – Whether to make a 1D plot (via plot) of the signal-to-noise map data extracted and binned over the region.

subplot(data: bool = False, data_logy: bool = False, noise_map=False, signal_to_noise_map=False, pre_cti_data=False, auto_filename='subplot_dataset', **kwargs)[source]#

Plots the individual attributes of the plotter’s Dataset1D object in 1D on a subplot.

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

Parameters:

  • data – Whether to make a 1D plot (via plot) of the image data extracted and binned over the region, with the noise-map values included as error bars.

  • data_logy – Whether to make a 1D plot (via plot) of the image data extracted and binned over the region, with the noise-map values included as error bars and the y-axis on a log10 scale.

  • noise_map – Whether to include a 1D plot (via plot) of the noise map.

  • signal_to_noise_map – Whether to include a 1D plot (via plot) of the signal-to-noise map.

  • pre_cti_data – Whether to include a 1D plot (via plot) of the pre-cti data.

subplot_dataset(region: Optional[str] = None)[source]#

Standard subplot of the attributes of the plotter’s Dataset1D object.