Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

Delay

class qiskit.pulse.instructions.Delay(duration, channel, name=None)

GitHub(opens in a new tab)

Bases: 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


Attributes

channel

Return the Channel that this instruction is scheduled on.

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

Parameters which determine the instruction behavior.

start_time

Relative begin time of this instruction.

stop_time

Relative end time of this instruction.


Methods

append

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(opens in a new tab) | 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

Schedule

ch_duration

ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

Parameters

*channels (List(opens in a new tab)[Channel]) – Supplied channels

Return type

int(opens in a new tab)

ch_start_time

ch_start_time(*channels)

Return minimum start time for supplied channels.

Parameters

*channels (List(opens in a new tab)[Channel]) – Supplied channels

Return type

int(opens in a new tab)

ch_stop_time

ch_stop_time(*channels)

Return maximum start time for supplied channels.

Parameters

*channels (List(opens in a new tab)[Channel]) – Supplied channels

Return type

int(opens in a new tab)

draw

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 qiskit.visualization.pulse_drawer.

Parameters

Returns

A matplotlib figure object of the pulse schedule

Return type

matplotlib.figure

insert

insert(start_time, schedule, name=None)

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

Parameters

  • start_time (int(opens in a new tab)) – Time to insert the schedule schedule
  • schedule (Union['Schedule', 'Instruction']) – Schedule or instruction to insert
  • name (str(opens in a new tab) | 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

Schedule

is_parameterized

is_parameterized()

Return True iff the instruction is parameterized.

Return type

bool(opens in a new tab)

shift

shift(time, name=None)

Return a new schedule shifted forward by time.

Parameters

Returns

The shifted schedule.

Return type

Schedule

Was this page helpful?
Report a bug or request content on GitHub.