extract_dataset_scale

extract_dataset_scale(res: Dataset, divide_by_scale: bool = True) float[source]

Extract ‘dataset_scale’ attribute from optimization result dataset.

Parameters:
  • res (xr.Dataset) – Result dataset from a pyglotaran optimization.

  • divide_by_scale (bool) – Whether or not to divide the data by the dataset scale used for optimization. Defaults to True.

Returns:

Dataset scale extracted from res falls back to 1 if not present.

Return type:

float