#include <FrobeniusFactor.h>

Inheritance diagram for gtsam::FrobeniusPrior< Rot >:

[legend]

Public Member Functions
Vector	evaluateError (const Rot &R, OptionalMatrixType H) const override
	Error is just Frobenius norm between Rot element and vectorized matrix M. More...

EIGEN_MAKE_ALIGNED_OPERATOR_NEW	FrobeniusPrior (Key j, const MatrixNN &M, const SharedNoiseModel &model=nullptr)
	Constructor. More...

Public Member Functions inherited from gtsam::NoiseModelFactorN< Rot >
Key	key () const

virtual Vector	unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const =0

Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) const

	~NoiseModelFactorN () override

	NoiseModelFactorN ()
	Default Constructor for I/O. More...

	NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)

	NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)

Vector	unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const override

virtual Vector	evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0

Vector	evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const

Vector	evaluateError (const ValueTypes &... x) const

AreAllMatrixRefs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const

AreAllMatrixPtrs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const

Key	key1 () const

Key	key2 () const

Key	key3 () const

Key	key4 () const

Key	key5 () const

Key	key6 () const

Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const

size_t	dim () const override

bool	equals (const NonlinearFactor &f, double tol=1e-9) const override

double	error (const Values &c) const override

std::shared_ptr< GaussianFactor >	linearize (const Values &x) const override

const SharedNoiseModel &	noiseModel () const
	access to the noise model More...

	NoiseModelFactor ()

template<typename CONTAINER >
	NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)

void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override

Vector	unweightedWhitenedError (const Values &c) const

Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) const

double	weight (const Values &c) const

Vector	whitenedError (const Values &c) const

	~NoiseModelFactor () override

Public Member Functions inherited from gtsam::NonlinearFactor
	NonlinearFactor ()

template<typename CONTAINER >
	NonlinearFactor (const CONTAINER &keys)

double	error (const HybridValues &c) const override

virtual bool	active (const Values &) const

virtual shared_ptr	clone () const

virtual shared_ptr	rekey (const std::map< Key, Key > &rekey_mapping) const

virtual shared_ptr	rekey (const KeyVector &new_keys) const

virtual bool	sendable () const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. More...

bool	empty () const
	Whether the factor is empty (involves zero variables). More...

Key	front () const
	First key. More...

Key	back () const
	Last key. More...

const_iterator	find (Key key) const
	find More...

const KeyVector &	keys () const
	Access the factor's involved variable keys. More...

const_iterator	begin () const

const_iterator	end () const

size_t	size () const

virtual void	printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print only keys More...

bool	equals (const This &other, double tol=1e-9) const
	check equality More...

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Private Types
enum	{ Dim = Rot::VectorN2::RowsAtCompileTime }

using	MatrixNN = typename Rot::MatrixNN

Private Attributes
Eigen::Matrix< double, Dim, 1 >	vecM_
	vectorized matrix to approximate More...

Additional Inherited Members
Public Types inherited from gtsam::NoiseModelFactorN< Rot >
enum
	N is the number of variables (N-way factor) More...

using	ValueType = typename std::tuple_element< I - 1, std::tuple< ValueTypes... > >::type

Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::NonlinearFactor
typedef std::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::Factor
typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys. More...

typedef KeyVector::iterator	iterator
	Iterator over keys. More...

Protected Types inherited from gtsam::NoiseModelFactorN< Rot >
using	Base = NoiseModelFactor

using	KeyType = Key

using	MatrixTypeT = Matrix

using	OptionalMatrixTypeT = Matrix *

using	This = NoiseModelFactorN< ValueTypes... >

using	IsConvertible = typename std::enable_if< std::is_convertible< From, To >::value, void >::type

using	IndexIsValid = typename std::enable_if<(I >=1) &&(I<=N), void >::type

using	ContainerElementType = typename std::decay< decltype(*std::declval< Container >().begin())>::type

using	IsContainerOfKeys = IsConvertible< ContainerElementType< Container >, Key >

using	AreAllMatrixRefs = std::enable_if_t<(... &&std::is_convertible< Args, Matrix & >::value), Ret >

using	IsMatrixPointer = std::is_same< typename std::decay_t< Arg >, Matrix * >

using	IsNullpointer = std::is_same< typename std::decay_t< Arg >, std::nullptr_t >

using	AreAllMatrixPtrs = std::enable_if_t<(... &&(IsMatrixPointer< Args >::value\|\|IsNullpointer< Args >::value)), Ret >

Protected Types inherited from gtsam::NoiseModelFactor
typedef NonlinearFactor	Base

typedef NoiseModelFactor	This

Protected Types inherited from gtsam::NonlinearFactor
typedef Factor	Base

typedef NonlinearFactor	This

Protected Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor (const SharedNoiseModel &noiseModel)

Protected Member Functions inherited from gtsam::Factor
	Factor ()

template<typename CONTAINER >
	Factor (const CONTAINER &keys)

template<typename ITERATOR >
	Factor (ITERATOR first, ITERATOR last)

Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)

template<typename ITERATOR >
static Factor	FromIterators (ITERATOR first, ITERATOR last)

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor. More...

Detailed Description

template<class Rot>
class gtsam::FrobeniusPrior< Rot >

FrobeniusPrior calculates the Frobenius norm between a given matrix and an element of SO(3) or SO(4).

Definition at line 51 of file FrobeniusFactor.h.

Member Typedef Documentation

◆ MatrixNN

template<class Rot >

using gtsam::FrobeniusPrior< Rot >::MatrixNN = typename Rot::MatrixNN

private

Definition at line 53 of file FrobeniusFactor.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Rot >

anonymous enum

private

Enumerator
Dim

Definition at line 52 of file FrobeniusFactor.h.

Constructor & Destructor Documentation

◆ FrobeniusPrior()

template<class Rot >

EIGEN_MAKE_ALIGNED_OPERATOR_NEW gtsam::FrobeniusPrior< Rot >::FrobeniusPrior	(	Key	j,
		const MatrixNN &	M,
		const SharedNoiseModel &	model = `nullptr`
	)

inline

Constructor.

Definition at line 64 of file FrobeniusFactor.h.

Member Function Documentation

◆ evaluateError()

template<class Rot >

Vector gtsam::FrobeniusPrior< Rot >::evaluateError	(	const Rot &	R,
		OptionalMatrixType	H
	)		const

inlineoverride

Error is just Frobenius norm between Rot element and vectorized matrix M.

Definition at line 71 of file FrobeniusFactor.h.

Member Data Documentation

◆ vecM_

template<class Rot >

Eigen::Matrix<double, Dim, 1> gtsam::FrobeniusPrior< Rot >::vecM_

private

vectorized matrix to approximate

Definition at line 54 of file FrobeniusFactor.h.

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

FrobeniusFactor.h

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class Rot> class gtsam::FrobeniusPrior< Rot >

Member Typedef Documentation

◆ MatrixNN

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FrobeniusPrior()

Member Function Documentation

◆ evaluateError()

Member Data Documentation

◆ vecM_

template<class Rot>
class gtsam::FrobeniusPrior< Rot >