217 lines
8.1 KiB
Plaintext
217 lines
8.1 KiB
Plaintext
---
|
||
title: SetPhase (v1.4)
|
||
description: API reference for qiskit.pulse.instructions.SetPhase in qiskit v1.4
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.pulse.instructions.SetPhase
|
||
---
|
||
|
||
# SetPhase
|
||
|
||
<Class id="qiskit.pulse.instructions.SetPhase" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/phase.py#L93-L152" signature="qiskit.pulse.instructions.SetPhase(phase, channel, name=None)" modifiers="class">
|
||
Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.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]
|
||
$$
|
||
|
||
The `SetPhase` instruction sets $\phi$ to the instruction’s `phase` operand.
|
||
|
||
Instantiate a set phase instruction, setting the output signal phase on `channel` to `phase` \[radians].
|
||
|
||
<Admonition title="Deprecated since version 1.3" type="danger">
|
||
The class `qiskit.pulse.instructions.phase.SetPhase` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics)
|
||
</Admonition>
|
||
|
||
**Parameters**
|
||
|
||
* **phase** ([*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")) – The rotation angle in radians.
|
||
* **channel** (*PulseChannel*) – The channel this instruction operates on.
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Display name for this instruction.
|
||
|
||
## Attributes
|
||
|
||
### channel
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.channel">
|
||
Return the [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on.
|
||
</Attribute>
|
||
|
||
### channels
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.channels">
|
||
Returns the channels that this schedule uses.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.duration">
|
||
Duration of this instruction.
|
||
</Attribute>
|
||
|
||
### id
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.id">
|
||
Unique identifier for this instruction.
|
||
</Attribute>
|
||
|
||
### instructions
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.instructions">
|
||
Iterable for getting instructions from Schedule tree.
|
||
</Attribute>
|
||
|
||
### name
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.name">
|
||
Name of this instruction.
|
||
</Attribute>
|
||
|
||
### operands
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.operands">
|
||
Return instruction operands.
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.parameters">
|
||
Parameters which determine the instruction behavior.
|
||
</Attribute>
|
||
|
||
### phase
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.phase">
|
||
Return the rotation angle enacted by this instruction in radians.
|
||
</Attribute>
|
||
|
||
### start\_time
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.start_time">
|
||
Relative begin time of this instruction.
|
||
</Attribute>
|
||
|
||
### stop\_time
|
||
|
||
<Attribute id="qiskit.pulse.instructions.SetPhase.stop_time">
|
||
Relative end time of this instruction.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### append
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.append" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L187-L200" signature="append(schedule, name=None)">
|
||
Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.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*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| 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](qiskit.pulse.Schedule "qiskit.pulse.Schedule")
|
||
</Function>
|
||
|
||
### ch\_duration
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.ch_duration" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L114-L120" signature="ch_duration(*channels)">
|
||
Return duration of the supplied channels in this Instruction.
|
||
|
||
**Parameters**
|
||
|
||
**\*channels** ([*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")
|
||
</Function>
|
||
|
||
### ch\_start\_time
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.ch_start_time" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L122-L129" signature="ch_start_time(*channels)">
|
||
Return minimum start time for supplied channels.
|
||
|
||
**Parameters**
|
||
|
||
**\*channels** ([*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")
|
||
</Function>
|
||
|
||
### ch\_stop\_time
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.ch_stop_time" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L131-L139" signature="ch_stop_time(*channels)">
|
||
Return maximum start time for supplied channels.
|
||
|
||
**Parameters**
|
||
|
||
**\*channels** ([*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels
|
||
|
||
**Return type**
|
||
|
||
[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")
|
||
</Function>
|
||
|
||
### insert
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.insert" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L169-L185" signature="insert(start_time, schedule, name=None)">
|
||
Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`.
|
||
|
||
**Parameters**
|
||
|
||
* **start\_time** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Time to insert the schedule schedule
|
||
* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| 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](qiskit.pulse.Schedule "qiskit.pulse.Schedule")
|
||
</Function>
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L221-L223" signature="is_parameterized()">
|
||
Return True iff the instruction is parameterized.
|
||
|
||
**Return type**
|
||
|
||
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")
|
||
</Function>
|
||
|
||
### shift
|
||
|
||
<Function id="qiskit.pulse.instructions.SetPhase.shift" github="https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/pulse/instructions/instruction.py#L153-L167" signature="shift(time, name=None)">
|
||
Return a new schedule shifted forward by time.
|
||
|
||
**Parameters**
|
||
|
||
* **time** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Time to shift by
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name of the new schedule. Defaults to name of self
|
||
|
||
**Returns**
|
||
|
||
The shifted schedule.
|
||
|
||
**Return type**
|
||
|
||
[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule")
|
||
</Function>
|
||
</Class>
|
||
|