eigenenergy

Model.eigenenergy(quantum_nums)

Return the eigenenergy of a labeled eigenstate.

The eigenstate is the one that has the largest overlap with the local-\(S_z\) product-basis state described by quantum_nums.

Parameters:

quantum_nums (str | Dict[str, float] | Tuple[float, ...]) –

Quantum numbers. It can be specified by three different ways:

  • By a dict whose keys correspond to the spin names and values correspond to the quantum numbers.

  • By a tuple containing the quantum numbers in the same order as indicated by the spin_names.

  • By a bitstring such as "010", interpreted in the spin_names order using each spin’s qubit_subspace.

Return type:

float

Returns:

eigenenergy (frequency in \(\text{MHz}\))