simuran.plot.figure module

Holds a custom figure class.

class simuran.plot.figure.SimuranFigure(figure=None, filename=None, done=False, **kwargs)

Bases: object

A custom figure class that holds a figure and filename.

It also has helper methods, and support for saving only when ready.

figure

The underlying figure object.

Type:matplotlib.figure.Figure

filename

The filename that the figure will be saved to.

Type:str

kwargs

Extra keyword arguments used for saving.

Type:dict

done

Whether this figure is ready to save or not.

Type:bool

closed

Whether the underlying mpl figure has been closed.

Type:bool

close()

Close the underlying figure if not closed.

isdone()

Return if this figure is ready for saving.

output_filenames

Get the filenames that will be saved to.

save(filename=None, **kwargs)

Alias for savefig.

savefig(filename=None, **kwargs)

Call simuran.plot.base_plot.save_simuran_plot to save this figure.

The underlying figure object is saved to filename, and any kwargs are passed to simuran.plot.base_plot.save_simuran_plot

Parameters:

• filename (str, optional) – Overrides self.filename if passed.
• kwargs (keyword arguments) – simuran.plot.base_plot.save_simuran_plot for support kwargs

Returns:

Return type:

None

update_kwargs(**kwargs)

Update self.kwargs.