Skip to main contentIBM Quantum Documentation

RelativeBarrier

qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)GitHub(opens in a new tab)

Bases: Directive

Pulse RelativeBarrier directive.

Create a relative barrier directive.

The barrier directive blocks instructions within the same schedule as the barrier on channels contained within this barrier from moving through the barrier in time.

Parameters

  • channels (chans.Channel) – The channel that the barrier applies to.
  • name (str(opens in a new tab) | None) – Name of the directive for display purposes.

Attributes

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 (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 (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 (Channel) – Supplied channels

Return type

int(opens in a new tab)

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?