autolens.plot.plot_array#

plot_array(array, title='', output_path=None, output_filename='array', output_format=None, colormap='default', use_log10=False, vmin=None, vmax=None, symmetric=False, positions=None, lines=None, line_colors=None, grid=None, cb_unit=None, ax=None)[source]#

Plot an autoarray Array2D to file or onto an existing Axes.

All array preprocessing (zoom, mask-edge extraction, native/extent unpacking) is handled internally so callers never need to duplicate it. The actual rendering is delegated to autoarray.plot.plot_array.

Parameters:

  • array – The Array2D (or array-like) to plot.

  • title (str) – Title displayed above the panel.

  • output_path (str or None) – Directory in which to save the figure. None → call plt.show() instead.

  • output_filename (str) – Stem of the output file name (extension is added from output_format).

  • output_format (str) – File format, e.g. "png" or "pdf".

  • colormap (str) – Matplotlib colormap name, or "default" to use the autoarray default ("jet").

  • use_log10 (bool) – If True apply a log₁₀ stretch to the array values.

  • vmin (float or None) – Explicit colour-bar limits. Ignored when symmetric is True.

  • vmax (float or None) – Explicit colour-bar limits. Ignored when symmetric is True.

  • symmetric (bool) – If True set vmin = -vmax so that zero maps to the middle of the colormap.

  • positions (list or array-like or None) – Point positions to scatter-plot over the image.

  • lines (list or array-like or None) – Line coordinates to overlay on the image.

  • line_colors (list or None) – Colours for each entry in lines.

  • grid (array-like or None) – An additional grid of points to overlay.

  • ax (matplotlib.axes.Axes or None) – Existing Axes to draw into. When provided the figure is not saved — the caller is responsible for saving.