model_spectral_line#
- iris.sg.background.model_spectral_line(velocity, amplitude, shift, width, kappa)[source]#
A simple model of a spectral line profile.
This function uses a kappa distribution,
\[y(v) = A \left( 1 + \frac{(v - v_0)^2}{\kappa \sigma^2} \right)^{-\kappa - 1},\]to model the spectral line profile, where \(A\) is the amplitude, \(v\) is the velocity, \(v_0\) is the shift, \(\sigma\) is the width, and \(\kappa\) is a parameter which controls the thickness of the tails.
- Parameters:
velocity (AbstractScalar) – The test points at which to evaluate the model background.
amplitude (AbstractScalar) – The height of the spectral line.
shift (AbstractScalar) – The center of the spectral line.
width (AbstractScalar) – The width of the spectral line.
kappa (AbstractScalar) – The fatness of the tails of the spectral line.
- Return type: