Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
gtsam::PoseTranslationPrior< POSE > Class Template Reference

#include <PoseTranslationPrior.h>

Inheritance diagram for gtsam::PoseTranslationPrior< POSE >:
Inheritance graph
[legend]

Public Types

typedef NoiseModelFactor1< POSE > Base
 
typedef POSE Pose
 
typedef POSE::Rotation Rotation
 
typedef PoseTranslationPrior< POSE > This
 
typedef POSE::Translation Translation
 
- Public Types inherited from gtsam::NoiseModelFactor1< POSE >
typedef POSE 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...
 

Public Member Functions

gtsam::NonlinearFactor::shared_ptr clone () const override
 
bool equals (const NonlinearFactor &expected, double tol=1e-9) const override
 
Vector evaluateError (const Pose &pose, boost::optional< Matrix & > H=boost::none) const override
 
const Translationmeasured () const
 
 PoseTranslationPrior ()
 
 PoseTranslationPrior (Key key, const Translation &measured, const noiseModel::Base::shared_ptr &model)
 
 PoseTranslationPrior (Key key, const POSE &pose_z, const noiseModel::Base::shared_ptr &model)
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 
 ~PoseTranslationPrior () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactor1< POSE >
 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
 
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)
 
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
 
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 ()
 

Protected Attributes

Translation measured_
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor. More...
 

Private Member Functions

template<class ARCHIVE >
void serialize (ARCHIVE &ar, const unsigned int)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactor1< POSE >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor1< POSE > This
 
- 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)
 

Detailed Description

template<class POSE>
class gtsam::PoseTranslationPrior< POSE >

A prior on the translation part of a pose

Definition at line 21 of file PoseTranslationPrior.h.

Member Typedef Documentation

template<class POSE>
typedef NoiseModelFactor1<POSE> gtsam::PoseTranslationPrior< POSE >::Base

Definition at line 24 of file PoseTranslationPrior.h.

template<class POSE>
typedef POSE gtsam::PoseTranslationPrior< POSE >::Pose

Definition at line 25 of file PoseTranslationPrior.h.

template<class POSE>
typedef POSE::Rotation gtsam::PoseTranslationPrior< POSE >::Rotation

Definition at line 27 of file PoseTranslationPrior.h.

template<class POSE>
typedef PoseTranslationPrior<POSE> gtsam::PoseTranslationPrior< POSE >::This

Definition at line 23 of file PoseTranslationPrior.h.

template<class POSE>
typedef POSE::Translation gtsam::PoseTranslationPrior< POSE >::Translation

Definition at line 26 of file PoseTranslationPrior.h.

Constructor & Destructor Documentation

template<class POSE>
gtsam::PoseTranslationPrior< POSE >::PoseTranslationPrior ( )
inline

default constructor - only use for serialization

Definition at line 40 of file PoseTranslationPrior.h.

template<class POSE>
gtsam::PoseTranslationPrior< POSE >::PoseTranslationPrior ( Key  key,
const Translation measured,
const noiseModel::Base::shared_ptr model 
)
inline

standard constructor

Definition at line 43 of file PoseTranslationPrior.h.

template<class POSE>
gtsam::PoseTranslationPrior< POSE >::PoseTranslationPrior ( Key  key,
const POSE &  pose_z,
const noiseModel::Base::shared_ptr model 
)
inline

Constructor that pulls the translation from an incoming POSE

Definition at line 48 of file PoseTranslationPrior.h.

template<class POSE>
gtsam::PoseTranslationPrior< POSE >::~PoseTranslationPrior ( )
inlineoverride

Definition at line 52 of file PoseTranslationPrior.h.

Member Function Documentation

template<class POSE>
gtsam::NonlinearFactor::shared_ptr gtsam::PoseTranslationPrior< POSE >::clone ( ) const
inlineoverridevirtual
Returns
a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 57 of file PoseTranslationPrior.h.

template<class POSE>
bool gtsam::PoseTranslationPrior< POSE >::equals ( const NonlinearFactor expected,
double  tol = 1e-9 
) const
inlineoverridevirtual

equals specialized to this factor

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 77 of file PoseTranslationPrior.h.

template<class POSE>
Vector gtsam::PoseTranslationPrior< POSE >::evaluateError ( const Pose pose,
boost::optional< Matrix & >  H = boost::none 
) const
inlineoverridevirtual

h(x)-z

Implements gtsam::NoiseModelFactor1< POSE >.

Definition at line 62 of file PoseTranslationPrior.h.

template<class POSE>
const Translation& gtsam::PoseTranslationPrior< POSE >::measured ( ) const
inline

Definition at line 54 of file PoseTranslationPrior.h.

template<class POSE>
void gtsam::PoseTranslationPrior< POSE >::print ( const std::string &  s = "",
const KeyFormatter keyFormatter = DefaultKeyFormatter 
) const
inlineoverridevirtual

print contents

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 83 of file PoseTranslationPrior.h.

template<class POSE>
template<class ARCHIVE >
void gtsam::PoseTranslationPrior< POSE >::serialize ( ARCHIVE &  ar,
const unsigned  int 
)
inlineprivate

Definition at line 93 of file PoseTranslationPrior.h.

Friends And Related Function Documentation

template<class POSE>
friend class boost::serialization::access
friend

Serialization function

Definition at line 91 of file PoseTranslationPrior.h.

Member Data Documentation

template<class POSE>
Translation gtsam::PoseTranslationPrior< POSE >::measured_
protected

Definition at line 35 of file PoseTranslationPrior.h.


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


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