satlas.profiles.Crystalball¶
-
class
satlas.profiles.
Crystalball
(fwhm=None, mu=None, amp=None, alpha=None, n=None, ampIsArea=False)[source]¶ A callable Crystalball profile.
-
__init__
(fwhm=None, mu=None, amp=None, alpha=None, n=None, ampIsArea=False)[source]¶ Creates a callable object storing the fwhm, amplitude and location of a Crystalball lineshape. For more information, see [Gai82] and [Skw86]
Parameters: - fwhm (float) – Full Width At Half Maximum, defaults to 1.
- mu (float) – Location of the center, defaults to 0.
- amp (float) – Amplitude of the profile, defaults to 1.
- alpha (float) – Location of the tail.
- n (float) – Relative amplitude of the tail.
- ampIsArea (boolean) – Sets if the amplitude is the integral or the peakheight. Defaults to False.
Returns: Callable instance, evaluates the Crystalball profile in the arguments supplied.
Return type:
-
__call__
(x)[source]¶ Evaluates the lineshape in the given values.
Parameters: vals (array_like) – Array of values to evaluate the lineshape in. Returns: Array of seperate response values of the lineshape. Return type: array_like
Methods
__init__
([fwhm, mu, amp, alpha, n, ampIsArea])Creates a callable object storing the fwhm, amplitude and location of a Crystalball lineshape. Attributes
alpha
amp
Peak amplitude. ampIsArea
Boolean controlling the behaviour of amp. fwhm
FWHM of the peak. mu
n
-