Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quaternion conversions #77

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions kornia/geometry/quaternion.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
euler_from_quaternion,
normalize_quaternion,
quaternion_from_euler,
quaternion_to_axis_angle,
quaternion_to_rotation_matrix,
rotation_matrix_to_quaternion,
)
Expand Down Expand Up @@ -262,7 +263,7 @@ def from_matrix(cls, matrix: Tensor) -> "Quaternion":

@classmethod
def from_euler(cls, roll: Tensor, pitch: Tensor, yaw: Tensor) -> "Quaternion":
"""Create a quaternion from euler angles.
"""Create a quaternion from Euler angles.

Args:
roll: the roll euler angle.
Expand All @@ -281,10 +282,7 @@ def from_euler(cls, roll: Tensor, pitch: Tensor, yaw: Tensor) -> "Quaternion":
return cls(q)

def to_euler(self) -> Tuple[Tensor, Tensor, Tensor]:
"""Create a quaternion from euler angles.

Args:
matrix: the rotation matrix to convert of shape :math:`(B, 3, 3)`.
"""Convert the quaternion to a triple of Euler angles (roll, pitch, yaw).

Example:
>>> q = Quaternion(tensor([2., 0., 1., 1.]))
Expand Down Expand Up @@ -314,6 +312,17 @@ def from_axis_angle(cls, axis_angle: Tensor) -> "Quaternion":
"""
return cls(axis_angle_to_quaternion(axis_angle))

def to_axis_angle(self) -> Tensor:
"""Converts the quaternion to an axis-angle representation.

Example:
>>> q = Quaternion.identity()
>>> axis_angle = q.to_axis_angle()
>>> axis_angle
tensor([0., 0., 0.], grad_fn=<AsStridedBackward0>)
"""
return quaternion_to_axis_angle(self.data)

@classmethod
def identity(
cls, batch_size: Optional[int] = None, device: Optional[Device] = None, dtype: Dtype = None
Expand Down
33 changes: 33 additions & 0 deletions tests/geometry/test_quaternion.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,39 @@ def test_axis_angle(self, device, dtype, batch_size):
q2 = q2.to(device, dtype)
self.assert_close(q1, q2)

@pytest.mark.parametrize("batch_size", (None, 1, 2, 5))
def test_to_axis_angle(self, device, dtype, batch_size):
# batch_s = 5
# random_coefs = Quaternion.random(batch_s).data
random_coefs = torch.tensor(
[
[2.5398e-04, -2.2677e-01, -8.3897e-01, 4.9467e-01],
[-1.7005e-01, -1.0974e-01, 3.7635e-01, -9.0410e-01],
[9.1273e-01, 4.8935e-02, -6.2994e-03, 4.0558e-01],
[-9.8316e-01, 5.4078e-03, 1.4471e-01, 1.1145e-01],
[4.5794e-02, -7.0831e-01, 6.7577e-01, 1.9883e-01],
],
device=device,
dtype=dtype,
)

q = Quaternion(random_coefs)
axis_angle_actual = q.to_axis_angle()

axis_angle_expected = torch.tensor(
[
[-0.7123, -2.6353, 1.5538],
[0.3118, -1.0693, 2.5687],
[0.1008, -0.0130, 0.8356],
[-0.0109, -0.2911, -0.2242],
[-2.1626, 2.0632, 0.6071],
],
device=device,
dtype=dtype,
)

self.assert_close(axis_angle_expected, axis_angle_actual, 1e-4, 1e-4)

@pytest.mark.parametrize("batch_size", (None, 1, 2, 5))
def test_slerp(self, device, dtype, batch_size):
for axis in torch.tensor([[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]]):
Expand Down
Loading