qiskit.pulse.instructions.ShiftPhase¶

class ShiftPhase(phase, channel, name=None)[código fonte]¶

The shift phase instruction updates the modulation phase of proceeding pulses played on the same Channel. It is a relative increase in phase determined by the phase operand.

In particular, a PulseChannel creates pulses of the form

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

The ShiftPhase instruction causes \(\phi\) to be increased by the instruction’s phase operand. This will affect all pulses following on the same channel.

The qubit phase is tracked in software, enabling instantaneous, nearly error-free Z-rotations by using a ShiftPhase to update the frame tracking the qubit state.

Instantiate a shift phase instruction, increasing the output signal phase on channel by phase [radians].

Parâmetros

phase (Union[complex, ParameterExpression]) – The rotation angle in radians.
channel (PulseChannel) – The channel this instruction operates on.
name (Optional[str]) – Display name for this instruction.

__init__(phase, channel, name=None)[código fonte]¶

Instantiate a shift phase instruction, increasing the output signal phase on channel by phase [radians].

Parâmetros

phase (Union[complex, ParameterExpression]) – The rotation angle in radians.
channel (PulseChannel) – The channel this instruction operates on.
name (Optional[str]) – Display name for this instruction.

Methods

`__init__`(phase, channel[, name])	Instantiate a shift phase instruction, increasing the output signal phase on `channel` by `phase` [radians].
`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.
`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.

append(schedule, name=None)¶

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

Parâmetros

schedule (Union['Schedule', 'Instruction']) – Schedule or instruction to be appended
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Retorna

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

Tipo de retorno

Schedule

assign_parameters(value_dict)¶

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

Parâmetros: value_dict (Dict[ParameterExpression, Union[ParameterExpression, float, int]]) – A mapping from Parameters to either numeric values or another Parameter expression.
Tipo de retorno: Instruction
Retorna: Self with updated parameters.

ch_duration(*channels)¶

Return duration of the supplied channels in this Instruction.

Parâmetros: *channels – Supplied channels
Tipo de retorno: int

ch_start_time(*channels)¶

Return minimum start time for supplied channels.

Parâmetros: *channels – Supplied channels
Tipo de retorno: int

ch_stop_time(*channels)¶

Return maximum start time for supplied channels.

Parâmetros: *channels – Supplied channels
Tipo de retorno: int

property channel¶

Return the Channel that this instruction is scheduled on.

Tipo de retorno: PulseChannel

property channels¶

Returns the channels that this schedule uses.

Tipo de retorno: 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.

Parâmetros

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

Retorna

A matplotlib figure object of the pulse schedule

Tipo de retorno

matplotlib.figure

property duration¶

Duration of this instruction.

Tipo de retorno: int

flatten()¶

Return itself as already single instruction.

Tipo de retorno: Instruction

property id¶

Unique identifier for this instruction.

Tipo de retorno: int

insert(start_time, schedule, name=None)¶

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

Parâmetros

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

Retorna

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

Tipo de retorno

Schedule

property instructions¶

Iterable for getting instructions from Schedule tree.

Tipo de retorno: Tuple[Tuple[int, Instruction]]

is_parameterized()[código fonte]¶

Return True iff the instruction is parameterized.

Tipo de retorno: bool

property name¶

Name of this instruction.

Tipo de retorno: str

property operands¶

Return instruction operands.

Tipo de retorno: Tuple

property parameters¶

Parameters which determine the instruction behavior.

Tipo de retorno: Set

property phase¶

Return the rotation angle enacted by this instruction in radians.

Tipo de retorno: Union[complex, ParameterExpression]

shift(time, name=None)¶

Return a new schedule shifted forward by time.

Parâmetros

time (int) – Time to shift by
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Retorna

The shifted schedule.

Tipo de retorno

Schedule

property start_time¶

Relative begin time of this instruction.

Tipo de retorno: int

property stop_time¶

Relative end time of this instruction.

Tipo de retorno: int