hyperfine.LevelF

hyperfine.LevelF(I, J, F, energy=0.0, mF_energies=None)

Represents an F hyperfine structure level and holds its magnetic sublevels mF.

Attributes

Name Type Description
F float Total atomic angular momentum number F.
energy float Energy of the level.
mf_levels list, length 2F+1 Energies of 2F+1 hyperfine sublevels.

Notes

  • The magnitude of F can take values in the range |J - I| <= F <= J + I. A ValueError is raised if this is not satisfied.
  • The mF_energies are set relative to the F level energy.

Methods

Name Description
build_mF_levels Builds the mF sublevels of the F level.
get_mF_range Returns a range representing the m_F angular momentum sublevels

build_mF_levels

hyperfine.LevelF.build_mF_levels(mF_energies=None)

Builds the mF sublevels of the F level.

Parameters

Name Type Description Default
mF_energies list, length 2F+1 Energies of the 2F+1 hyperfine sublevels. None

Returns: self.mF_levels

get_mF_range

hyperfine.LevelF.get_mF_range()

Returns a range representing the m_F angular momentum sublevels [-F, -F+1, …, F-1, F].