TimeBlockade#

class qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)[Quellcode]#

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))

Bemerkung

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.

Parameter:

  • duration (int) – Length of time of the occupation in terms of dt.

  • channel (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(schedule, name=None)#

Return a new Schedule with schedule inserted at the maximum time over all channels shared between self and schedule.

Parameter:

  • schedule (Union['Schedule', 'Instruction']) – Schedule or instruction to be appended

  • name (str | None) – Name of the new schedule. Defaults to name of self

Rückgabe:

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

Rückgabetyp:

Schedule

ch_duration(*channels)#

Return duration of the supplied channels in this Instruction.

Parameter:

*channels (List[Channel]) – Supplied channels

Rückgabetyp:

int

ch_start_time(*channels)#

Return minimum start time for supplied channels.

Parameter:

*channels (List[Channel]) – Supplied channels

Rückgabetyp:

int

ch_stop_time(*channels)#

Return maximum start time for supplied channels.

Parameter:

*channels (List[Channel]) – Supplied channels

Rückgabetyp:

int

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.

Veraltet ab 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.

Parameter:

  • dt (float) – Time interval of samples

  • style (Optional[SchedStyle]) – A style sheet to configure plot appearance

  • filename (str | None) – Name required to save pulse image

  • interp_method (Callable | None) – A function for interpolation

  • scale (float) – Relative visual scaling of waveform amplitudes

  • plot_all (bool) – Plot empty channels

  • plot_range (Tuple[float] | None) – 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 (List[Channel] | None) – A list of channel names to plot

Rückgabe:

A matplotlib figure object of the pulse schedule

Rückgabetyp:

matplotlib.figure

insert(start_time, schedule, name=None)#

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

Parameter:

  • 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

Rückgabe:

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

Rückgabetyp:

Schedule

is_parameterized()#

Return True iff the instruction is parameterized.

Rückgabetyp:

bool

shift(time, name=None)#

Return a new schedule shifted forward by time.

Parameter:

  • time (int) – Time to shift by

  • name (str | None) – Name of the new schedule. Defaults to name of self

Rückgabe:

The shifted schedule.

Rückgabetyp:

Schedule