create_clp_guide_dataset

Result.create_clp_guide_dataset(clp_label: str, dataset_name: str) → Dataset[source]

Create dataset for clp guidance.

Parameters:

clp_label (str) – Label of the clp to guide.
dataset_name (str) – Name of dataset to extract the guide from.

Returns:

DataArray containing the clp guide, with clp_label dimension replaced by the model dimensions first value.

Return type:

xr.Dataset

Raises:

ValueError – If dataset_name is not in result.
ValueError – If clp_labels is not in result.

Examples

Extracting the clp guide from an optimization result object.

from glotaran.io import save_dataset

clp_guide = result.create_clp_guide_dataset("species_1", "dataset_1")
save_dataset(clp_guide, "clp_guide__result_dataset_1__species_1.nc")