save_image

cosipy.postprocessing.field_plots.plot_cosipy_fields.save_image(figure, timestamp, name='', suffix='', img_format='png')[source]

Automatically generates file name, and saves image to disk.

Parameters:
  • figure (Figure) – Figure object that is saved to disk.

  • timestamp (str) – Date or datetime index of target data.

  • name (str) – Name of variable. Default empty string.

  • suffix (str) – Additional string appended to file name e.g. the type of plot. Default empty string.

  • img_format – Output image format. Default “png”.