farm-ng-core
sophus::SpiralSimilarity2< TScalar > Class Template Reference

#include <spiral_similarity2.h>

Inheritance diagram for sophus::SpiralSimilarity2< TScalar >:
Collaboration diagram for sophus::SpiralSimilarity2< TScalar >:

Public Types

using Scalar = TScalar
 
using Base = lie::Group< SpiralSimilarity2, TScalar, lie::SpiralSimilarity2Impl >
 
using Rotation = Rotation2< Scalar >
 
using Tangent = typename Base::Tangent
 
using Params = typename Base::Params
 
using Point = typename Base::Point
 

Public Member Functions

 SpiralSimilarity2 ()=default
 
 SpiralSimilarity2 (UninitTag)
 
 SpiralSimilarity2 (Rotation2< Scalar > const &rotation, Scalar scale=1.0)
 
template<class TOtherScalar >
auto cast () const -> SpiralSimilarity2< TOtherScalar >
 
auto rotation () const
 
auto rotationMatrix () const -> Eigen::Matrix2< Scalar >
 
void setRotation (Rotation rot)
 
auto scale () const -> Scalar
 
void setScale (Scalar scale)
 
auto angle () const -> Scalar
 
auto complex () const -> Complex< Scalar >
 
auto setComplex (Complex< Scalar > const &z) const -> void
 

Static Public Member Functions

static auto fromComplex (Complex< Scalar > const &z) -> SpiralSimilarity2
 
static auto fromRotationMatrix (Eigen::Matrix2< Scalar > const &mat_r) -> SpiralSimilarity2
 
static auto fromAngle (Scalar theta) -> SpiralSimilarity2
 
static auto fromScale (Scalar scale) -> SpiralSimilarity2
 

Member Typedef Documentation

◆ Base

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Base = lie::Group<SpiralSimilarity2, TScalar, lie::SpiralSimilarity2Impl>

◆ Params

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Params = typename Base::Params

◆ Point

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Point = typename Base::Point

◆ Rotation

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Rotation = Rotation2<Scalar>

◆ Scalar

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Scalar = TScalar

◆ Tangent

template<class TScalar >
using sophus::SpiralSimilarity2< TScalar >::Tangent = typename Base::Tangent

Constructor & Destructor Documentation

◆ SpiralSimilarity2() [1/3]

template<class TScalar >
sophus::SpiralSimilarity2< TScalar >::SpiralSimilarity2 ( )
default

◆ SpiralSimilarity2() [2/3]

template<class TScalar >
sophus::SpiralSimilarity2< TScalar >::SpiralSimilarity2 ( UninitTag  )
inlineexplicit

◆ SpiralSimilarity2() [3/3]

template<class TScalar >
sophus::SpiralSimilarity2< TScalar >::SpiralSimilarity2 ( Rotation2< Scalar > const &  rotation,
Scalar  scale = 1.0 
)
inline

Member Function Documentation

◆ angle()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::angle ( ) const -> Scalar
inline

◆ cast()

template<class TScalar >
template<class TOtherScalar >
auto sophus::SpiralSimilarity2< TScalar >::cast ( ) const -> SpiralSimilarity2<TOtherScalar>
inline

◆ complex()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::complex ( ) const -> Complex<Scalar>
inline

◆ fromAngle()

template<class TScalar >
static auto sophus::SpiralSimilarity2< TScalar >::fromAngle ( Scalar  theta) -> SpiralSimilarity2
inlinestatic

◆ fromComplex()

template<class TScalar >
static auto sophus::SpiralSimilarity2< TScalar >::fromComplex ( Complex< Scalar > const &  z) -> SpiralSimilarity2
inlinestatic

◆ fromRotationMatrix()

template<class TScalar >
static auto sophus::SpiralSimilarity2< TScalar >::fromRotationMatrix ( Eigen::Matrix2< Scalar > const &  mat_r) -> SpiralSimilarity2
inlinestatic

◆ fromScale()

template<class TScalar >
static auto sophus::SpiralSimilarity2< TScalar >::fromScale ( Scalar  scale) -> SpiralSimilarity2
inlinestatic

◆ rotation()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::rotation ( ) const
inline

◆ rotationMatrix()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::rotationMatrix ( ) const -> Eigen::Matrix2<Scalar>
inline

◆ scale()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::scale ( ) const -> Scalar
inline

◆ setComplex()

template<class TScalar >
auto sophus::SpiralSimilarity2< TScalar >::setComplex ( Complex< Scalar > const &  z) const -> void
inline

◆ setRotation()

template<class TScalar >
void sophus::SpiralSimilarity2< TScalar >::setRotation ( Rotation  rot)
inline

◆ setScale()

template<class TScalar >
void sophus::SpiralSimilarity2< TScalar >::setScale ( Scalar  scale)
inline

The documentation for this class was generated from the following file: