autolens.plot.Output#

class autolens.plot.Output(path: Optional[str] = None, filename: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, format: Optional[Union[str, List[str]]] = None, format_folder: bool = False, bypass: bool = False)[source]#
__init__(path: Optional[str] = None, filename: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, format: Optional[Union[str, List[str]]] = None, format_folder: bool = False, bypass: bool = False)[source]#

Sets how the figure or subplot is output, either by displaying it on the screen or writing it to hard-disk.

This object wraps the following Matplotlib methods:

The default behaviour is the display the figure on the computer screen, as opposed to outputting to hard-disk as a file.

Parameters
  • path – If the figure is output to hard-disk the path of the folder it is saved to.

  • filename – If the figure is output to hard-disk the filename used to save it.

  • prefix – A prefix appended before the file name, e.g. (“prefix_filename”).

  • prefix – A prefix appended after the file name, e.g. (“filenam_suffix”).

  • format – The format of the output, ‘show’ displays on the computer screen, ‘png’ outputs to .png, ‘fits’ outputs to .fits format.

  • format_folder – If True, all images are output in a folder giving the format name, for example path/to/output/png/filename.png. This can make managing large image catalogues easier.

  • bypass – Whether to bypass the plt.show or plt.savefig methods, used when plotting a subplot.

Methods

__init__([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.

filename_from(auto_filename)

output_path_from(format)

subplot_to_figure([auto_filename])

Output a subplot figure, either as an image on the screen or to the hard-disk as a png or fits file.

to_figure(structure[, auto_filename])

Output the figure, by either displaying it on the user’s screen or to the hard-disk as a .png or .fits file.

Attributes

format

format_list