Skip to main contentIBM Quantum Documentation

Play

class qiskit.pulse.instructions.Play(pulse, channel, name=None)

GitHub

Bases: Instruction

This instruction is responsible for applying a pulse on a channel.

The pulse specifies the exact time dynamics of the output signal envelope for a limited time. The output is modulated by a phase and frequency which are controlled by separate instructions. The pulse duration must be fixed, and is implicitly given in terms of the cycle time, dt, of the backend.

Create a new pulse instruction.

Deprecated since version 1.3

The class qiskit.pulse.instructions.play.Play 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

  • pulse (Pulse) – A pulse waveform description, such as Waveform.
  • channel (PulseChannel) – The channel to which the pulse is applied.
  • name (str | None) – Name of the instruction for display purposes. Defaults to pulse.name.

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.

pulse

A description of the samples that will be played.

start_time

Relative begin time of this instruction.

stop_time

Relative end time of this instruction.


Methods

append

append(schedule, name=None)

GitHub

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

Schedule

ch_duration

ch_duration(*channels)

GitHub

Return duration of the supplied channels in this Instruction.

Parameters

*channels (Channel) – Supplied channels

Return type

int

ch_start_time

ch_start_time(*channels)

GitHub

Return minimum start time for supplied channels.

Parameters

*channels (Channel) – Supplied channels

Return type

int

ch_stop_time

ch_stop_time(*channels)

GitHub

Return maximum start time for supplied channels.

Parameters

*channels (Channel) – Supplied channels

Return type

int

insert

insert(start_time, schedule, name=None)

GitHub

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

Schedule

is_parameterized

is_parameterized()

GitHub

Return True iff the instruction is parameterized.

Return type

bool

shift

shift(time, name=None)

GitHub

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

Schedule

Was this page helpful?
Report a bug or request content on GitHub.