plotting_kwargs#

class plotting_kwargs(*args, **kwargs)[source]#

Bases: objdict

A class to set and operate on plotting kwargs throughout synthpops.

Parameters:

kwargs (dict) – dictionary of plotting parameters to be used.

Attributes

axis	Dictionary of axis settings.

Methods

initialize()[source]#

Initialize plot settings.

set_font(*args, **font)[source]#

Set font styles.

default_plotting_kwargs()[source]#

Define default plotting kwargs to be used in plotting methods.

set_figure_display_size(*args, **kwargs)[source]#

Update plotting kwargs with new calculated display sizes.

Parameters:

kwargs (sc.objdict) – new values to update with

Returns:

Updated kwargs and recalculating the display sizes.

set_default_pop_pars()[source]#

Check if method has some key pop parameters to call on data. If not, use defaults and warn user of their use and value.

make_title(suffix=None, override=False)[source]#

Create the title for the figure depending on the location information and if there already exists a preset title_prefix.

Parameters:

• suffix (str) – title suffix

• override (bool) – If True, override the title_prefix already stored in self and create a new one.

Returns:

None.

restore_defaults()[source]#

Reset matplotlib defaults.

update_defaults(method_defaults, kwargs)[source]#

Update defaults with method defaults and kwargs.

property axis#

Dictionary of axis settings.