SpectralShapeSkewedGaussian
- class glotaran.builtin.megacomplexes.spectral.shape.SpectralShapeSkewedGaussian[source]
Bases:
glotaran.builtin.megacomplexes.spectral.shape.SpectralShapeGaussian
A skewed Gaussian spectral shape
Attributes Summary
ModelProperty is an extension of the property decorator.
ModelProperty is an extension of the property decorator.
ModelProperty is an extension of the property decorator.
ModelProperty is an extension of the property decorator.
ModelProperty is an extension of the property decorator.
ModelProperty is an extension of the property decorator.
Methods Summary
Calculate the skewed Gaussian shape for
axis
.Methods Documentation
- property amplitude: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.
- calculate(axis: numpy.ndarray) numpy.ndarray [source]
Calculate the skewed Gaussian shape for
axis
.The following equation is used for the calculation:
With:
The parameters of the equation represent the following attributes of the shape:
:
axis
:
amplitude
:
location
:
width
:
skewness
Where represents the full width at half maximum (FWHM), see
calculate_gaussian()
.Note that in the limit of skewness parameter equal to zero simplifies to a normal gaussian (since ), see the definition in
SpectralShapeGaussian.calculate()
.- Parameters
axis (np.ndarray) – The axis to calculate the shape for.
- Returns
An array representing a skewed Gaussian shape.
- Return type
np.ndarray
- fill(model: Model, parameters: ParameterGroup) cls
- property label: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.
- property location: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.
- markdown(all_parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) MarkdownStr
- property skewness: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.
- property type: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.
- property width: model_property.glotaran_property_type
ModelProperty is an extension of the property decorator.
It adds convenience functions for meta programming model items.