IrfSpectralMultiGaussian

class glotaran.builtin.megacomplexes.decay.irf.IrfSpectralMultiGaussian(*, label: str, 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, type: str = 'spectral-multi-gaussian', dispersion_center: Parameter | str, center_dispersion_coefficients: list[Parameter | str], width_dispersion_coefficients: list[Parameter | str] = _Nothing.NOTHING, model_dispersion_with_wavenumber: bool = False)[source]

Bases: IrfMultiGaussian

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 (list[glotaran.parameter.parameter.Parameter | str]) – list of parameters with polynomial coefficients describing the dispersion of the irf center location. None for no dispersion.

  • width_dispersion_coefficients (list[glotaran.parameter.parameter.Parameter | str]) – list of parameters with polynomial coefficients describing the dispersion of the width of the irf. None for no dispersion.

Method generated by attrs for class IrfSpectralMultiGaussian.

Attributes Summary

type

dispersion_center

center_dispersion_coefficients

width_dispersion_coefficients

model_dispersion_with_wavenumber

center

width

scale

shift

normalize

backsweep

backsweep_period

label

Methods Summary

calculate

calculate_dispersion

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 and dispersion applied.

Methods Documentation

backsweep: bool
backsweep_period: ParameterType | None
calculate(index: int, global_axis: ndarray, model_axis: ndarray) ndarray
calculate_dispersion(axis)[source]
center: list[ParameterType]
center_dispersion_coefficients: list[Parameter | str]
dispersion_center: 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()[source]
label: str
model_dispersion_with_wavenumber: bool
normalize: bool
parameter(global_index: int, global_axis: ndarray)[source]

Returns the properties of the irf with shift and dispersion applied.

scale: list[ParameterType] | None
shift: list[ParameterType] | None
type: str
width: list[ParameterType]
width_dispersion_coefficients: list[Parameter | str]