#include <similarity3.h>

Inheritance diagram for sophus::Similarity3< TScalar >:

Collaboration diagram for sophus::Similarity3< TScalar >:

Public Types
using	Scalar = TScalar

using	Base = lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >

using	Rotation = Rotation3< Scalar >

using	SpiralSimilarity = SpiralSimilarity3< Scalar >

using	Isometry = Isometry3< Scalar >

using	Tangent = typename Base::Tangent

using	Params = typename Base::Params

using	Point = typename Base::Point

Public Types inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
using	Scalar = TScalar

using	Impl = lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct< TScalar >

using	ScalarReturn = typename Eigen::ScalarBinaryOpTraits< Scalar, TCompatibleScalar >::ReturnType

using	Derived = Similarity3< Scalar >

using	DerivedReturn = Similarity3< ScalarReturn< TCompatibleScalar > >

using	PointReturn = Eigen::Vector< ScalarReturn< TCompatibleScalar >, kPointDim >

using	UnitVectorReturn = UnitVector< ScalarReturn< TCompatibleScalar >, kPointDim >

using	Tangent = Eigen::Vector< Scalar, kDof >

using	Params = Eigen::Vector< Scalar, kNumParams >

using	Point = Eigen::Vector< Scalar, kPointDim >

Public Member Functions
	Similarity3 ()=default

	Similarity3 (UninitTag)

	Similarity3 (Eigen::Vector< Scalar, 3 > const &translation, SpiralSimilarity const &scaled_rotation)

	Similarity3 (Rotation const &rotation)

	Similarity3 (SpiralSimilarity const &scaled_rotation)

	Similarity3 (Isometry const &isometry)

	Similarity3 (Eigen::Vector< Scalar, 3 > const &translation, Rotation const &rotation)

	Similarity3 (Eigen::Vector< Scalar, 3 > const &translation, Rotation const &rotation, Scalar scale)

	Similarity3 (Rotation const &rotation, Scalar scale)

	Similarity3 (Eigen::Vector< Scalar, 3 > const &translation)

template<class TOtherScalar >
auto	cast () const -> Similarity3< TOtherScalar >

auto	translation () -> Eigen::VectorBlock< Params, 3 >

auto	translation () const -> Eigen::VectorBlock< Params const, 3 >

auto	rotation () const

void	setRotation (Rotation const &rotation)

auto	rotationMatrix () const -> Eigen::Matrix3< Scalar >

auto	spiralSimilarity () const

auto	setSpiralSimilarity (SpiralSimilarity3< Scalar > const &rotation)

auto	scale () const -> Scalar

void	setScale (Scalar scale)

auto	setQuaternion (Quaternion< Scalar > const &z) const -> void

auto	quaternion () const -> Quaternion< Scalar >

Public Member Functions inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
	Group ()

	Group (Group const &)=default

auto	operator= (Group const &) -> Group &=default

auto	log () const -> Tangent

auto	hasShortestPathAmbiguity () -> bool

auto	operator* (Similarity3< TCompatibleScalar > const &rhs) const -> DerivedReturn< TCompatibleScalar >

auto	operator* (Eigen::MatrixBase< TMatrixDerived > const &point) const -> PointReturn< typename TMatrixDerived::Scalar >

auto	operator* (UnitVector< TCompatibleScalar, kPointDim > const &direction_vector) const -> UnitVectorReturn< TCompatibleScalar >

auto	operator*= (Derived const &rhs) -> Derived &

auto	inverse () const -> Derived

auto	adj () const -> Eigen::Matrix< Scalar, kDof, kDof >

auto	leftPlus (Tangent const &tangent) const -> Derived

auto	rightPlus (Tangent const &tangent) const -> Derived

auto	leftMinus (Derived const &other) const -> Tangent

auto	rightMinus (Derived const &other) const -> Tangent

auto	compactMatrix () const -> Eigen::Matrix< Scalar, kPointDim, kAmbientDim >

auto	matrix () const -> Eigen::Matrix< Scalar, kAmbientDim, kAmbientDim >

auto	dxThisMulExpXAt0 () const -> Eigen::Matrix< Scalar, kNumParams, kDof >

auto	dxLogThisInvTimesXAtThis () const -> Eigen::Matrix< Scalar, kDof, kNumParams >

auto	params () const -> Params const &

auto	ptr () const

auto	unsafeMutPtr ()

void	setParams (Params const &params)

Static Public Member Functions
static auto	fromRotationMatrix (Eigen::Matrix3< Scalar > const &mat_r) -> Similarity3

static auto	fromQuaternion (Quaternion< Scalar > const &q) -> Similarity3

static auto	fromScale (Scalar const &scale) -> Similarity3

template<class TT0 , class TT1 , class TT2 >
static auto	fromT (TT0 const &x, TT1 const &y, TT2 const &z) -> Similarity3
	Construct a translation only Isometry3 instance. More...

static auto	fromTx (Scalar const &x) -> Similarity3
	Construct x-axis translation. More...

static auto	fromTy (Scalar const &y) -> Similarity3
	Construct y-axis translation. More...

static auto	fromTz (Scalar const &z) -> Similarity3
	Construct z-axis translation. More...

static auto	fromRx (Scalar const &x) -> Similarity3
	Construct x-axis rotation. More...

static auto	fromRy (Scalar const &y) -> Similarity3
	Construct y-axis rotation. More...

static auto	fromRz (Scalar const &z) -> Similarity3
	Construct z-axis rotation. More...

Static Public Member Functions inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
static auto	fromParams (Params const &params) -> Derived

static auto	identity () -> Derived

static auto	exp (Tangent const &tangent) -> Derived

static auto	hat (Tangent const &tangent) -> Eigen::Matrix< Scalar, kAmbientDim, kAmbientDim >

static auto	vee (Eigen::Matrix< Scalar, kAmbientDim, kAmbientDim > const &mat) -> Tangent

static auto	toAmbient (Point const &point)

static auto	ad (Tangent const &tangent) -> Eigen::Matrix< Scalar, kDof, kDof >

static auto	dxExpXAt0 () -> Eigen::Matrix< Scalar, kNumParams, kDof >

static auto	dxExpXTimesPointAt0 (Point const &point) -> Eigen::Matrix< Scalar, kPointDim, kDof >

static auto	tangentExamples () -> std::vector< Tangent >

static auto	paramsExamples () -> std::vector< Params >

static auto	elementExamples () -> std::vector< Derived >

static auto	invalidParamsExamples () -> std::vector< Params >

Additional Inherited Members
Static Public Attributes inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
static constexpr bool	kIsOriginPreserving

static constexpr bool	kIsAxisDirectionPreserving

static constexpr bool	kIsDirectionVectorPreserving

static constexpr bool	kIsShapePreserving

static constexpr bool	kIisSizePreserving

static constexpr bool	kIisParallelLinePreserving

static constexpr int	kDof

static constexpr int	kNumParams

static constexpr int	kPointDim

static constexpr int	kAmbientDim

Protected Member Functions inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
	Group (UninitTag)

auto	self () -> Derived &

auto	self () const -> Derived const &

void	setParamsUnchecked (Params const &params)

Static Protected Member Functions inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
static auto	fromParamsUnchecked (Params const &params) -> Derived

Protected Attributes inherited from sophus::lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup< 3, lie::SpiralSimilarity3Impl >::SemiDirectProduct >
Params	params_

Member Typedef Documentation

◆ Base

template<class TScalar >

using sophus::Similarity3< TScalar >::Base = lie::Group< Similarity3, TScalar, lie::WithDimAndSubgroup<3, lie::SpiralSimilarity3Impl>:: SemiDirectProduct>

◆ Isometry

template<class TScalar >

using sophus::Similarity3< TScalar >::Isometry = Isometry3<Scalar>

◆ Params

template<class TScalar >

using sophus::Similarity3< TScalar >::Params = typename Base::Params

◆ Point

template<class TScalar >

using sophus::Similarity3< TScalar >::Point = typename Base::Point

◆ Rotation

template<class TScalar >

using sophus::Similarity3< TScalar >::Rotation = Rotation3<Scalar>

◆ Scalar

template<class TScalar >

using sophus::Similarity3< TScalar >::Scalar = TScalar

◆ SpiralSimilarity

template<class TScalar >

using sophus::Similarity3< TScalar >::SpiralSimilarity = SpiralSimilarity3<Scalar>

◆ Tangent

template<class TScalar >

using sophus::Similarity3< TScalar >::Tangent = typename Base::Tangent

Constructor & Destructor Documentation

◆ Similarity3() [1/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( )

default

◆ Similarity3() [2/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( UninitTag )

inlineexplicit

◆ Similarity3() [3/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3	(	Eigen::Vector< Scalar, 3 > const &	translation,
		SpiralSimilarity const &	scaled_rotation
	)

inline

◆ Similarity3() [4/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( Rotation const & rotation )

inline

◆ Similarity3() [5/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( SpiralSimilarity const & scaled_rotation )

inline

◆ Similarity3() [6/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( Isometry const & isometry )

inline

◆ Similarity3() [7/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3	(	Eigen::Vector< Scalar, 3 > const &	translation,
		Rotation const &	rotation
	)

inline

◆ Similarity3() [8/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3	(	Eigen::Vector< Scalar, 3 > const &	translation,
		Rotation const &	rotation,
		Scalar	scale
	)

inline

◆ Similarity3() [9/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3	(	Rotation const &	rotation,
		Scalar	scale
	)

inline

◆ Similarity3() [10/10]

template<class TScalar >

sophus::Similarity3< TScalar >::Similarity3 ( Eigen::Vector< Scalar, 3 > const & translation )

inline

Member Function Documentation

◆ cast()

template<class TScalar >

template<class TOtherScalar >

auto sophus::Similarity3< TScalar >::cast ( ) const -> Similarity3<TOtherScalar>

inline

◆ fromQuaternion()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromQuaternion ( Quaternion< Scalar > const & q ) -> Similarity3

inlinestatic

◆ fromRotationMatrix()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromRotationMatrix ( Eigen::Matrix3< Scalar > const & mat_r ) -> Similarity3

inlinestatic

◆ fromRx()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromRx ( Scalar const & x ) -> Similarity3

inlinestatic

Construct x-axis rotation.

◆ fromRy()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromRy ( Scalar const & y ) -> Similarity3

inlinestatic

Construct y-axis rotation.

◆ fromRz()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromRz ( Scalar const & z ) -> Similarity3

inlinestatic

Construct z-axis rotation.

◆ fromScale()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromScale ( Scalar const & scale ) -> Similarity3

inlinestatic

◆ fromT()

template<class TScalar >

template<class TT0 , class TT1 , class TT2 >

static auto sophus::Similarity3< TScalar >::fromT	(	TT0 const &	x,
		TT1 const &	y,
		TT2 const &	z
	)		-> Similarity3

inlinestatic

Construct a translation only Isometry3 instance.

◆ fromTx()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromTx ( Scalar const & x ) -> Similarity3

inlinestatic

Construct x-axis translation.

◆ fromTy()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromTy ( Scalar const & y ) -> Similarity3

inlinestatic

Construct y-axis translation.

◆ fromTz()

template<class TScalar >

static auto sophus::Similarity3< TScalar >::fromTz ( Scalar const & z ) -> Similarity3

inlinestatic

Construct z-axis translation.

◆ quaternion()

template<class TScalar >

auto sophus::Similarity3< TScalar >::quaternion ( ) const -> Quaternion<Scalar>

inline

◆ rotation()

template<class TScalar >

auto sophus::Similarity3< TScalar >::rotation ( ) const

inline

◆ rotationMatrix()

template<class TScalar >

auto sophus::Similarity3< TScalar >::rotationMatrix ( ) const -> Eigen::Matrix3<Scalar>

inline

◆ scale()

template<class TScalar >

auto sophus::Similarity3< TScalar >::scale ( ) const -> Scalar

inline

◆ setQuaternion()

template<class TScalar >

auto sophus::Similarity3< TScalar >::setQuaternion ( Quaternion< Scalar > const & z ) const -> void

inline

◆ setRotation()

template<class TScalar >

void sophus::Similarity3< TScalar >::setRotation ( Rotation const & rotation )

inline

◆ setScale()

template<class TScalar >

void sophus::Similarity3< TScalar >::setScale ( Scalar scale )

inline

◆ setSpiralSimilarity()

template<class TScalar >

auto sophus::Similarity3< TScalar >::setSpiralSimilarity ( SpiralSimilarity3< Scalar > const & rotation )

inline

◆ spiralSimilarity()

template<class TScalar >

auto sophus::Similarity3< TScalar >::spiralSimilarity ( ) const

inline

◆ translation() [1/2]

template<class TScalar >

auto sophus::Similarity3< TScalar >::translation ( ) -> Eigen::VectorBlock<Params, 3>

inline

◆ translation() [2/2]

template<class TScalar >

auto sophus::Similarity3< TScalar >::translation ( ) const -> Eigen::VectorBlock<Params const, 3>

inline

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

projects/farm-ng-core/cpp/sophus/lie/similarity3.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Base

◆ Isometry

◆ Params

◆ Point

◆ Rotation

◆ Scalar

◆ SpiralSimilarity

◆ Tangent

Constructor & Destructor Documentation

◆ Similarity3() [1/10]

◆ Similarity3() [2/10]

◆ Similarity3() [3/10]

◆ Similarity3() [4/10]

◆ Similarity3() [5/10]

◆ Similarity3() [6/10]

◆ Similarity3() [7/10]

◆ Similarity3() [8/10]

◆ Similarity3() [9/10]

◆ Similarity3() [10/10]

Member Function Documentation

◆ cast()

◆ fromQuaternion()

◆ fromRotationMatrix()

◆ fromRx()

◆ fromRy()

◆ fromRz()

◆ fromScale()

◆ fromT()

◆ fromTx()

◆ fromTy()

◆ fromTz()

◆ quaternion()

◆ rotation()

◆ rotationMatrix()

◆ scale()

◆ setQuaternion()

◆ setRotation()

◆ setScale()

◆ setSpiralSimilarity()

◆ spiralSimilarity()

◆ translation() [1/2]

◆ translation() [2/2]