EstimationProviderUnlinked
- class glotaran.optimization.estimation_provider.EstimationProviderUnlinked(dataset_group: DatasetGroup, data_provider: DataProvider, matrix_provider: MatrixProviderUnlinked)[source]
Bases:
EstimationProvider
A class to provide estimation for optimization of an unlinked dataset group.
Initialize an estimation provider for an unlinked dataset group.
- Parameters:
dataset_group (DatasetGroup) – The dataset group.
data_provider (DataProvider) – The data provider.
matrix_provider (MatrixProviderUnlinked) – The matrix provider.
Attributes Summary
Get the dataset group.
Methods Summary
Calculate the clp penalty.
Calculate the estimation for a dataset.
Calculate the estimation for a dataset with a full model.
Calculate the clps and the residual for a matrix and data.
Calculate the estimation.
Get the additional penalty.
Get the full penalty.
Get the results of the estimation.
Retrieve clp from reduced clp.
Methods Documentation
- calculate_clp_penalties(clp_labels: list[list[str]], clps: list[ndarray], global_axis: ndarray) list[float]
Calculate the clp penalty.
- calculate_estimation(dataset_model: DatasetModel)[source]
Calculate the estimation for a dataset.
- Parameters:
dataset_model (DatasetModel) – The dataset model.
- calculate_full_model_estimation(dataset_model: DatasetModel)[source]
Calculate the estimation for a dataset with a full model.
- Parameters:
dataset_model (DatasetModel) – The dataset model.
- calculate_residual(matrix: ArrayLike, data: ArrayLike) tuple[ArrayLike, ArrayLike]
Calculate the clps and the residual for a matrix and data.
- Parameters:
matrix (ArrayLike) – The matrix.
data (ArrayLike) – The data.
- Returns:
The estimated clp and residual.
- Return type:
tuple[ArrayLike, ArrayLike]
- get_full_penalty() ArrayLike [source]
Get the full penalty.
- Returns:
The clp penalty.
- Return type:
ArrayLike
- get_result() tuple[dict[str, list[DataArray]], dict[str, list[DataArray]]] [source]
Get the results of the estimation.
- property group: DatasetGroup
Get the dataset group.
- Returns:
The dataset group.
- Return type: