simulate_from_clp

glotaran.simulation.simulation.simulate_from_clp(dataset_model: DatasetModel, global_dimension: str, global_axis: ArrayLike, model_dimension: str, model_axis: ArrayLike, clp: xr.DataArray) → xr.Dataset[source]

Simulate a dataset model from pre-defined conditionally linear parameters.

Parameters:

  • dataset_model (DatasetModel) – The dataset model to simulate.

  • global_dimension (str) – The global dimension of the dataset.

  • global_axis (ArrayLike) – The global axis of the dataset.

  • model_dimension (str) – The model dimension of the dataset.

  • model_axis (ArrayLike) – The model axis of the dataset.

  • clp (xr.DataArray) – A matrix with conditionally linear parameters.

Returns:

The simulated dataset.

Return type:

xr.Dataset

Raises:

ValueError – Raised if the clp are missing the dimension ‘clp_label’.