Skip to main contentIBM Quantum Documentation

TimeBlockade

qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None) GitHub(opens in a new tab)

Bases: 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(opens in a new tab)) – Length of time of the occupation in terms of dt.
  • channel (chans.Channel) – The channel that will be the occupied.
  • name (str(opens in a new tab) | None) – Name of the time blockade for display purposes.

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

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

Return duration of the supplied channels in this Instruction.

Parameters

*channels (Channel) – Supplied channels

Return type

int(opens in a new tab)

ch_start_time

ch_start_time(*channels) GitHub(opens in a new tab)

Return minimum start time for supplied channels.

Parameters

*channels (Channel) – Supplied channels

Return type

int(opens in a new tab)

ch_stop_time

ch_stop_time(*channels) GitHub(opens in a new tab)

Return maximum start time for supplied channels.

Parameters

*channels (Channel) – Supplied channels

Return type

int(opens in a new tab)

insert

insert(start_time, schedule, name=None) GitHub(opens in a new tab)

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

Return True iff the instruction is parameterized.

Return type

bool(opens in a new tab)

shift

shift(time, name=None) GitHub(opens in a new tab)

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.