DatasetModel
- class glotaran.model.dataset_model.DatasetModel[source]
Bases:
object
A DatasetModel 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 descriptor assigns one or more megacomplexes and a scale parameter.
Methods Summary
Ensure that unique megacomplexes Are only used once per dataset.
Gets the dataset model's coordinates.
Gets the dataset model's data.
Gets the dataset model's global axis.
Returns the dataset model's global dimension.
Gets the dataset model's model axis.
Returns the dataset model's model dimension.
Gets the dataset model's weight.
Indicates if the dataset model can model the global dimension.
Indicates if the dataset model is index dependent.
Iterates of der dataset model's global megacomplexes.
Iterates of der dataset model's megacomplexes.
Overwrites the dataset model's global dimension.
Overrides the index dependency of the dataset
Overwrites the dataset model's model dimension.
Sets the dataset model's coordinates.
Sets the dataset model's data.
Swaps the dataset model's global and model dimension.
Methods Documentation
- ensure_unique_megacomplexes(model: Model) list[str] [source]
Ensure that unique megacomplexes Are only used once per dataset.
- get_data() numpy.ndarray [source]
Gets the dataset model’s data.
- get_global_axis() numpy.ndarray [source]
Gets the dataset model’s global axis.
- get_model_axis() numpy.ndarray [source]
Gets the dataset model’s model axis.
- iterate_global_megacomplexes() Generator[tuple[Parameter | int | None, Megacomplex | str], None, None] [source]
Iterates of der dataset model’s global megacomplexes.
- iterate_megacomplexes() Generator[tuple[Parameter | int | None, Megacomplex | str], None, None] [source]
Iterates of der dataset model’s megacomplexes.
- overwrite_global_dimension(global_dimension: str) None [source]
Overwrites the dataset model’s global dimension.
- overwrite_index_dependent(index_dependent: bool)[source]
Overrides the index dependency of the dataset
- overwrite_model_dimension(model_dimension: str) None [source]
Overwrites the dataset model’s model dimension.
- set_data(dataset: xarray.core.dataset.Dataset) glotaran.model.dataset_model.DatasetModel [source]
Sets the dataset model’s data.