129 lines
4.9 KiB
Plaintext
129 lines
4.9 KiB
Plaintext
---
|
||
title: Quaternion
|
||
description: API reference for qiskit.quantum_info.Quaternion
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.quantum_info.Quaternion
|
||
---
|
||
|
||
<span id="qiskit-quantum-info-quaternion" />
|
||
|
||
# qiskit.quantum\_info.Quaternion
|
||
|
||
<Class id="qiskit.quantum_info.Quaternion" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.16/qiskit/quantum_info/operators/quaternion.py" signature="Quaternion(data)" modifiers="class">
|
||
A class representing a Quaternion.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.__init__" signature="__init__(data)">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||
| [`__init__`](#qiskit.quantum_info.Quaternion.__init__ "qiskit.quantum_info.Quaternion.__init__")(data) | Initialize self. |
|
||
| [`from_axis_rotation`](#qiskit.quantum_info.Quaternion.from_axis_rotation "qiskit.quantum_info.Quaternion.from_axis_rotation")(angle, axis) | Return quaternion for rotation about given axis. |
|
||
| [`from_euler`](#qiskit.quantum_info.Quaternion.from_euler "qiskit.quantum_info.Quaternion.from_euler")(angles\[, order]) | Generate a quaternion from a set of Euler angles. |
|
||
| [`norm`](#qiskit.quantum_info.Quaternion.norm "qiskit.quantum_info.Quaternion.norm")() | Norm of quaternion. |
|
||
| [`normalize`](#qiskit.quantum_info.Quaternion.normalize "qiskit.quantum_info.Quaternion.normalize")(\[inplace]) | Normalizes a Quaternion to unit length so that it represents a valid rotation. |
|
||
| [`to_matrix`](#qiskit.quantum_info.Quaternion.to_matrix "qiskit.quantum_info.Quaternion.to_matrix")() | Converts a unit-length quaternion to a rotation matrix. |
|
||
| [`to_zyz`](#qiskit.quantum_info.Quaternion.to_zyz "qiskit.quantum_info.Quaternion.to_zyz")() | Converts a unit-length quaternion to a sequence of ZYZ Euler angles. |
|
||
|
||
### from\_axis\_rotation
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.from_axis_rotation" signature="from_axis_rotation(angle, axis)" modifiers="classmethod">
|
||
Return quaternion for rotation about given axis.
|
||
|
||
**Parameters**
|
||
|
||
* **angle** (*float*) – Angle in radians.
|
||
* **axis** (*str*) – Axis for rotation
|
||
|
||
**Returns**
|
||
|
||
Quaternion for axis rotation.
|
||
|
||
**Return type**
|
||
|
||
[Quaternion](#qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")
|
||
|
||
**Raises**
|
||
|
||
**ValueError** – Invalid input axis.
|
||
</Function>
|
||
|
||
### from\_euler
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.from_euler" signature="from_euler(angles, order='yzy')" modifiers="classmethod">
|
||
Generate a quaternion from a set of Euler angles.
|
||
|
||
**Parameters**
|
||
|
||
* **angles** (*array\_like*) – Array of Euler angles.
|
||
* **order** (*str*) – Order of Euler rotations. ‘yzy’ is default.
|
||
|
||
**Returns**
|
||
|
||
Quaternion representation of Euler rotation.
|
||
|
||
**Return type**
|
||
|
||
[Quaternion](#qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")
|
||
</Function>
|
||
|
||
### norm
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.norm" signature="norm()">
|
||
Norm of quaternion.
|
||
</Function>
|
||
|
||
### normalize
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.normalize" signature="normalize(inplace=False)">
|
||
Normalizes a Quaternion to unit length so that it represents a valid rotation.
|
||
|
||
**Parameters**
|
||
|
||
**inplace** (*bool*) – Do an inplace normalization.
|
||
|
||
**Returns**
|
||
|
||
Normalized quaternion.
|
||
|
||
**Return type**
|
||
|
||
[Quaternion](#qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")
|
||
</Function>
|
||
|
||
### to\_matrix
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.to_matrix" signature="to_matrix()">
|
||
Converts a unit-length quaternion to a rotation matrix.
|
||
|
||
**Returns**
|
||
|
||
Rotation matrix.
|
||
|
||
**Return type**
|
||
|
||
ndarray
|
||
</Function>
|
||
|
||
### to\_zyz
|
||
|
||
<Function id="qiskit.quantum_info.Quaternion.to_zyz" signature="to_zyz()">
|
||
Converts a unit-length quaternion to a sequence of ZYZ Euler angles.
|
||
|
||
**Returns**
|
||
|
||
Array of Euler angles.
|
||
|
||
**Return type**
|
||
|
||
ndarray
|
||
</Function>
|
||
</Class>
|
||
|