template<typename _Derived>
manif::SO3Base struct

The base class of the SO3 group.

Base classes

template<class _Derived>
struct LieGroupBase<_Derived>
Base class for Lie groups. Defines the minimum common API.

Public types

using Rotation = typename internal::traits<_Derived>::Rotation
using Transformation = typename internal::traits<_Derived>::Transformation
using QuaternionDataType = Eigen::Quaternion<Scalar>

Public functions

auto inverse(OptJacobianRef J_minv_m = {}) const -> LieGroup
Get the inverse of this.
auto log(OptJacobianRef J_t_m = {}) const -> Tangent
Get the SO3 corresponding Lie algebra element in vector form.
auto lift(OptJacobianRef J_t_m = {}) const -> MANIF_DEPRECATED Tangent
This function is deprecated. Please considere using log instead.
template<typename _DerivedOther>
auto compose(const LieGroupBase<_DerivedOther>& m, OptJacobianRef J_mc_ma = {}, OptJacobianRef J_mc_mb = {}) const -> LieGroup
Composition of this and another SO3 element.
template<typename _EigenDerived>
auto act(const Eigen::MatrixBase<_EigenDerived>& v, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_m = {}, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_v = {}) const -> Eigen::Matrix<Scalar, 3, 1>
Rotation action on a 3-vector.
auto adj() const -> Jacobian
Get the adjoint of SO3 at this.
auto transform() const -> Transformation
Get the transformation matrix (3D isometry).
auto rotation() const -> Rotation
Get a rotation matrix.
auto x() const -> Scalar
Get the x component of the quaternion.
auto y() const -> Scalar
Get the y component of the quaternion.
auto z() const -> Scalar
Get the z component of the quaternion.
auto w() const -> Scalar
Get the w component of the quaternion.
auto quat() const -> QuaternionDataType
Get quaternion.
void normalize()
Normalize the underlying quaternion.
void quat(const QuaternionDataType& quaternion)
Set the rotational as a quaternion.
template<typename _EigenDerived>
void quat(const Eigen::MatrixBase<_EigenDerived>& quaternion)
Set the rotational as a quaternion.
template<typename _EigenDerived>
auto act(const Eigen::MatrixBase<_EigenDerived>& v, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_m, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_v) const -> Eigen::Matrix<typename SO3Base<_Derived>::Scalar, 3, 1>
auto coeffs() -> DataType&
Access the underlying data by const reference.
auto coeffs() const -> const DataType&
Access the underlying data by const reference.

Protected functions

auto derived() & -> _Derived& noexcept
auto derived() const & -> const _Derived& noexcept

Function documentation

template<typename _Derived>
LieGroup manif::SO3Base<_Derived>::inverse(OptJacobianRef J_minv_m = {}) const

Get the inverse of this.

template<typename _Derived>
Tangent manif::SO3Base<_Derived>::log(OptJacobianRef J_t_m = {}) const

Get the SO3 corresponding Lie algebra element in vector form.

Returns The SO3 tangent of this.

template<typename _Derived> template<typename _DerivedOther>
LieGroup manif::SO3Base<_Derived>::compose(const LieGroupBase<_DerivedOther>& m, OptJacobianRef J_mc_ma = {}, OptJacobianRef J_mc_mb = {}) const

Composition of this and another SO3 element.

Parameters
m in Another SO3 element.
J_mc_ma
J_mc_mb
Returns The composition of 'this . m'.

template<typename _Derived> template<typename _EigenDerived>
Eigen::Matrix<Scalar, 3, 1> manif::SO3Base<_Derived>::act(const Eigen::MatrixBase<_EigenDerived>& v, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_m = {}, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 3, 3>>> J_vout_v = {}) const

Rotation action on a 3-vector.

Parameters
v A 2-vector.
J_vout_m
J_vout_v
Returns The rotated 3-vector.

template<typename _Derived>
Jacobian manif::SO3Base<_Derived>::adj() const

Get the adjoint of SO3 at this.

template<typename _Derived>
Transformation manif::SO3Base<_Derived>::transform() const

Get the transformation matrix (3D isometry).

template<typename _Derived>
void manif::SO3Base<_Derived>::quat(const QuaternionDataType& quaternion)

Set the rotational as a quaternion.

Parameters
quaternion a unitary quaternion

template<typename _Derived> template<typename _EigenDerived>
void manif::SO3Base<_Derived>::quat(const Eigen::MatrixBase<_EigenDerived>& quaternion)

Set the rotational as a quaternion.

Parameters
quaternion an Eigen::Vector representing a unitary quaternion