DatasetGroup

class glotaran.model.dataset_group.DatasetGroup(residual_function: Literal['variable_projection', 'non_negative_least_squares'], link_clp: bool | None, model: Model, parameters: Parameters | None = None, dataset_models: dict[str, DatasetModel] = _Nothing.NOTHING)[source]

Bases: object

A dataset group for optimization.

Method generated by attrs for class DatasetGroup.

Attributes Summary

residual_function

The residual function to use.

link_clp

Whether to link the clp parameter.

model

parameters

dataset_models

Methods Summary

is_linkable

Check if the group is linkable.

set_parameters

Set the group parameters.

Methods Documentation

dataset_models: dict[str, DatasetModel]
is_linkable(parameters: Parameters, data: Mapping[str, xr.Dataset]) → bool[source]

Check if the group is linkable.

Parameters:

  • parameters (Parameters) – A parameter set parameters.

  • data (Mapping[str, xr.Dataset]) – A the data to link.

Return type:

bool

Whether to link the clp parameter.

model: Model
parameters: Parameters | None
residual_function: Literal['variable_projection', 'non_negative_least_squares']

The residual function to use.

set_parameters(parameters: Parameters)[source]

Set the group parameters.

Parameters:

parameters (Parameters) – The parameters.