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

TimeBlockade

TimeBlockade(duration, channel, name=None) GitHub(opens in a new tab)

Bases: qiskit.pulse.instructions.directives.Directive

Pulse TimeBlockade directive.

This instruction is intended to be used internally within the pulse builder, to convert Schedule into ScheduleBlock. Because ScheduleBlock cannot take an absolute instruction time interval, this directive helps the block representation to find the starting time of an instruction.

Example

This schedule plays constant pulse at t0 = 120.

schedule = Schedule()
schedule.insert(120, Play(Constant(10, 0.1), DriveChannel(0)))

This schedule block is expected to be identical to above at a time of execution.

block = ScheduleBlock()
block.append(TimeBlockade(120, DriveChannel(0)))
block.append(Play(Constant(10, 0.1), DriveChannel(0)))

Such conversion may be done by

from qiskit.pulse.transforms import block_to_schedule, remove_directives
 
schedule = remove_directives(block_to_schedule(block))
Note

The TimeBlockade instruction behaves almost identically to Delay instruction. However, the TimeBlockade is just a compiler directive and must be removed before execution. This may be done by remove_directives() transform. Once these directives are removed, occupied timeslots are released and user can insert another instruction without timing overlap.

Create a time blockade directive.

Parameters

  • duration (int) – Length of time of the occupation in terms of dt.
  • channel (Channel) – The channel that will be the occupied.
  • name (Optional[str]) – Name of the time blockade for display purposes.

Methods

append

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

TimeBlockade.ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

Parameters

*channels – Supplied channels

Return type

int

ch_start_time

TimeBlockade.ch_start_time(*channels)

Return minimum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

ch_stop_time

TimeBlockade.ch_stop_time(*channels)

Return maximum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

draw

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

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

TimeBlockade.is_parameterized()

Return True iff the instruction is parameterized.

Return type

bool

shift

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

int

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?