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
The SetPhase instruction sets to the instruction’s phase operand.
Instantiate a set phase instruction, setting the output signal phase on channel to phase [radians].
Parameters
- phase (complex |ParameterExpression) – The rotation angle in radians.
- channel (PulseChannel) – The channel this instruction operates on.
- name (str | None) – Display name for this instruction.
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.
phase
Return the rotation angle enacted by this instruction in radians.
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 | 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
ch_duration
ch_duration(*channels)
Return duration of the supplied channels in this Instruction.
Parameters
*channels (Channel) – Supplied channels
Return type
ch_start_time
ch_start_time(*channels)
Return minimum start time for supplied channels.
Parameters
*channels (Channel) – Supplied channels
Return type
ch_stop_time
ch_stop_time(*channels)
Return maximum start time for supplied channels.
Parameters
*channels (Channel) – Supplied channels
Return type
insert
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
is_parameterized
shift
shift(time, name=None)
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