TimeBlockade
class qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)
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.
from qiskit.pulse import Schedule, Play, Constant, DriveChannel
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.
from qiskit.pulse import ScheduleBlock, Play, Constant, DriveChannel
from qiskit.pulse.instructions import TimeBlockade
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))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.
The class qiskit.pulse.instructions.directives.TimeBlockade is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics
Parameters
- duration (int) – Length of time of the occupation in terms of dt.
- channel (chans.Channel) – The channel that will be the occupied.
- name (str | 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)
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 | 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
ch_duration
ch_duration(*channels)
Return duration of the supplied channels in this Instruction.
Parameters
*channels (Channel) – Supplied channels
Return type
ch_start_time
ch_start_time(*channels)
Return minimum start time for supplied channels.
Parameters
*channels (Channel) – Supplied channels
Return type
ch_stop_time
ch_stop_time(*channels)
Return maximum start time for supplied channels.
Parameters
*channels (Channel) – Supplied channels
Return type
insert
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 (str | 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
is_parameterized
shift
shift(time, name=None)
Return a new schedule shifted forward by time.
Parameters
- time (int) – Time to shift by
- name (str | None) – Name of the new schedule. Defaults to name of self
Returns
The shifted schedule.
Return type