Public Member Functions | Private Types | Private Attributes | List of all members
gtsam::FrobeniusPrior< Rot > Class Template Reference

#include <FrobeniusFactor.h>

Inheritance diagram for gtsam::FrobeniusPrior< Rot >:
Inheritance graph
[legend]

Public Member Functions

Vector evaluateError (const Rot &R, boost::optional< Matrix & > H=boost::none) const override
 Error is just Frobenius norm between Rot element and vectorized matrix M. More...
 
 FrobeniusPrior (Key j, const MatrixNN &M, const SharedNoiseModel &model=nullptr)
 Constructor. More...
 
- Public Member Functions inherited from gtsam::NoiseModelFactor1< Rot >
 NoiseModelFactor1 ()
 
 NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1)
 
 ~NoiseModelFactor1 () override
 
Key key () const
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 
- 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
 
boost::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 
const SharedNoiseModelnoiseModel () 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
 
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)
 
virtual ~NonlinearFactor ()
 
virtual bool active (const Values &) const
 
virtual shared_ptr clone () const
 
shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 
shared_ptr rekey (const KeyVector &new_keys) const
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor. More...
 
Key front () const
 First key. More...
 
Key back () const
 Last key. More...
 
const_iterator find (Key key) const
 find More...
 
const KeyVectorkeys () 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...
 
KeyVectorkeys ()
 
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::NoiseModelFactor1< Rot >
typedef Rot X
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::NonlinearFactor
typedef boost::shared_ptr< Thisshared_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::NoiseModelFactor1< Rot >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor1< RotThis
 
- 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)
 
bool equals (const This &other, double tol=1e-9) const
 check equality More...
 
- 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

template<class Rot>
using gtsam::FrobeniusPrior< Rot >::MatrixNN = typename Rot::MatrixNN
private

Definition at line 53 of file FrobeniusFactor.h.

Member Enumeration Documentation

template<class Rot>
anonymous enum
private
Enumerator
Dim 

Definition at line 52 of file FrobeniusFactor.h.

Constructor & Destructor Documentation

template<class Rot>
gtsam::FrobeniusPrior< Rot >::FrobeniusPrior ( Key  j,
const MatrixNN M,
const SharedNoiseModel model = nullptr 
)
inline

Constructor.

Definition at line 58 of file FrobeniusFactor.h.

Member Function Documentation

template<class Rot>
Vector gtsam::FrobeniusPrior< Rot >::evaluateError ( const Rot R,
boost::optional< Matrix & >  H = boost::none 
) const
inlineoverridevirtual

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

Implements gtsam::NoiseModelFactor1< Rot >.

Definition at line 65 of file FrobeniusFactor.h.

Member Data Documentation

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:


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:10