SpectralShapeGaussian¶

class glotaran.builtin.models.kinetic_spectrum.spectral_shape.SpectralShapeGaussian[source]¶

Bases: object

A gaussian spectral shape

Attributes Summary

`amplitude`
`label`
`location`
`type`
`width`

Methods Summary

`calculate`	calculate calculates the shape.
`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`
`validate`

Methods Documentation

property amplitude¶

calculate(axis: numpy.ndarray) → numpy.ndarray [source]¶

calculate calculates the shape.

Parameters: axis (np.ndarray) – The axies to calculate the shape on.
Returns: shape
Return type: numpy.ndarray

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¶

property location¶

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

property type¶

validate(model: Model, parameters=None) → list[str]¶

property width¶