Call#

class qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)[código fonte]#

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.

Nota

Inline subroutine is mutable. This requires special care for modification.

Obsoleto desde a versão 0.25.0: The class qiskit.pulse.instructions.call.Call is 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.

Parâmetros:
Levanta:

PulseError – If subroutine is not valid data format.

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 = 'call'#
start_time#

Relative begin time of this instruction.

stop_time#

Relative end time of this instruction.

subroutine#

Return attached subroutine.

Retorno:

The program referenced by the call.

Tipo de retorno:

program (Union[Schedule, ScheduleBlock])

Methods

append(schedule, name=None)#

Return a new Schedule with schedule inserted at the maximum time over all channels shared between self and schedule.

Parâmetros:

  • schedule (Union['Schedule', 'Instruction']) – Schedule or instruction to be appended

  • name (str | None) – Name of the new schedule. Defaults to name of self

Retorno:

A new schedule with schedule a this instruction at t=0.

Tipo de retorno:

Schedule

assigned_subroutine()[código fonte]#

Returns this subroutine with the parameters assigned.

Nota

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.

Retorno:

Attached program.

Tipo de retorno:

program (Union[Schedule, ScheduleBlock])

ch_duration(*channels)#

Return duration of the supplied channels in this Instruction.

Parâmetros:

*channels (List[Channel]) – Supplied channels

Tipo de retorno:

int

ch_start_time(*channels)#

Return minimum start time for supplied channels.

Parâmetros:

*channels (List[Channel]) – Supplied channels

Tipo de retorno:

int

ch_stop_time(*channels)#

Return maximum start time for supplied channels.

Parâmetros:

*channels (List[Channel]) – Supplied channels

Tipo de retorno:

int

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.

Obsoleto desde a versão 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 qiskit.visualization.pulse_drawer.

Parâmetros:

  • 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

Retorno:

A matplotlib figure object of the pulse schedule

Tipo de retorno:

matplotlib.figure

insert(start_time, schedule, name=None)#

Return a new Schedule with schedule inserted within self at start_time.

Parâmetros:

  • 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

Retorno:

A new schedule with schedule inserted with this instruction at t=0.

Tipo de retorno:

Schedule

is_parameterized()#

Return True iff the instruction is parameterized.

Tipo de retorno:

bool

shift(time, name=None)#

Return a new schedule shifted forward by time.

Parâmetros:

  • time (int) – Time to shift by

  • name (str | None) – Name of the new schedule. Defaults to name of self

Retorno:

The shifted schedule.

Tipo de retorno:

Schedule