EulerAngle Class¶
The EulerAngle class represents attitude using Euler angle sequences for intuitive spacecraft orientation specification.
EulerAngle ¶
EulerAngle(order: str, phi: float, theta: float, psi: float, angle_format: AngleFormat)
Represents a rotation using Euler angles.
Euler angles describe rotations as a sequence of three rotations about specified axes. The rotation sequence is specified by the order parameter (e.g., "XYZ", "ZYX").
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
order | str | Rotation sequence (e.g., "XYZ", "ZYX", "ZXZ") | required |
phi | float | First rotation angle in radians or degrees | required |
theta | float | Second rotation angle in radians or degrees | required |
psi | float | Third rotation angle in radians or degrees | required |
angle_format | AngleFormat | Units of input angles (RADIANS or DEGREES) | required |
Example
Initialize instance.
order property ¶
order: EulerAngleOrder
Get the rotation sequence order.
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngleOrder | EulerAngleOrder | Rotation sequence enum value |
from_euler_angle builtin ¶
from_euler_angle(e: EulerAngle, order: str) -> EulerAngle
Create Euler angles from another Euler angle with different order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
e | EulerAngle | Source Euler angles | required |
order | str | Desired rotation sequence (e.g., "XYZ", "ZYX") | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | Equivalent Euler angles with new order |
from_euler_axis builtin ¶
from_euler_axis(e: EulerAxis, order: str) -> EulerAngle
Create Euler angles from an Euler axis representation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
e | EulerAxis | Euler axis representation | required |
order | str | Desired rotation sequence (e.g., "XYZ", "ZYX") | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | Equivalent Euler angles |
from_quaternion builtin ¶
from_quaternion(q: Quaternion, order: str) -> EulerAngle
Create Euler angles from a quaternion.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q | Quaternion | Source quaternion | required |
order | str | Desired rotation sequence (e.g., "XYZ", "ZYX") | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | Equivalent Euler angles |
from_rotation_matrix builtin ¶
from_rotation_matrix(r: RotationMatrix, order: str) -> EulerAngle
Create Euler angles from a rotation matrix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
r | RotationMatrix | Rotation matrix | required |
order | str | Desired rotation sequence (e.g., "XYZ", "ZYX") | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | Equivalent Euler angles |
from_vector builtin ¶
from_vector(v: ndarray, order: str, angle_format: AngleFormat) -> EulerAngle
Create Euler angles from a numpy array.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
v | ndarray | 3-element array [phi, theta, psi] | required |
order | str | Rotation sequence (e.g., "XYZ", "ZYX") | required |
angle_format | AngleFormat | Units of input angles (RADIANS or DEGREES) | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | New Euler angle instance |
to_euler_angle method descriptor ¶
to_euler_angle(order: str) -> EulerAngle
Convert to Euler angles with different rotation sequence.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
order | str | Desired rotation sequence (e.g., "XYZ", "ZYX") | required |
Returns:
| Name | Type | Description |
|---|---|---|
EulerAngle | EulerAngle | Equivalent Euler angles with new order |
to_quaternion method descriptor ¶
to_quaternion() -> Quaternion
Convert to quaternion representation.
Returns:
| Name | Type | Description |
|---|---|---|
Quaternion | Quaternion | Equivalent quaternion |
to_rotation_matrix method descriptor ¶
to_rotation_matrix() -> RotationMatrix
Convert to rotation matrix representation.
Returns:
| Name | Type | Description |
|---|---|---|
RotationMatrix | RotationMatrix | Equivalent rotation matrix |