ospgrid.utils.save_figs_to_file#

save_figs_to_file(filename, transparent=False, figs=None, bbox=False, pad=20, std_names=True)[source]#

Saves passed figs, or all open figs to PDF

Parameters

  • filename (string) – The file to which the results are saved.

  • transparent (bool, optional) – Whether or not the plots should be transparent. The default is False.

  • figs (List[matplotlib.pyplot.Figure], optional) – A list of figure objects to save. Defaults to all open figures.

  • bbox (bool, optional) – Whether or not to crop the figure to a bounding box of its contents. Only applies to image files, e.g., png, jpg, etc (not PDF)

  • pad (int, optional) – If applying the bbox cropping to an image, a padding to apply to the contents. Defaults to 20 px.

  • std_names (bool, optional) – If there are 5 figures open, and this is true, then meaningful strings (e.g. “_bmd”) are added to the figure name in the order in which they are created in the function grid.Grid.plot_results().