- class qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)#
Callinstruction represents the calling of a referenced subroutine (schedule). It enables code reuse both within the pulse representation and hardware (if supported).
Define new subroutine.
Inline subroutine is mutable. This requires special care for modification.
Deprecated since version 0.25.0: The class
qiskit.pulse.instructions.call.Callis deprecated as of qiskit-terra 0.25.0. It will be removed no earlier than 3 months after the release date. Instead, use the pulse builder function qiskit.pulse.builder.call(subroutine) within an active building context.
name (str | None) – Unique ID of this subroutine. If not provided, this is generated based on the subroutine name.
PulseError – If subroutine is not valid data format.
Parameters dictionary to be assigned to subroutine.
Returns the channels that this schedule uses.
Duration of this instruction.
Unique identifier for this instruction.
Iterable for getting instructions from Schedule tree.
Name of this instruction.
Return instruction operands.
Unassigned parameters which determine the instruction behavior.
- prefix = 'call'#
Relative begin time of this instruction.
Relative end time of this instruction.
Return attached subroutine.
- append(schedule, name=None)#
Return a new
scheduleinserted at the maximum time over all channels shared between
Returns this subroutine with the parameters assigned.
This function may be often called internally for class equality check despite its overhead of parameter assignment. The subroutine with parameter assigned is cached based on
.argumenthash. Once this argument is updated, new assigned instance will be returned. Note that this update is not mutable operation.
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: