Play
class Play(pulse, channel, name=None)
Bases: qiskit.pulse.instructions.instruction.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.
Parameters
- pulse (
Pulse) – A pulse waveform description, such asWaveform. - channel (
PulseChannel) – The channel to which the pulse is applied. - name (
Optional[str]) – Name of the instruction for display purposes. Defaults topulse.name.
Raises
PulseError – If pulse is not a Pulse type.
Methods
append
Play.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 (
Optional[str]) – 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
Play.ch_duration(*channels)
Return duration of the supplied channels in this Instruction.
Parameters
*channels – Supplied channels
Return type
int
ch_start_time
Play.ch_start_time(*channels)
Return minimum start time for supplied channels.
Parameters
*channels – Supplied channels
Return type
int
ch_stop_time
Play.ch_stop_time(*channels)
Return maximum start time for supplied channels.
Parameters
*channels – Supplied channels
Return type
int
draw
Play.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.
Parameters
- dt (
float) – Time interval of samples - style (Optional[SchedStyle]) – A style sheet to configure plot appearance
- filename (
Optional[str]) – Name required to save pulse image - interp_method (
Optional[Callable]) – A function for interpolation - scale (
float) – Relative visual scaling of waveform amplitudes - plot_all (
bool) – Plot empty channels - plot_range (
Optional[Tuple[float]]) – 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 (
Optional[List[Channel]]) – A list of channel names to plot
Returns
A matplotlib figure object of the pulse schedule
Return type
matplotlib.figure
insert
Play.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 (
Optional[str]) – 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
Play.is_parameterized()
Return True iff the instruction is parameterized.
Return type
bool
shift
Play.shift(time, name=None)
Return a new schedule shifted forward by time.
Parameters
- time (
int) – Time to shift by - name (
Optional[str]) – Name of the new schedule. Defaults to name of self
Returns
The shifted schedule.
Return type
Attributes
channel
channels
Returns the channels that this schedule uses.
Return type
Tuple[PulseChannel]
duration
id
Unique identifier for this instruction.
Return type
int
instructions
name
Name of this instruction.
Return type
str
operands
Return instruction operands.
Return type
Tuple
parameters
Parameters which determine the instruction behavior.
Return type
Set
pulse
A description of the samples that will be played.
Return type
Pulse
start_time
Relative begin time of this instruction.
Return type
int
stop_time
Relative end time of this instruction.
Return type
int