qiskit.pulse.instructions.Play

class Play(pulse, channel, name=None)

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.

パラメータ

• pulse (Pulse) – A pulse waveform description, such as Waveform.

• channel (PulseChannel) – The channel to which the pulse is applied.

• name (Optional[str]) – Name of the instruction for display purposes. Defaults to pulse.name.

例外

PulseError – If pulse is not a Pulse type.

__init__(pulse, channel, name=None)

Create a new pulse instruction.

パラメータ

• pulse (Pulse) – A pulse waveform description, such as Waveform.

• channel (PulseChannel) – The channel to which the pulse is applied.

• name (Optional[str]) – Name of the instruction for display purposes. Defaults to pulse.name.

例外

PulseError – If pulse is not a Pulse type.

Methods

__init__(pulse, channel[, name])	Create a new pulse instruction.
append(schedule[, name])	Return a new Schedule with schedule inserted at the maximum time over all channels shared between self and schedule.
assign_parameters(value_dict)	Modify and return self with parameters assigned according to the input.
ch_duration(*channels)	Return duration of the supplied channels in this Instruction.
ch_start_time(*channels)	Return minimum start time for supplied channels.
ch_stop_time(*channels)	Return maximum start time for supplied channels.
draw([dt, style, filename, interp_method, …])	Plot the instruction.
flatten()	Return itself as already single instruction.
insert(start_time, schedule[, name])	Return a new Schedule with schedule inserted within self at start_time.
is_parameterized()	Return True iff the instruction is parameterized.
shift(time[, name])	Return a new schedule shifted forward by time.

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.

append(schedule, name=None)

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

パラメータ

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

• name (Optional[str]) – Name of the new schedule. Defaults to name of self

戻り値

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

戻り値の型

Schedule

assign_parameters(value_dict)

Modify and return self with parameters assigned according to the input.

パラメータ

value_dict (Dict[ParameterExpression, Union[ParameterExpression, float, int]]) – A mapping from Parameters to either numeric values or another Parameter expression.

戻り値の型

Play

戻り値

Self with updated parameters.

ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

パラメータ

*channels – Supplied channels

戻り値の型

int

ch_start_time(*channels)

Return minimum start time for supplied channels.

パラメータ

*channels – Supplied channels

戻り値の型

int

ch_stop_time(*channels)

Return maximum start time for supplied channels.

パラメータ

*channels – Supplied channels

戻り値の型

int

property channel

Return the Channel that this instruction is scheduled on.

戻り値の型

PulseChannel

property channels

Returns the channels that this schedule uses.

戻り値の型

Tuple[PulseChannel]

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.

パラメータ

• 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

戻り値

A matplotlib figure object of the pulse schedule

戻り値の型

matplotlib.figure

property duration

Duration of this instruction.

戻り値の型

Union[int, ParameterExpression]

flatten()

Return itself as already single instruction.

戻り値の型

Instruction

property id

Unique identifier for this instruction.

戻り値の型

int

insert(start_time, schedule, name=None)

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

パラメータ

• 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

戻り値

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

戻り値の型

Schedule

property instructions

Iterable for getting instructions from Schedule tree.

戻り値の型

Tuple[Tuple[int, Instruction]]

is_parameterized()

Return True iff the instruction is parameterized.

戻り値の型

bool

property name

Name of this instruction.

戻り値の型

str

property operands

Return instruction operands.

戻り値の型

Tuple

property parameters

Parameters which determine the instruction behavior.

戻り値の型

Set

property pulse

A description of the samples that will be played.

戻り値の型

Pulse

shift(time, name=None)

Return a new schedule shifted forward by time.

パラメータ

• time (int) – Time to shift by

• name (Optional[str]) – Name of the new schedule. Defaults to name of self

戻り値

The shifted schedule.

戻り値の型

Schedule

property start_time

Relative begin time of this instruction.

戻り値の型

int

property stop_time

Relative end time of this instruction.

戻り値の型

int