Logo

A physics toolbox for laser spectroscopy.

Static Badge Static Badge Static Badge

Static Badge Static Badge

© 2025 Patrick Müller. All rights reserved.

qspec.models.gen_model  (  ijj shape = None qi = False hf_mixing = False hf_config = None n_peaks = None offsets = None x_cuts = None convolve = None  )[source]

Create a lineshape model to fit arbitrary atomic fluorescence spectra.

Parameters:
ijjNone

The three or an Iterable of three quantum numbers $I$, $J_l$ and $J_u$. Must be a list with the format [I, J_l, J_u] or [[I0, J0_l, J0_u], [I1, J1_l, J1_u], ...].

shapestr | type | qspec.models._spectrum.Spectrum

A str representation of or a Spectrum type.

qibool

Whether to use a quantum interference model.

hf_mixingbool

Whether to use a hyperfine-induced mixing model. Not implemented for qi=True.

hf_configdict

A dict containing the configuration for the hf mixing. Only used if hf_mixing=True.

n_peaksint

The number of "peaks per resonance" or "lineshape duplicates".

offsetsint | list

The orders of the offset polynomials of the separate x-axis intervals. Must be a list or a single value. In the former case len(offsets) == len(x_cuts) + 1 must hold. If offsets is None, a single constant offset is assumed.

x_cutsint | float | list

The x values where to cut the x-axis. Must be a list or a single value. In the former case len(offsets) == len(x_cuts) + 1 must hold. If x_cuts is None, the x-axis will not be cut.

convolvestr | type | qspec.models._spectrum.Spectrum

A str representation of or a Convolved type.

Returns:
outqspec.models._base.Model

The constructed lineshape model.

API navigation