Call
class Call(subroutine, value_dict=None, name=None)
Bases: Instruction
Pulse Call instruction.
The Call instruction 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.
Parameters
- subroutine (Union[Schedule, ScheduleBlock]) – A program subroutine to be referred to.
- value_dict (Dict[ParameterExpression, ParameterExpression | float] | None) – Mapping of parameter object to assigned value.
- name (str | None) – Unique ID of this subroutine. If not provided, this is generated based on the subroutine name.
Raises
PulseError – If subroutine is not valid data format.
Methods
append
Call.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 (Union['Schedule', 'Instruction']) – Schedule or instruction to be appended
- name (str | None) – Name of the new schedule. Defaults to name of self
Returns
A new schedule with schedule a this instruction at t=0.
Return type
assigned_subroutine
Call.assigned_subroutine()
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 .argument hash. Once this argument is updated, new assigned instance will be returned. Note that this update is not mutable operation.
Returns
Attached program.
Return type
program (Union[Schedule, ScheduleBlock])
ch_duration
Call.ch_duration(*channels)
Return duration of the supplied channels in this Instruction.
Parameters
*channels (List[Channel]) – Supplied channels
Return type
int
ch_start_time
Call.ch_start_time(*channels)
Return minimum start time for supplied channels.
Parameters
*channels (List[Channel]) – Supplied channels
Return type
int
ch_stop_time
Call.ch_stop_time(*channels)
Return maximum start time for supplied channels.
Parameters
*channels (List[Channel]) – Supplied channels
Return type
int
draw
Call.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.
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 qiskit.visualization.pulse_drawer.
Parameters
- 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
- plot_range (Tuple[float] | None) – 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
- channels (List[Channel] | None) – A list of channel names to plot
Returns
A matplotlib figure object of the pulse schedule
Return type
matplotlib.figure
insert
Call.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 (Union['Schedule', 'Instruction']) – Schedule or instruction to insert
- name (str | None) – Name of the new schedule. Defaults to name of self
Returns
A new schedule with schedule inserted with this instruction at t=0.
Return type
is_parameterized
Call.is_parameterized()
Return True iff the instruction is parameterized.
Return type
bool
shift
Call.shift(time, name=None)
Return a new schedule shifted forward by time.
Parameters
- time (int) – Time to shift by
- name (str | None) – Name of the new schedule. Defaults to name of self
Returns
The shifted schedule.
Return type
Attributes
arguments
Parameters dictionary to be assigned to subroutine.
channels
Returns the channels that this schedule uses.
duration
Duration of this instruction.
id
Unique identifier for this instruction.
instructions
Iterable for getting instructions from Schedule tree.
name
Name of this instruction.
operands
Return instruction operands.
parameters
Unassigned parameters which determine the instruction behavior.
prefix
Default value: 'call'
start_time
Relative begin time of this instruction.
stop_time
Relative end time of this instruction.
subroutine
Return attached subroutine.
Returns
The program referenced by the call.
Return type
program (Union[Schedule, ScheduleBlock])