template class Eigen::Map<sophus::RxSo2<TScalar>, kOptions>

Overview

Specialization of Eigen::Map for RxSo2; derived from RxSo2Base. More…

#include <rxso2.h>

template <class TScalar, int kOptions>
class Map<sophus::RxSo2<TScalar>, kOptions>: public sophus::RxSo2Base {
public:
    // typedefs

    using Scalar = TScalar ;
    using Transformation = typename Base::Transformation ;
    using Point = typename Base::Point ;
    using HomogeneousPoint = typename Base::HomogeneousPoint ;
    using Tangent = typename Base::Tangent ;
    using Adjoint = typename Base::Adjoint ;

    // construction

    Map(Scalar* coeffs);

    // methods

    SOPHUS_FUNC Map<Eigen::Vector2<Scalar>, kOptions> const& complex() const;

protected:
    // fields

    Map<Eigen::Vector2<Scalar>, kOptions> complex_;

    // methods

    SOPHUS_FUNC Map<Eigen::Vector2<Scalar>, kOptions>& mutComplex();
};

Inherited Members

public:
    // typedefs

    using Scalar = typename Eigen::internal::traits<TDerived>::Scalar ;
    using ComplexType = typename Eigen::internal::traits<TDerived>::ComplexType ;
    using ComplexTemporaryType = Eigen::Matrix<Scalar, 2, 1, kOptions> ;
    using Transformation = Eigen::Matrix<Scalar, kMatrixDim, kMatrixDim> ;
    using Point = Eigen::Vector2<Scalar> ;
    using HomogeneousPoint = Eigen::Vector3<Scalar> ;
    using Line = Eigen::ParametrizedLine<Scalar, 2> ;
    using Hyperplane = Eigen::Hyperplane<Scalar, 2> ;
    using Tangent = Eigen::Vector<Scalar, kDoF> ;
    using Adjoint = Eigen::Matrix<Scalar, kDoF, kDoF> ;
    using ReturnScalar = typename Eigen::ScalarBinaryOpTraits<Scalar, typename TOtherDerived::Scalar>::ReturnType ;
    using RxSo2Product = RxSo2<ReturnScalar<TOtherDerived>> ;
    using PointProduct = Eigen::Vector2<ReturnScalar<TPointDerived>> ;
    using HomogeneousPointProduct = Eigen::Vector3<ReturnScalar<THPointDerived>> ;

    // fields

    static constexpr int kOptions = Eigen::internal::traits<TDerived>::kOptions;
    static constexpr int kDoF = 2;
    static constexpr int kNumParameters = 2;
    static constexpr int kMatrixDim = 2;
    static constexpr int kPointDim = 2;

    // methods

    SOPHUS_FUNC Adjoint adj() const;
    SOPHUS_FUNC Scalar angle() const;

    template <class TNewScalarType>
    SOPHUS_FUNC RxSo2<TNewScalarType> cast() const;

    SOPHUS_FUNC Scalar* data();
    SOPHUS_FUNC Scalar const* data() const;
    SOPHUS_FUNC RxSo2<Scalar> inverse() const;
    SOPHUS_FUNC Tangent log() const;
    SOPHUS_FUNC Transformation matrix() const;

    template <class TOtherDerived>
    SOPHUS_FUNC RxSo2Base<TDerived>& operator=(RxSo2Base<TOtherDerived> const& other);

    template <class TOtherDerived>
    SOPHUS_FUNC RxSo2Product<TOtherDerived> operator*(RxSo2Base<TOtherDerived> const& other) const;

    template <
        typename TPointDerived,
        typename = typename std::enable_if<IsFixedSizeVector<TPointDerived, 2>::value>::type
        >
    SOPHUS_FUNC PointProduct<TPointDerived> operator*(Eigen::MatrixBase<TPointDerived> const& p) const;

    template <
        typename THPointDerived,
        typename = typename std::enable_if<IsFixedSizeVector<THPointDerived, 3>::value>::type
        >
    SOPHUS_FUNC HomogeneousPointProduct<THPointDerived> operator*(Eigen::MatrixBase<THPointDerived> const& p) const;

    SOPHUS_FUNC Line operator*(Line const& l) const;
    SOPHUS_FUNC Hyperplane operator*(Hyperplane const& p) const;

    template <
        typename TOtherDerived,
        typename = typename std::enable_if<std::is_same<Scalar, ReturnScalar<TOtherDerived>>::value>::type
        >
    SOPHUS_FUNC RxSo2Base<TDerived>& operator*=(RxSo2Base<TOtherDerived> const& other);

    SOPHUS_FUNC Eigen::Matrix<Scalar, kNumParameters, kDoF> dxThisMulExpXAt0() const;
    SOPHUS_FUNC Eigen::Matrix<Scalar, kDoF, kNumParameters> dxLogThisInvTimesXAtThis() const;
    SOPHUS_FUNC Eigen::Vector<Scalar, kNumParameters> params() const;
    SOPHUS_FUNC void setComplex(Eigen::Vector2<Scalar> const& z);
    SOPHUS_FUNC ComplexType const& complex() const;
    SOPHUS_FUNC Transformation rotationMatrix() const;
    SOPHUS_FUNC Scalar scale() const;
    SOPHUS_FUNC void setAngle(Scalar const& theta);
    SOPHUS_FUNC void setRotationMatrix(Transformation const& mat_r);
    SOPHUS_FUNC void setScale(Scalar const& scale);
    SOPHUS_FUNC void setScaledRotationMatrix(Transformation const& mat_scaled_rot);
    SOPHUS_FUNC void setSO2(So2<Scalar> const& so2);
    SOPHUS_FUNC So2<Scalar> so2() const;

Detailed Documentation

Specialization of Eigen::Map for RxSo2; derived from RxSo2Base.

Allows us to wrap RxSo2 objects around POD array (e.g. external z style complex).

Methods

SOPHUS_FUNC Map<Eigen::Vector2<Scalar>, kOptions> const& complex() const

Accessor of complex.