Plotting

PyAutoCTI custom visualization library.

Step-by-step Juypter notebook guides illustrating all objects listed on this page are provided on the autocti_workspace: plot tutorials and it is strongly recommended you use those to learn plot customization.

Examples / Tutorials:

• autocti_workspace: plot tutorials

Plotters [aplt]

Create figures and subplots showing quantities of standard PyAutoCTI objects.

Array2DPlotter(array, mat_plot_2d, ...)	Plots Array2D objects using the matplotlib method imshow() and many other matplotlib functions which customize the plot's appearance.
Array1DPlotter	alias of YX1DPlotter
YX1DPlotter(y, ~typing.List], x, ...[, ...])	Plots two 1D objects using the matplotlib method plot() (or a similar method) and many other matplotlib functions which customize the plot's appearance.
Dataset1DPlotter(dataset, mat_plot_1d, ...)	Plots the attributes of Dataset1D objects using the matplotlib method line() and many other matplotlib functions which customize the plot's appearance.
FitDataset1DPlotter(fit, mat_plot_1d, ...)	Plots the attributes of FitDataset1D objects using the matplotlib method line() and many other matplotlib functions which customize the plot's appearance.
ImagingCIPlotter(dataset, mat_plot_2d, ...)	Plots the attributes of Imaging objects using the matplotlib method imshow() and many other matplotlib functions which customize the plot's appearance.
FitImagingCIPlotter(fit, mat_plot_2d, ...)	Plots the attributes of FitImagingCI objects using the matplotlib methods imshow(), plot() and many other matplotlib functions which customize the plot's appearance.
MultiFigurePlotter(plotter_list[, ...])
MultiYX1DPlotter(plotter_list[, color_list, ...])

Non-linear Search Plotters [aplt]

Create figures and subplots of non-linear search specific visualization of every search algorithm supported by PyAutoCTI.

DynestyPlotter(samples, output)
UltraNestPlotter(samples, output)
EmceePlotter(samples, output)
ZeusPlotter(samples, output)
PySwarmsPlotter(samples, output)

Plot Customization [aplt]

Customize figures created via Plotter objects, including changing matplotlib settings and adding visuals to figures.

MatPlot1D([units, figure, axis, cmap, ...])	Visualizes 1D data structures (e.g a Line, etc.) using Matplotlib.
MatPlot2D([units, figure, axis, cmap, ...])	Visualizes 2D data structures (e.g an Array2D, Grid2D, VectorField, etc.) using Matplotlib.
Include1D([origin, mask])	Sets which Visuals1D are included on a figure plotting 1D data that is plotted using a Plotter1D.
Include2D([origin, mask, border, grid, ...])	Sets which Visuals2D are included on a figure plotting 2D data that is plotted using a Plotter.
Visuals1D([origin, mask, points, ...])
Visuals2D([origin, mask, border, lines, ...])

Matplot Lib Wrappers [aplt]

Wrappers for every matplotlib function used by a Plotter, allowing for detailed customizaiton of every figure and subplot.

Matplotlib Wrapper Base Objects:

Units([use_scaled, use_raw, ...])	This object controls the units of a plotted figure, and performs multiple tasks when making the plot:
Figure(**kwargs)	Sets up the Matplotlib figure before plotting (this is used when plotting individual figures and subplots).
Axis([symmetric_source_centre])	Customizes the axis of the plotted figure.
Cmap([symmetric])	Customizes the Matplotlib colormap and its normalization.
Colorbar([manual_tick_labels, ...])	Customizes the colorbar of the plotted figure.
ColorbarTickParams(**kwargs)	Customizes the ticks of the colorbar of the plotted figure.
TickParams(**kwargs)	The settings used to customize a figure's y and x ticks parameters.
YTicks([manual_factor, manual_values, ...])	The settings used to customize a figure's y and x ticks using the YTicks and XTicks objects.
XTicks([manual_factor, manual_values, ...])	The settings used to customize a figure's y and x ticks using the YTicks and XTicks objects.
Title(**kwargs)	The settings used to customize the figure's title.
YLabel(**kwargs)	The settings used to customize the figure's title and y and x labels.
XLabel(**kwargs)	The settings used to customize the figure's title and y and x labels.
Legend([label, include])	The settings used to include and customize a legend on a figure.
Output([path, filename, prefix, suffix, ...])	Sets how the figure or subplot is output, either by displaying it on the screen or writing it to hard-disk.

Matplotlib Wrapper 1D Objects:

YXPlot([plot_axis_type, label])

Plots 1D data structures as a y vs x figure.

Matplotlib Wrapper 2D Objects:

ArrayOverlay(**kwargs)	Overlays an Array2D data structure over a figure.
GridScatter(**kwargs)	Scatters an input set of grid points, for example (y,x) coordinates or data structures representing 2D (y,x) coordinates like a Grid2D or Grid2DIrregular.
GridPlot(**kwargs)	Plots Grid2D data structure that are better visualized as solid lines, for example rectangular lines that are plotted over an image and grids of (y,x) coordinates as lines (as opposed to a scatter of points using the GridScatter object).
VectorYXQuiver(**kwargs)	Plots a VectorField data structure.
PatchOverlay(**kwargs)	Adds patches to a plotted figure using matplotlib patches objects.
VoronoiDrawer(**kwargs)	Draws Voronoi pixels from a MapperVoronoiNoInterp object (see inversions.mapper).
OriginScatter(**kwargs)	Plots the (y,x) coordinates of the origin of a data structure (e.g.
MaskScatter(**kwargs)	Plots a mask over an image, using the Mask2d object's (y,x) edge_sub_1 property.
BorderScatter(**kwargs)	Plots a border over an image, using the Mask2d object's (y,x) border_sub_1 property.
PositionsScatter(**kwargs)	Plots the (y,x) coordinates that are input in a plotter via the positions input.
IndexScatter(**kwargs)	Plots specific (y,x) coordinates of a grid (or grids) via their 1d or 2d indexes.
MeshGridScatter(**kwargs)	Plots the grid of a Mesh object (see autoarray.inversion).
ParallelOverscanPlot(**kwargs)	Plots the lines of a parallel overscan Region2D object.
SerialPrescanPlot(**kwargs)	Plots the lines of a serial prescan Region2D object.
SerialOverscanPlot(**kwargs)	Plots the lines of a serial overscan Region2D object.