IrfMultiGaussian

class glotaran.builtin.megacomplexes.decay.irf.IrfMultiGaussian(*, label: str, type: str = 'multi-gaussian', center: list[Parameter | str], width: list[Parameter | str], scale: list[Parameter | str] | None = None, shift: list[Parameter | str] | None = None, normalize: bool = True, backsweep: bool = False, backsweep_period: Parameter | str | None = None)

Bases: Irf

Represents a gaussian IRF.

One width and one center is a single gauss.

One center and multiple widths is a multiple gaussian.

Multiple center and multiple widths is Double-, Triple- , etc. Gaussian.

Parameters:

• label – label of the irf

• center (list[glotaran.parameter.parameter.Parameter | str]) – one or more center of the irf as parameter indices

• width (list[glotaran.parameter.parameter.Parameter | str]) – one or more widths of the gaussian as parameter index

• center_dispersion_coefficients – polynomial coefficients for the dispersion of the center as list of parameter indices. None for no dispersion.

• width_dispersion_coefficients – polynomial coefficients for the dispersion of the width as parameter indices. None for no dispersion.

Method generated by attrs for class IrfMultiGaussian.

Attributes Summary

type
center
width
scale
shift
normalize
backsweep
backsweep_period
label

Methods Summary

calculate
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.
is_index_dependent
parameter	Returns the properties of the irf with shift applied.

Methods Documentation

backsweep: bool

backsweep_period: Parameter | str | None

calculate(index: int, global_axis: ndarray, model_axis: ndarray) → ndarray

center: list[Parameter | str]

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]

is_index_dependent()

label: str

normalize: bool

parameter(global_index: int, global_axis: ndarray) → tuple[ndarray, ndarray, ndarray, float, bool, float]

Returns the properties of the irf with shift applied.

scale: list[Parameter | str] | None

shift: list[Parameter | str] | None

type: str

width: list[Parameter | str]