IrfMultiGaussian

class glotaran.builtin.megacomplexes.decay.irf.IrfMultiGaussian[source]

Bases: object

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 – one or more center of the irf as parameter indices
width – 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.

Attributes Summary

`backsweep`
`backsweep_period`
`center`
`label`
`normalize`
`scale`
`shift`
`type`
`width`

Methods Summary

`as_dict`
`calculate`
`fill`	Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.
`from_dict`
`get_parameters`	Returns all parameter full labels of the item.
`is_index_dependent`
`mprint`
`parameter`	Returns the properties of the irf with shift applied.
`validate`

Methods Documentation

as_dict() → dict

property backsweep: prop_type

property backsweep_period: prop_type

calculate(index: int, global_axis: numpy.ndarray, model_axis: numpy.ndarray) → numpy.ndarray[source]

property center: prop_type

fill(model: Model, parameters: ParameterGroup) → cls

Returns a copy of the {cls._name} instance with all members which are Parameters are replaced by the value of the corresponding parameter in the parameter group.

Parameters

model – A glotaran model.
parameter (ParameterGroup) – The parameter group to fill from.

classmethod from_dict(values: dict) → cls

get_parameters() → list[str]: Returns all parameter full labels of the item.

is_index_dependent()[source]

property label: prop_type

mprint(parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) → str

property normalize: prop_type

parameter(global_index: int, global_axis: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray, float, bool, float][source]: Returns the properties of the irf with shift applied.

property scale: prop_type

property shift: prop_type

property type: prop_type

validate(model: Model, parameters: ParameterGroup | None = None) → list[str]

property width: prop_type