CoherentArtifactMegacomplex

class glotaran.builtin.megacomplexes.coherent_artifact.coherent_artifact_megacomplex.CoherentArtifactMegacomplex(*, label: str, dimension: str = 'time', type: str = 'coherent-artifact', order: int, width: Parameter | str | None = None)[source]

Bases: Megacomplex

Method generated by attrs for class CoherentArtifactMegacomplex.

Attributes Summary

dimension

type

order

width

label

Methods Summary

calculate_matrix

Calculate the megacomplex matrix.

compartments

finalize_data

Finalize a dataset.

get_dataset_model_type

Get the dataset model type.

get_irf_parameter

get_item_type

Get the type string.

get_item_type_class

Get the type for a type string.

get_item_types

Get all type strings.

Methods Documentation

calculate_matrix(dataset_model: DatasetModel, global_axis: ArrayLike, model_axis: ArrayLike, **kwargs)[source]

Calculate the megacomplex matrix.

Parameters:

  • dataset_model (DatasetModel) – The dataset model.

  • global_axis (ArrayLike) – The global axis.

  • model_axis (ArrayLike) – The model axis.

  • **kwargs – Additional arguments.

Returns:

  • tuple[list[str], ArrayLike] – The clp labels and the matrix.

  • .. # noqa (DAR202)

  • .. # noqa (DAR401)

compartments()[source]
dimension: str
finalize_data(dataset_model: DatasetModel, dataset: Dataset, is_full_model: bool = False, as_global: bool = False)[source]

Finalize a dataset.

Parameters:

  • dataset_model (DatasetModel) – The dataset model.

  • dataset (xr.Dataset) – The dataset.

  • is_full_model (bool) – Whether the model is a full model.

  • as_global (bool) – Whether megacomplex is calculated as global megacomplex.

classmethod get_dataset_model_type() → type | None

Get the dataset model type.

Return type:

type | None

get_irf_parameter(irf: IrfMultiGaussian, global_index: int | None, global_axis: ArrayLike) → tuple[float, float][source]
classmethod get_item_type() → str

Get the type string.

Return type:

str

classmethod get_item_type_class(item_type: str) → Type

Get the type for a type string.

Parameters:

item_type (str) – The type string.

Return type:

Type

classmethod get_item_types() → list[str]

Get all type strings.

Return type:

list[str]

label: str
order: int
type: str
width: ParameterType | None