ShiftPhase
class ShiftPhase(phase, channel=None, name=None)
The shift phase instruction updates the modulation phase of proceeding pulses played on the same Channel. It is a relative increase in phase determined by the phase operand.
In particular, a PulseChannel creates pulses of the form
The ShiftPhase instruction causes to be increased by the instruction’s phase operand. This will affect all pulses following on the same channel.
The qubit phase is tracked in software, enabling instantaneous, nearly error-free Z-rotations by using a ShiftPhase to update the frame tracking the qubit state.
Instantiate a shift phase instruction, increasing the output signal phase on channel by phase [radians].
Parameters
- phase (
complex) – The rotation angle in radians. - channel (
Optional[PulseChannel]) – The channel this instruction operates on. - name (
Optional[str]) – Display name for this instruction.
Attributes
channel
Type: qiskit.pulse.channels.PulseChannel
Return the Channel that this instruction is scheduled on.
Return type
channels
Type: Tuple[qiskit.pulse.channels.Channel]
Returns channels that this schedule uses.
Return type
Tuple[Channel]
command
Type: qiskit.pulse.commands.command.Command
The associated command. Commands are deprecated, so this method will be deprecated shortly.
Return type
Command
duration
Type: int
Duration of this instruction.
Return type
int
id
Type: int
Unique identifier for this instruction.
Return type
int
instructions
Type: Tuple[Tuple[int, qiskit.pulse.instructions.instruction.Instruction]]
Iterable for getting instructions from Schedule tree.
Return type
Tuple[Tuple[int, Instruction]]
name
Type: str
Name of this instruction.
Return type
str
operands
Type: Tuple
Return instruction operands.
Return type
Tuple
phase
Type: float
Return the rotation angle enacted by this instruction in radians.
Return type
float
start_time
Type: int
Relative begin time of this instruction.
Return type
int
stop_time
Type: int
Relative end time of this instruction.
Return type
int
timeslots
Type: Dict[qiskit.pulse.channels.Channel, List[Tuple[int, int]]]
Occupied time slots by this instruction.
Return type
Dict[Channel, List[Tuple[int, int]]]
Methods
__call__
ShiftPhase.__call__(channel)
Return a new ShiftPhase instruction supporting the deprecated syntax of FrameChange.
Parameters
channel (PulseChannel) – The channel this instruction operates on.
Raises
PulseError – If channel was already added.
Return type
Returns
New ShiftPhase with both phase (from self`) and the ``channel provided.
append
ShiftPhase.append(schedule, name=None)
Return a new Schedule with schedule inserted at the maximum time over all channels shared between self and schedule.
Parameters
- schedule (
ScheduleComponent) – schedule to be appended - name (
Optional[str]) – Name of the new schedule. Defaults to name of self
Return type
ch_duration
ShiftPhase.ch_duration(*channels)
Return duration of the supplied channels in this Instruction.
Parameters
*channels – Supplied channels
Return type
int
ch_start_time
ShiftPhase.ch_start_time(*channels)
Return minimum start time for supplied channels.
Parameters
*channels – Supplied channels
Return type
int
ch_stop_time
ShiftPhase.ch_stop_time(*channels)
Return maximum start time for supplied channels.
Parameters
*channels – Supplied channels
Return type
int
draw
ShiftPhase.draw(dt=1, style=None, filename=None, interp_method=None, scale=1, channels_to_plot=None, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, scaling=None, channels=None)
Plot the instruction.
Parameters
- dt (
float) – Time interval of samples - style (Optional[SchedStyle]) – A style sheet to configure plot appearance
- filename (
Optional[str]) – Name required to save pulse image - interp_method (
Optional[Callable]) – A function for interpolation - scale (
float) – Relative visual scaling of waveform amplitudes - channels_to_plot (
Optional[List[Channel]]) – Deprecated, see channels - plot_all (
bool) – Plot empty channels - plot_range (
Optional[Tuple[float]]) – A tuple of time range to plot - interactive (
bool) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) - table (
bool) – Draw event table for supported instructions - label (
bool) – Label individual instructions - framechange (
bool) – Add framechange indicators - scaling (
Optional[float]) – Deprecated, see scale - channels (
Optional[List[Channel]]) – A list of channel names to plot
Returns
A matplotlib figure object of the pulse schedule
Return type
matplotlib.figure
flatten
insert
ShiftPhase.insert(start_time, schedule, name=None)
Return a new Schedule with schedule inserted within self at start_time.
Parameters
- start_time (
int) – Time to insert the schedule schedule - schedule (
ScheduleComponent) – Schedule to insert - name (
Optional[str]) – Name of the new schedule. Defaults to name of self
Return type
shift
ShiftPhase.shift(time, name=None)
Return a new schedule shifted forward by time.
Parameters
- time (
int) – Time to shift by - name (
Optional[str]) – Name of the new schedule. Defaults to name of self
Return type
union
ShiftPhase.union(*schedules, name=None)
Return a new schedule which is the union of self and schedule.
Parameters
- *schedules – Schedules to be take the union with this Instruction.
- name (
Optional[str]) – Name of the new schedule. Defaults to name of self
Return type