Skip to main contentIBM Quantum Documentation

Delay

Delay(duration, channel, name=None)

Bases: qiskit.pulse.instructions.instruction.Instruction

A blocking instruction with no other effect. The delay is used for aligning and scheduling other instructions.


Example

To schedule an instruction at time = 10, on a channel assigned to the variable channel, the following could be used:

sched = Schedule(name="Delay instruction example")
sched += Delay(10, channel)
sched += Gaussian(duration, amp, sigma, channel)

The channel will output no signal from time=0 up until time=10.

Create a new delay instruction.

No other instruction may be scheduled within a Delay.

Parameters

  • duration (Union[int, ParameterExpression]) – Length of time of the delay in terms of dt.
  • channel (Channel) – The channel that will have the delay.
  • name (Optional[str]) – Name of the delay for display purposes.

Methods

append

Delay.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 (Optional[str]) – Name of the new schedule. Defaults to name of self

Returns

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

Return type

Schedule

ch_duration

Delay.ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

Parameters

*channels – Supplied channels

Return type

int

ch_start_time

Delay.ch_start_time(*channels)

Return minimum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

ch_stop_time

Delay.ch_stop_time(*channels)

Return maximum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

draw

Delay.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.

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
  • 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
  • channels (Optional[List[Channel]]) – A list of channel names to plot

Returns

A matplotlib figure object of the pulse schedule

Return type

matplotlib.figure

insert

Delay.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 (Optional[str]) – 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

Schedule

is_parameterized

Delay.is_parameterized()

Return True iff the instruction is parameterized.

Return type

bool

shift

Delay.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

Returns

The shifted schedule.

Return type

Schedule


Attributes

channel

Return the Channel that this instruction is scheduled on.

Return type

Channel

channels

Returns the channels that this schedule uses.

Return type

Tuple[Channel]

duration

Duration of this instruction.

Return type

Union[int, ParameterExpression]

id

Unique identifier for this instruction.

Return type

int

instructions

Iterable for getting instructions from Schedule tree.

Return type

Tuple[Tuple[int, Instruction]]

name

Name of this instruction.

Return type

str

operands

Return instruction operands.

Return type

Tuple

parameters

Parameters which determine the instruction behavior.

Return type

Set

start_time

Relative begin time of this instruction.

Return type

int

stop_time

Relative end time of this instruction.

Return type

int

Was this page helpful?