- class qiskit.pulse.instructions.Reference(name, *extra_keys)#
Pulse compiler directive that refers to a subroutine.
If a pulse program uses the same subset of instructions multiple times, then using the
Referenceclass may significantly reduce the memory footprint of the program. This instruction only stores the set of strings to identify the subroutine.
The actual pulse program can be stored in the
ScheduleBlockthat this reference instruction belongs to.
You can later assign schedules with the
ScheduleBlock.assign_references()method. This allows you to build the main program without knowing the actual subroutine, that is supplied at a later time.
Create new reference.
name (str) – Name of subroutine.
extra_keys (str) – Optional. A set of string keys that may be necessary to refer to a particular subroutine. For example, when we use “sx” as a name to refer to the subroutine of an sx pulse, this name might be used among schedules for different qubits. In this example, you may specify “q0” in the extra keys to distinguish the sx schedule for qubit 0 from others. The user can use an arbitrary number of extra string keys to uniquely determine the subroutine.
Returns the channels that this schedule uses.
Duration of this instruction.
Unique identifier for this instruction.
Iterable for getting instructions from Schedule tree.
- key_delimiter = ','#
Name of this instruction.
Return instruction operands.
Parameters which determine the instruction behavior.
Returns unique key of the subroutine.
- scope_delimiter = '::'#
Relative begin time of this instruction.
Relative end time of this instruction.
- append(schedule, name=None)#
Return a new
scheduleinserted at the maximum time over all channels shared between
Return duration of the supplied channels in this Instruction.
Return minimum start time for supplied channels.
Return maximum start time for supplied channels.
- draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)#
Plot the instruction.
Deprecated since version 0.23.0: The method
qiskit.pulse.instructions.instruction.Instruction.draw()is deprecated as of qiskit-terra 0.23.0. It will be removed no earlier than 3 months after the release date. No direct alternative is being provided to drawing individual pulses. But, instructions can be visualized as part of a complete schedule using
dt (float) – Time interval of samples
style (Optional[SchedStyle]) – A style sheet to configure plot appearance
filename (str | None) – Name required to save pulse image
interp_method (Callable | None) – A function for interpolation
scale (float) – Relative visual scaling of waveform amplitudes
plot_all (bool) – Plot empty channels
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
A matplotlib figure object of the pulse schedule
- Return type:
- insert(start_time, schedule, name=None)#
Return a new
A new schedule with
scheduleinserted with this instruction at t=0.
- Return type: