Skip to main content

SO3/SE3 operations on any backend

Project description

nanomanifold

Fast, batched and differentiable SO(3)/SE(3) transforms for any backend (NumPy, PyTorch, JAX, ...)

Works directly on arrays, defined as:

  • SO(3): unit quaternions [w, x, y, z] for 3D rotations, shape (..., 4)
  • SE(3): concatenated [quat, translation], shape (..., 7)
import numpy as np
from nanomanifold import SO3, SE3

# Rotations stored as quaternion arrays [w,x,y,z]
q = SO3.from_axis_angle(np.array([0, 0, 1]), np.pi/4)  # 45° around Z
points = np.array([[1, 0, 0], [0, 1, 0]])
rotated = SO3.rotate_points(q, points)

# Rigid transforms stored as 7D arrays [quat, translation]
T = SE3.from_rt(q, np.array([1, 0, 0]))  # rotation + translation
transformed = SE3.transform_points(T, points)

Installation

pip install nanomanifold

Quick Start

Rotations (SO3)

from nanomanifold import SO3

# Create rotations
q1 = SO3.from_axis_angle([1, 0, 0], np.pi/2)    # 90° around X
q2 = SO3.from_euler([0, 0, np.pi/4])            # 45° around Z
q3 = SO3.from_matrix(rotation_matrix)

# Compose and interpolate
q_combined = SO3.multiply(q1, q2)
q_halfway = SO3.slerp(q1, q2, t=0.5)

# Apply to points
points = np.array([[1, 0, 0], [0, 1, 0]])
rotated = SO3.rotate_points(q_combined, points)

Rigid Transforms (SE3)

from nanomanifold import SE3

# Create transforms
T1 = SE3.from_rt(q1, [1, 2, 3])               # rotation + translation
T2 = SE3.from_matrix(transformation_matrix)

# Compose and interpolate
T_combined = SE3.multiply(T1, T2)
T_inverse = SE3.inverse(T_combined)
T_halfway = SE3.slerp(T1, T2, t=0.5)

# Apply to points
transformed = SE3.transform_points(T_combined, points)

API Reference

All functions are available via nanomanifold.SO3 and nanomanifold.SE3. Shapes follow the Array API convention and accept arbitrarily batched inputs.

SO3 (3D Rotations)

Function Signature
canonicalize(q) (...,4) -> (...,4)
to_axis_angle(q) (...,4) -> (...,3)
from_axis_angle(axis_angle) (...,3) -> (...,4)
to_euler(q, convention="ZYX") (...,4) -> (...,3)
from_euler(euler, convention="ZYX") (...,3) -> (...,4)
to_matrix(q) (...,4) -> (...,3,3)
from_matrix(R) (...,3,3) -> (...,4)
from_quat_xyzw(quat) (...,4) -> (...,4)
to_quat_xyzw(quat) (...,4) -> (...,4)
to_6d(q) (...,4) -> (...,6)
from_6d(d6) (...,6) -> (...,4)
multiply(q1, q2) (...,4), (...,4) -> (...,4)
inverse(q) (...,4) -> (...,4)
rotate_points(q, points) (...,4), (...,N,3) -> (...,N,3)
slerp(q1, q2, t) (...,4), (...,4), (...,N) -> (...,N,4)
distance(q1, q2) (...,4), (...,4) -> (...)
log(q) (...,4) -> (...,3)
exp(tangent) (...,3) -> (...,4)
hat(w) (...,3) -> (...,3,3)
vee(W) (...,3,3) -> (...,3)
weighted_mean(quats, weights) sequence of (...,4), (...,N) -> (...,4)
mean(quats) sequence of (...,4) -> (...,4)
random(*shape) (...,4)

SE3 (Rigid Transforms)

Function Signature
canonicalize(se3) (...,7) -> (...,7)
from_rt(quat, translation) (...,4), (...,3) -> (...,7)
to_rt(se3) (...,7) -> (quat, translation)
from_matrix(T) (...,4,4) -> (...,7)
to_matrix(se3) (...,7) -> (...,4,4)
multiply(se3_1, se3_2) (...,7), (...,7) -> (...,7)
inverse(se3) (...,7) -> (...,7)
transform_points(se3, points) (...,7), (...,N,3) -> (...,N,3)
slerp(se3_1, se3_2, t) (...,7), (...,7), (...,N) -> (...,N,7)
log(se3) (...,7) -> (...,6)
exp(tangent) (...,6) -> (...,7)
hat(v) (...,6) -> (...,4,4)
vee(M) (...,4,4) -> (...,6)
weighted_mean(transforms, weights) sequence of (...,7), (...,N) -> (...,7)
mean(transforms) sequence of (...,7) -> (...,7)
random(*shape) (...,7)

Pairwise Conversions (SO3.conversions)

Convert directly between any two rotation representations without going through quaternions manually. All 30 pairwise functions follow the naming pattern from_{source}_to_{target}.

Representations: axis_angle, euler, matrix, quat_wxyz, quat_xyzw, sixd.

Function Signature
SO3.conversions.from_axis_angle_to_matrix(aa) (...,3) -> (...,3,3)
SO3.conversions.from_axis_angle_to_euler(aa, convention) (...,3) -> (...,3)
SO3.conversions.from_axis_angle_to_quat_wxyz(aa) (...,3) -> (...,4)
SO3.conversions.from_axis_angle_to_quat_xyzw(aa) (...,3) -> (...,4)
SO3.conversions.from_axis_angle_to_sixd(aa) (...,3) -> (...,6)
SO3.conversions.from_euler_to_axis_angle(e, convention) (...,3) -> (...,3)
SO3.conversions.from_euler_to_matrix(e, convention) (...,3) -> (...,3,3)
SO3.conversions.from_euler_to_quat_wxyz(e, convention) (...,3) -> (...,4)
SO3.conversions.from_euler_to_quat_xyzw(e, convention) (...,3) -> (...,4)
SO3.conversions.from_euler_to_sixd(e, convention) (...,3) -> (...,6)
SO3.conversions.from_matrix_to_axis_angle(R) (...,3,3) -> (...,3)
SO3.conversions.from_matrix_to_euler(R, convention) (...,3,3) -> (...,3)
SO3.conversions.from_matrix_to_quat_wxyz(R) (...,3,3) -> (...,4)
SO3.conversions.from_matrix_to_quat_xyzw(R) (...,3,3) -> (...,4)
SO3.conversions.from_matrix_to_sixd(R) (...,3,3) -> (...,6)
SO3.conversions.from_quat_wxyz_to_axis_angle(q) (...,4) -> (...,3)
SO3.conversions.from_quat_wxyz_to_euler(q, convention) (...,4) -> (...,3)
SO3.conversions.from_quat_wxyz_to_matrix(q) (...,4) -> (...,3,3)
SO3.conversions.from_quat_wxyz_to_quat_xyzw(q) (...,4) -> (...,4)
SO3.conversions.from_quat_wxyz_to_sixd(q) (...,4) -> (...,6)
SO3.conversions.from_quat_xyzw_to_axis_angle(q) (...,4) -> (...,3)
SO3.conversions.from_quat_xyzw_to_euler(q, convention) (...,4) -> (...,3)
SO3.conversions.from_quat_xyzw_to_matrix(q) (...,4) -> (...,3,3)
SO3.conversions.from_quat_xyzw_to_quat_wxyz(q) (...,4) -> (...,4)
SO3.conversions.from_quat_xyzw_to_sixd(q) (...,4) -> (...,6)
SO3.conversions.from_sixd_to_axis_angle(d6) (...,6) -> (...,3)
SO3.conversions.from_sixd_to_euler(d6, convention) (...,6) -> (...,3)
SO3.conversions.from_sixd_to_matrix(d6) (...,6) -> (...,3,3)
SO3.conversions.from_sixd_to_quat_wxyz(d6) (...,6) -> (...,4)
SO3.conversions.from_sixd_to_quat_xyzw(d6) (...,6) -> (...,4)

Backend-Explicit Mode

By default, nanomanifold auto-detects the array backend via array_api_compat. Every function also accepts an optional xp keyword argument to specify the backend explicitly. This is required for torch.compile(fullgraph=True), since Dynamo cannot trace the dynamic dispatch:

import torch
from nanomanifold import SO3, SE3

@torch.compile(fullgraph=True)
def forward(q1, q2, T1, T2):
    q_mid = SO3.slerp(q1, q2, torch.tensor([0.5]), xp=torch)
    T_mid = SE3.slerp(T1, T2, torch.tensor([0.5]), xp=torch)
    return q_mid, T_mid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nanomanifold-0.2.2.tar.gz (86.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nanomanifold-0.2.2-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file nanomanifold-0.2.2.tar.gz.

File metadata

  • Download URL: nanomanifold-0.2.2.tar.gz
  • Upload date:
  • Size: 86.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nanomanifold-0.2.2.tar.gz
Algorithm Hash digest
SHA256 d097251f055f1e3b2f52bd33bc7f8fe700c43b40dafb8c93c5914e64ee189d8c
MD5 9d5027aa2f6be4b77686002c8e424a82
BLAKE2b-256 4624fb0a8e3a6d102b5274f8eae08411a9d49adc892df8f446e231bf0fa85c0c

See more details on using hashes here.

File details

Details for the file nanomanifold-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: nanomanifold-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nanomanifold-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b6da79860bc8d7a51a34122bb18579a9dacee75133a02f6f2a0632eedcf21375
MD5 3f4846ca658e95914d7b00c36444c41e
BLAKE2b-256 d7224320be68b558ce20215f8000e0d8516e5a773af9374a59990350cb5ce054

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page