IrfMultiGaussian

class glotaran.builtin.models.kinetic_image.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 – polynomial coefficients for the dispersion of the center as list of parameter indices. None for no dispersion.

  • width_dispersion – 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

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

from_list

mprint

parameter

validate

Methods Documentation

property backsweep: bool
property backsweep_period: glotaran.parameter.parameter.Parameter
calculate(index: int, global_axis: numpy.ndarray, model_axis: numpy.ndarray) numpy.ndarray[source]
property center: List[glotaran.parameter.parameter.Parameter]
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
classmethod from_list(values: list) cls
property label: str
mprint(parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) str
property normalize: bool
parameter(global_index: int, global_axis: numpy.ndarray) Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray, float, bool, float][source]
property scale: List[glotaran.parameter.parameter.Parameter]
property shift: List[glotaran.parameter.parameter.Parameter]
property type: str
validate(model: Model, parameters=None) list[str]
property width: List[glotaran.parameter.parameter.Parameter]