DatasetDescriptor

class glotaran.model.dataset_descriptor.DatasetDescriptor[source]

Bases: object

A DatasetDescriptor describes a dataset in terms of a glotaran model. It contains references to model items which describe the physical model for a given dataset.

A general dataset describtor assigns one or more megacomplexes and a scale parameter.

Attributes Summary

`label`
`megacomplex`
`megacomplex_scale`
`scale`

Methods Summary

`fill`	Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.
`from_dict`
`from_list`
`iterate_megacomplexes`
`mprint`
`validate`

Methods Documentation

fill(model: Model, parameters: ParameterGroup) → cls

Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.

Parameters

model – A glotaran model.
parameter (ParameterGroup) – The parameter group to fill from.

classmethod from_dict(values: dict) → cls

classmethod from_list(values: list) → cls

iterate_megacomplexes() → Generator[tuple[Parameter | int, Megacomplex | str]][source]

property label: str

property megacomplex: List[str]

property megacomplex_scale: List[glotaran.parameter.parameter.Parameter]

mprint(parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) → str

property scale: glotaran.parameter.parameter.Parameter

validate(model: Model, parameters=None) → list[str]