pub struct SE3 { /* private fields */ }Expand description
SE(3) group element representing rigid body transformations in 3D.
Represented as a combination of SO(3) rotation and Vector3 translation.
Implementations§
Source§impl SE3
impl SE3
Sourcepub const DIM: usize = 3
pub const DIM: usize = 3
Space dimension - dimension of the ambient space that the group acts on
Sourcepub fn identity() -> SE3
pub fn identity() -> SE3
Get the identity element of the group.
Returns the neutral element e such that e ∘ g = g ∘ e = g for any group element g.
Sourcepub fn jacobian_identity() -> Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>
pub fn jacobian_identity() -> Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>
Get the identity matrix for Jacobians.
Returns the identity matrix in the appropriate dimension for Jacobian computations.
Sourcepub fn new(
translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>,
rotation: Unit<Quaternion<f64>>,
) -> SE3
pub fn new( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, rotation: Unit<Quaternion<f64>>, ) -> SE3
Create a new SE3 element from translation and rotation.
§Arguments
translation- Translation vector [x, y, z]rotation- Unit quaternion representing rotation
Sourcepub fn from_translation_quaternion(
translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>,
quaternion: Quaternion<f64>,
) -> SE3
pub fn from_translation_quaternion( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, quaternion: Quaternion<f64>, ) -> SE3
Create SE3 from translation components and Euler angles.
Sourcepub fn from_translation_euler(
x: f64,
y: f64,
z: f64,
roll: f64,
pitch: f64,
yaw: f64,
) -> SE3
pub fn from_translation_euler( x: f64, y: f64, z: f64, roll: f64, pitch: f64, yaw: f64, ) -> SE3
Create SE3 from translation components and Euler angles.
Sourcepub fn from_isometry(isometry: Isometry<f64, Unit<Quaternion<f64>>, 3>) -> SE3
pub fn from_isometry(isometry: Isometry<f64, Unit<Quaternion<f64>>, 3>) -> SE3
Create SE3 directly from an Isometry3.
Sourcepub fn from_translation_so3(
translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>,
rotation: SO3,
) -> SE3
pub fn from_translation_so3( translation: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, rotation: SO3, ) -> SE3
Create SE3 from SO3 and Vector3 components.
Sourcepub fn translation(
&self,
) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>
pub fn translation( &self, ) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>
Get the translation part as a Vector3.
Sourcepub fn rotation_so3(&self) -> SO3
pub fn rotation_so3(&self) -> SO3
Get the rotation part as SO3.
Sourcepub fn rotation_quaternion(&self) -> Unit<Quaternion<f64>>
pub fn rotation_quaternion(&self) -> Unit<Quaternion<f64>>
Get the rotation part as a UnitQuaternion.
Sourcepub fn isometry(&self) -> Isometry<f64, Unit<Quaternion<f64>>, 3>
pub fn isometry(&self) -> Isometry<f64, Unit<Quaternion<f64>>, 3>
Get as an Isometry3 (convenience method).
Trait Implementations§
Source§impl LieGroup for SE3
impl LieGroup for SE3
Source§fn compose(
&self,
other: &SE3,
jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>,
jacobian_other: Option<&mut <SE3 as LieGroup>::JacobianMatrix>,
) -> SE3
fn compose( &self, other: &SE3, jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, jacobian_other: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, ) -> SE3
Composition of this and another SE3 element.
§Arguments
other- Another SE3 element.jacobian_self- Optional Jacobian matrix of the composition wrt this.jacobian_other- Optional Jacobian matrix of the composition wrt other.
§Notes
§Equation 171: Composition of SE(3) matrices
M_a M_b = [ R_aR_b R_at_b + t_a ] [ 0 1 ]
§Equation 177: Jacobian of the composition wrt self.
J_MaMb_Ma = [ R_bᵀ -R_bᵀ*[t_b]ₓ ] [ 0 R_bᵀ ]
§Equation 178: Jacobian of the composition wrt other.
J_MaMb_Mb = I_6
Source§fn log(
&self,
jacobian: Option<&mut <SE3 as LieGroup>::JacobianMatrix>,
) -> <SE3 as LieGroup>::TangentVector
fn log( &self, jacobian: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, ) -> <SE3 as LieGroup>::TangentVector
Get the SE3 corresponding Lie algebra element in vector form.
§Arguments
jacobian- Optional Jacobian matrix of the tangent wrt to this.
§Notes
§Equation 173: SE(3) logarithmic map
τ = log(M) = [ V⁻¹(θ) t ] [ Log(R) ]
§Equation 174: V(θ) function for SE(3) Log/Exp maps
V(θ) = I + (1 - cos θ)/θ² [θ]ₓ + (θ - sin θ)/θ³ [θ]ₓ²
Source§fn vee(&self) -> <SE3 as LieGroup>::TangentVector
fn vee(&self) -> <SE3 as LieGroup>::TangentVector
Vee operator: log(g)^∨.
Maps a group element g ∈ G to its tangent vector log(g)^∨ ∈ 𝔤. For SE(3), this is the same as log().
Source§fn is_approx(&self, other: &SE3, tolerance: f64) -> bool
fn is_approx(&self, other: &SE3, tolerance: f64) -> bool
Check if the element is approximately equal to another element.
§Arguments
other- The other element to compare withtolerance- The tolerance for the comparison
Source§type TangentVector = SE3Tangent
type TangentVector = SE3Tangent
Source§type JacobianMatrix = Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>
type JacobianMatrix = Matrix<f64, Const<6>, Const<6>, ArrayStorage<f64, 6, 6>>
Source§type LieAlgebra = Matrix<f64, Const<4>, Const<4>, ArrayStorage<f64, 4, 4>>
type LieAlgebra = Matrix<f64, Const<4>, Const<4>, ArrayStorage<f64, 4, 4>>
Source§fn act(
&self,
vector: &Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>,
jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>,
jacobian_vector: Option<&mut Matrix<f64, Const<3>, Const<3>, ArrayStorage<f64, 3, 3>>>,
) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>
fn act( &self, vector: &Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, jacobian_self: Option<&mut <SE3 as LieGroup>::JacobianMatrix>, jacobian_vector: Option<&mut Matrix<f64, Const<3>, Const<3>, ArrayStorage<f64, 3, 3>>>, ) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>
Source§fn jacobian_identity() -> <SE3 as LieGroup>::JacobianMatrix
fn jacobian_identity() -> <SE3 as LieGroup>::JacobianMatrix
Source§fn zero_jacobian() -> <SE3 as LieGroup>::JacobianMatrix
fn zero_jacobian() -> <SE3 as LieGroup>::JacobianMatrix
Source§fn is_valid(&self, tolerance: f64) -> bool
fn is_valid(&self, tolerance: f64) -> bool
Source§fn right_plus(
&self,
tangent: &Self::TangentVector,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_tangent: Option<&mut Self::JacobianMatrix>,
) -> Self
fn right_plus( &self, tangent: &Self::TangentVector, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_tangent: Option<&mut Self::JacobianMatrix>, ) -> Self
Source§fn right_minus(
&self,
other: &Self,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_other: Option<&mut Self::JacobianMatrix>,
) -> Self::TangentVector
fn right_minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector
Source§fn left_plus(
&self,
tangent: &Self::TangentVector,
jacobian_tangent: Option<&mut Self::JacobianMatrix>,
jacobian_self: Option<&mut Self::JacobianMatrix>,
) -> Self
fn left_plus( &self, tangent: &Self::TangentVector, jacobian_tangent: Option<&mut Self::JacobianMatrix>, jacobian_self: Option<&mut Self::JacobianMatrix>, ) -> Self
Source§fn left_minus(
&self,
other: &Self,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_other: Option<&mut Self::JacobianMatrix>,
) -> Self::TangentVector
fn left_minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector
Source§fn plus(
&self,
tangent: &Self::TangentVector,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_tangent: Option<&mut Self::JacobianMatrix>,
) -> Self
fn plus( &self, tangent: &Self::TangentVector, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_tangent: Option<&mut Self::JacobianMatrix>, ) -> Self
Source§fn minus(
&self,
other: &Self,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_other: Option<&mut Self::JacobianMatrix>,
) -> Self::TangentVector
fn minus( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self::TangentVector
Source§fn between(
&self,
other: &Self,
jacobian_self: Option<&mut Self::JacobianMatrix>,
jacobian_other: Option<&mut Self::JacobianMatrix>,
) -> Self
fn between( &self, other: &Self, jacobian_self: Option<&mut Self::JacobianMatrix>, jacobian_other: Option<&mut Self::JacobianMatrix>, ) -> Self
Source§fn tangent_dim(&self) -> usize
fn tangent_dim(&self) -> usize
Source§impl Tangent<SE3> for SE3Tangent
impl Tangent<SE3> for SE3Tangent
Source§fn right_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix
fn right_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix
Right Jacobian Jr.
Computes the right Jacobian matrix such that for small δφ: exp((φ + δφ)^∧) ≈ exp(φ^∧) ∘ exp((Jr δφ)^∧)
For SE(3), this involves computing Jacobians for both translation and rotation parts.
§Returns
The right Jacobian matrix (6x6)
Source§fn left_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix
fn left_jacobian(&self) -> <SE3 as LieGroup>::JacobianMatrix
Left Jacobian Jl.
Computes the left Jacobian matrix such that for small δφ: exp((φ + δφ)^∧) ≈ exp((Jl δφ)^∧) ∘ exp(φ^∧)
Following manif conventions for SE(3) left Jacobian computation.
§Returns
The left Jacobian matrix (6x6)
Source§fn right_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix
fn right_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix
Inverse of right Jacobian Jr⁻¹.
Computes the inverse of the right Jacobian. This is used for computing perturbations and derivatives.
§Numerical Conditioning Warning
This 6×6 Jacobian inverse inherits SO(3) conditioning issues plus scale effects.
Sources of numerical error:
- Embedded SO(3) rotation: (1 + cos θ) / (2θ sin θ) singularity
- Q-block coupling: rotation errors propagate to translation
- Scale amplification: large translations increase absolute error
Expected Precision:
- Small rotations (θ < 0.01): Jr * Jr⁻¹ ≈ I within ~1e-6
- Moderate rotations (θ < 0.1): Jr * Jr⁻¹ ≈ I within ~1e-4
- Larger rotations: Jr * Jr⁻¹ ≈ I within ~0.01
This is a fundamental mathematical limitation consistent with production SLAM libraries. See module documentation for references.
§Returns
The inverse right Jacobian matrix (6x6)
Source§fn left_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix
fn left_jacobian_inv(&self) -> <SE3 as LieGroup>::JacobianMatrix
Inverse of left Jacobian Jl⁻¹.
Computes the inverse of the left Jacobian following manif conventions.
§Numerical Conditioning Warning
This 6×6 Jacobian inverse has the same conditioning issues as the right Jacobian inverse.
Sources of numerical error:
- Embedded SO(3) rotation: (1 + cos θ) / (2θ sin θ) singularity
- Q-block coupling: rotation errors propagate to translation
- Scale amplification: large translations increase absolute error
Expected Precision: Same as right Jacobian inverse (see above).
This is a fundamental mathematical limitation consistent with production SLAM libraries. See module documentation for references.
§Returns
The inverse left Jacobian matrix (6x6)
Source§fn hat(&self) -> <SE3 as LieGroup>::LieAlgebra
fn hat(&self) -> <SE3 as LieGroup>::LieAlgebra
Hat operator: φ^∧ (vector to matrix).
Converts the SE(3) tangent vector to its 4x4 matrix representation in the Lie algebra. Following manif conventions, the structure is: [ theta_× rho ] [ 0 0 ] where theta_× is the skew-symmetric matrix of the rotational part.
§Returns
The 4x4 matrix representation in the SE(3) Lie algebra
Source§fn zero() -> <SE3 as LieGroup>::TangentVector
fn zero() -> <SE3 as LieGroup>::TangentVector
Zero tangent vector.
Returns the zero element of the SE(3) tangent space.
§Returns
A 6-dimensional zero vector
Source§fn random() -> <SE3 as LieGroup>::TangentVector
fn random() -> <SE3 as LieGroup>::TangentVector
Random tangent vector (useful for testing).
Generates a random tangent vector with reasonable bounds. Translation components are in [-1, 1] and rotation components in [-0.1, 0.1].
§Returns
A random 6-dimensional tangent vector
Source§fn normalize(&mut self)
fn normalize(&mut self)
Normalize the tangent vector to unit norm.
Modifies this tangent vector to have unit norm. If the vector is near zero, it remains unchanged.
Source§fn normalized(&self) -> <SE3 as LieGroup>::TangentVector
fn normalized(&self) -> <SE3 as LieGroup>::TangentVector
Return a unit tangent vector in the same direction.
Returns a new tangent vector with unit norm in the same direction. If the original vector is near zero, returns zero.
§Returns
A normalized copy of the tangent vector
Source§fn small_adj(&self) -> <SE3 as LieGroup>::JacobianMatrix
fn small_adj(&self) -> <SE3 as LieGroup>::JacobianMatrix
Small adjoint matrix for SE(3).
For SE(3), the small adjoint matrix has the structure: [ Omega V ] [ 0 Omega ] where Omega is the skew-symmetric matrix of the angular part and V is the skew-symmetric matrix of the linear part.
Source§fn lie_bracket(&self, other: &SE3Tangent) -> <SE3 as LieGroup>::TangentVector
fn lie_bracket(&self, other: &SE3Tangent) -> <SE3 as LieGroup>::TangentVector
Lie bracket for SE(3).
Computes the Lie bracket [this, other] = this.small_adj() * other.
Source§fn is_approx(&self, other: &SE3Tangent, tolerance: f64) -> bool
fn is_approx(&self, other: &SE3Tangent, tolerance: f64) -> bool
Check if this tangent vector is approximately equal to another.
§Arguments
other- The other tangent vector to compare withtolerance- The tolerance for the comparison
Source§fn is_dynamic() -> bool
fn is_dynamic() -> bool
impl StructuralPartialEq for SE3
Auto Trait Implementations§
impl Freeze for SE3
impl RefUnwindSafe for SE3
impl Send for SE3
impl Sync for SE3
impl Unpin for SE3
impl UnsafeUnpin for SE3
impl UnwindSafe for SE3
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.