Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version


frequency_offset(frequency, *channels, compensate_phase=False)

GitHub(opens in a new tab)

Shift the frequency of inputs channels on entry into context and undo on exit.


from qiskit import pulse
d0 = pulse.DriveChannel(0)
with as pulse_prog:
    # shift frequency by 1GHz
    with pulse.frequency_offset(1e9, d0):, 1.0), d0)
assert len(pulse_prog.instructions) == 3
with as pulse_prog:
    # Shift frequency by 1GHz.
    # Undo accumulated phase in the shifted frequency frame
    # when exiting the context.
    with pulse.frequency_offset(1e9, d0, compensate_phase=True):, 1.0), d0)
assert len(pulse_prog.instructions) == 4


  • frequency (float) – Amount of frequency offset in Hz.
  • channels (PulseChannel) – Channels to offset frequency of.
  • compensate_phase (bool) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency.



Return type


Was this page helpful?
Report a bug or request content on GitHub.