KetPair

Class Methods

__init__()	Creating a KetPair object directly is not possible.
get_energy([unit])	Get the energy of the ket in the given unit.
get_label([fmt, max_kets])	Label representing the ket pair.

Class Attributes and Properties

f	The total momentum quantum number f (int or half-int).
m	The magnetic quantum number m (int or half-int).
parity	The parity of the ket.
state_atoms	Return the state atoms of the ket pair.

class KetPair

Ket for a pair state of two atoms.

For pair systems, we choose KetPair object as the product states of the single-atom eigenstates. Thus, the Ket pair objects depend on the system and the applied fields. Therefore for different pair systems the KetPair objects are not necessarily orthogonal anymore.

Currently one cannot create a KetPair object directly, but they are used in the background when creating a pairinteraction.BasisPair object.

__init__()

Creating a KetPair object directly is not possible.

Return type:

None

get_label(fmt='raw', *, max_kets=3)

Label representing the ket pair.

Parameters:

• fmt (Literal['raw', 'ket', 'bra', 'detailed']) – The format of the label, i.e. whether to return the raw label, or the label in ket or bra notation.

• max_kets (int) – Maximum number of single atom kets to include in the label for each StateAtom.

Return type:

str

Returns:

A string representation of the ket pair.

property state_atoms: tuple[StateAtom, StateAtom]

Return the state atoms of the ket pair.

property f: float

The total momentum quantum number f (int or half-int).

get_energy(unit=None)

Get the energy of the ket in the given unit.

Parameters:

unit (str | None) – The unit to which to convert the energy to. Default None will return a pint.Quantity.

Return type:

Union[float, PlainQuantity[float]]

Returns:

The energy as float if a unit was given, otherwise a pint.Quantity.

property m: float

The magnetic quantum number m (int or half-int).

property parity: Literal['even', 'odd', 'unknown']

The parity of the ket.