Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

StarkCoefficients

class StarkCoefficients(pos_coef_o1, pos_coef_o2, pos_coef_o3, neg_coef_o1, neg_coef_o2, neg_coef_o3, offset)[source]

A collection of coefficients characterizing Stark shift.

Create new coefficients object.

Parameters:
  • pos_coef_o1 (float) – The first order shift coefficient on positive amplitude.

  • pos_coef_o2 (float) – The second order shift coefficient on positive amplitude.

  • pos_coef_o3 (float) – The third order shift coefficient on positive amplitude.

  • neg_coef_o1 (float) – The first order shift coefficient on negative amplitude.

  • neg_coef_o2 (float) – The second order shift coefficient on negative amplitude.

  • neg_coef_o3 (float) – The third order shift coefficient on negative amplitude.

  • offset (float) – Offset frequency.

Methods

convert_amp_to_freq(amps)[source]

A helper function to convert Stark amplitude to frequency shift.

Parameters:

amps (ndarray) – Amplitude values to convert into frequency shift.

Returns:

Calculated frequency shift at given Stark amplitude.

Return type:

ndarray

convert_freq_to_amp(freqs)[source]

A helper function to convert Stark frequency to amplitude.

Parameters:

freqs (ndarray) – Target frequency shifts to compute required Stark amplitude.

Returns:

Estimated Stark amplitudes to induce input frequency shifts.

Raises:

ValueError – When amplitude value cannot be solved.

Return type:

ndarray

find_min_max_frequency(min_amp, max_amp)[source]

A helper function to estimate maximum frequency shift within given amplitude budget.

Parameters:
  • min_amp (float) – Minimum Stark amplitude.

  • max_amp (float) – Maximum Stark amplitude.

Returns:

Minimum and maximum frequency shift available within the amplitude range.

Return type:

tuple[float, float]

negative_coeffs()[source]

Negative coefficients.

Return type:

list[float]

positive_coeffs()[source]

Positive coefficients.

Return type:

list[float]