lib.samples.plotting.ParameterPlotStyle

class lib.samples.plotting.ParameterPlotStyle(style=None, **kwargs)

Bases: cosmopipe.lib.plotting.BasePlotStyle

Base plotting class for parameter values.

Methods

copy	Return shallow copy of self.
deepcopy
from_state	Instantiate and initalize class with state dictionary.
get	Return value if not None, else attribute name if not None, else default.
get_color	Return color corresponding to label label.
get_default_truths	Return default truth / reference values for parameters.
get_list	Same as get(), but ensuring returned value is a list.
get_parameters	Return parameters.
is_mpi_broadcast
is_mpi_gathered
is_mpi_root
is_mpi_scattered
load	Load class in numpy binary format from disk.
load_auto	If different formats are possible, this method should between them based on file name extension.
log_critical
log_debug
log_error
log_info
log_warning
save	Save class to disk.
save_auto	If different formats are possible, this method should between them based on file name extension.
savefig	Save figure to filename.
update	Update attibutes with those in kwargs.

Attributes

logger
mpiattrs	MPI attributes
mpicomm
mpiroot
mpistate

copy()

Return shallow copy of self.

classmethod from_state(state, mpiroot=0, mpicomm=None)

Instantiate and initalize class with state dictionary.

get(name, value=None, default=None)

Return value if not None, else attribute name if not None, else default.

Parameters

• name (string) – Attribute name. If None, defaults to default.

• value (object, default=None) – Value. If None, returns attribute name.

• default (object, default=None) – Default value.

get_color(label, labels=None)

Return color corresponding to label label. If colors is a list, return color at index of label in list of labels labels.

get_default_truths(parameters, truths=None)

Return default truth / reference values for parameters.

Parameters

• parameters (Parameter, tuple, list, ParameterCollection) – Parameters to return truth values for.

• truths (list, default=None) – List of truth values. If None, return truths if exists, else set all truths to None. If 'value', return list of Parameter.value.

Returns

truths – Return single value if parameters is a single parameter.

Return type

float, list

get_list(name, value=None, default=None)

Same as get(), but ensuring returned value is a list. Default length (see make_list()) is taken as default length.

static get_parameters(parameters, chains=None)

Return parameters.

Parameters

• parameters (tuple, list, ParameterCollection) – List of parameter (names). If parameter name, get the xorresponding parameter in the first element in chains that contains this parameter.

• chains (list) – List of classes with parameters attribute.

Returns

toret – Return single parameter if parameters is a single parameter (name).

Return type

Parameter, ParameterCollection

classmethod load(filename, mpiroot=0, mpicomm=None)

Load class in numpy binary format from disk. If the loaded state contains __class__ and that exists in cls._registry, return instance of cls._registry[__class__] (instead of cls).

load_auto(*args, **kwargs)

If different formats are possible, this method should between them based on file name extension.

property mpiattrs

MPI attributes

save(filename)

Save class to disk.

save_auto(*args, **kwargs)

If different formats are possible, this method should between them based on file name extension.

savefig(filename, fig=None)

Save figure to filename.

Parameters

• filename (string) – Path where to save figure.

• fig (matplotlib.figure.Figure, default=None) – Figure to save. Defaults to current figure.

update(**kwargs)

Update attibutes with those in kwargs.