template<typename _Derived>
SE2Base struct
The base class of the SE2 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 Translation = typename internal::
traits<_Derived>::Translation -
using Transformation = typename internal::
traits<_Derived>::Transformation - using Isometry = Eigen::Transform<Scalar, 2, Eigen::Isometry>
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 SE2 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 SE2 element.
-
template<typename _EigenDerived>auto act(const Eigen::MatrixBase<_EigenDerived>& v, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 3>>> J_vout_m = {}, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 2>>> J_vout_v = {}) const -> Eigen::Matrix<Scalar, 2, 1>
- Rigid motion action on a 2D point.
- auto adj() const -> Jacobian
- Get the adjoint matrix of SE2 at this.
- auto transform() const -> Transformation
- Get the transformation matrix (2D isometry).
- auto isometry() const -> Isometry
- auto rotation() const -> Rotation
- Get the rotational part of this as a rotation matrix.
- auto translation() const -> Translation
- Get the translational part of this as a vector.
- auto real() const -> Scalar
- Get the real part of the underlying complex number representing the rotational part.
- auto imag() const -> Scalar
- Get the imaginary part of the underlying complex number representing the rotational part.
- auto angle() const -> Scalar
- Get the angle (rad.) of the rotational part.
- auto x() const -> Scalar
- Get the x component of the translational part.
- auto y() const -> Scalar
- Get the y component of the translational part.
- void normalize()
- Normalize the underlying complex number.
-
template<typename _EigenDerived>auto act(const Eigen::MatrixBase<_EigenDerived>& v, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 3>>> J_vout_m, tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 2>>> J_vout_v) const -> Eigen::Matrix<typename SE2Base<_Derived>::Scalar, 2, 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
Function documentation
template<typename _Derived>
LieGroup manif:: SE2Base<_Derived>:: inverse(OptJacobianRef J_minv_m = {}) const
Get the inverse of this.
template<typename _Derived>
template<typename _DerivedOther>
LieGroup manif:: SE2Base<_Derived>:: compose(const LieGroupBase<_DerivedOther>& m,
OptJacobianRef J_mc_ma = {},
OptJacobianRef J_mc_mb = {}) const
Composition of this and another SE2 element.
Parameters | |
---|---|
m in | Another SE2 element. |
J_mc_ma | |
J_mc_mb | |
Returns | The composition of 'this . m'. |
template<typename _Derived>
template<typename _EigenDerived>
Eigen::Matrix<Scalar, 2, 1> manif:: SE2Base<_Derived>:: act(const Eigen::MatrixBase<_EigenDerived>& v,
tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 3>>> J_vout_m = {},
tl::optional<Eigen::Ref<Eigen::Matrix<Scalar, 2, 2>>> J_vout_v = {}) const
Rigid motion action on a 2D point.
Parameters | |
---|---|
v | A 2D point. |
J_vout_m | |
J_vout_v | |
Returns | The transformed 2D point. |
template<typename _Derived>
Transformation manif:: SE2Base<_Derived>:: transform() const
Get the transformation matrix (2D isometry).
template<typename _Derived>
Isometry manif:: SE2Base<_Derived>:: isometry() const
Get the isometry object (Eigen 2D isometry).