SetPhase

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

Bases: Instruction

The set phase instruction sets the phase of the proceeding pulses on that channel to phase radians.

In particular, a PulseChannel creates pulses of the form

Re[\exp(i 2\pi f jdt + \phi) d_j]

\phi

Instantiate a set phase instruction, setting the output signal phase on channel to phase [radians].

Parameters

Attributes

Return the Channel that this instruction is scheduled on.

Returns the channels that this schedule uses.

Duration of this instruction.

Unique identifier for this instruction.

Iterable for getting instructions from Schedule tree.

Name of this instruction.

Return instruction operands.

Parameters which determine the instruction behavior.

Return the rotation angle enacted by this instruction in radians.

Relative begin time of this instruction.

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 .

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(*channels)

Return duration of the supplied channels in this Instruction.

Parameters

*channels (List [Channel]) - Supplied channels

Return type

int

ch_start_time(*channels)

Return minimum start time for supplied channels.

Parameters

*channels (List [Channel]) - Supplied channels

Return type

int

ch_stop_time(*channels)

Return maximum start time for supplied channels.

Parameters

*channels (List [Channel]) - Supplied channels

Return type

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.

Deprecated since 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 .

Parameters

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

Returns

A matplotlib figure object of the pulse schedule

Return type

matplotlib.figure

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

Return True iff the instruction is parameterized.

Return type

bool

shift(time, name=None)

Return a new schedule shifted forward by time.

Parameters

Returns

The shifted schedule.

Return type

Schedule

Was this page helpful?

Report a bug or request content on GitHub.