SpectralShapeGaussian
- class glotaran.builtin.megacomplexes.spectral.shape.SpectralShapeGaussian[source]
Bases:
object
A Gaussian spectral shape
Attributes Summary
Methods Summary
Calculate a normal Gaussian shape for a given
axis
.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.
Returns all parameter full labels of the item.
Methods Documentation
- property amplitude: prop_type
- calculate(axis: numpy.ndarray) numpy.ndarray [source]
Calculate a normal Gaussian shape for a given
axis
.The following equation is used for the calculation:
The parameters of the equation represent the following attributes of the shape:
:
axis
:
amplitude
:
location
:
width
In this formalism, represents the full width at half maximum (FWHM). Compared to the more common definition we have
- Parameters
axis (np.ndarray) – The axis to calculate the shape for.
- Returns
An array representing a Gaussian shape.
- Return type
np.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.
- property label: prop_type
- property location: prop_type
- property type: prop_type
- property width: prop_type