#include <NonlinearFactor.h>
Public Types | |
| typedef VALUE | X |
 Public Types inherited from gtsam::NoiseModelFactor | |
| typedef boost::shared_ptr< This > | shared_ptr |
| Public Types inherited from gtsam::NonlinearFactor | |
| typedef boost::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... | |
Public Member Functions | |
Constructors | |
| NoiseModelFactor1 () | |
| ~NoiseModelFactor1 () override | |
| Key | key () const |
| NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1) | |
NoiseModelFactor methods | |
| Vector | unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override |
Virtual methods | |
| virtual Vector | evaluateError (const X &x, boost::optional< Matrix & > H=boost::none) const =0 |
| 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< 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 |
| 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 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... | |
| KeyVector & | keys () |
| iterator | begin () |
| iterator | end () |
Protected Types | |
| typedef NoiseModelFactor | Base |
| typedef NoiseModelFactor1< VALUE > | 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 |
Private Member Functions | |
| template<class ARCHIVE > | |
| void | serialize (ARCHIVE &ar, const unsigned int) |
Friends | |
| class | boost::serialization::access |
Additional Inherited Members | |
| 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 VALUE>
class gtsam::NoiseModelFactor1< VALUE >
A convenient base class for creating your own NoiseModelFactor with 1 variable. To derive from this class, implement evaluateError().
Templated on a values structure type. The values structures are typically more general than just vectors, e.g., Rot3 or Pose3, which are objects in non-linear manifolds (Lie groups).
Definition at line 277 of file NonlinearFactor.h.
Member Typedef Documentation
|
protected |
Definition at line 286 of file NonlinearFactor.h.
|
protected |
Definition at line 287 of file NonlinearFactor.h.
| typedef VALUE gtsam::NoiseModelFactor1< VALUE >::X |
Definition at line 282 of file NonlinearFactor.h.
Constructor & Destructor Documentation
|
inline |
Default constructor for I/O only
Definition at line 294 of file NonlinearFactor.h.
|
inlineoverride |
Definition at line 296 of file NonlinearFactor.h.
|
inline |
Constructor
- Parameters
-
noiseModel shared pointer to noise model key1 by which to look up X value in Values
Definition at line 305 of file NonlinearFactor.h.
Member Function Documentation
|
pure virtual |
Override this method to finish implementing a unary factor. If the optional Matrix reference argument is specified, it should compute both the function evaluation and its derivative in X.
Implemented in gtsam::example::smallOptimize::UnaryFactor, gtsam::NonlinearEquality1< VALUE >, gtsam::Pose3AttitudeFactor, gtsam::GPSFactor2, simulated2D::GenericPrior< VALUE >, gtsam::NonlinearEquality< VALUE >, gtsam::Rot3AttitudeFactor, gtsam::TriangulationFactor< CAMERA >, gtsam::MagFactor1, gtsam::PartialPriorFactor< VALUE >, gtsam::PartialPriorFactor< PoseRTV >, gtsam::RotateDirectionsFactor, gtsam::PriorFactor< VALUE >, gtsam::simulated3D::PointPrior3D, gtsam::FunctorizedFactor< R, T >, UnaryFactor, gtsam::PosePriorFactor< POSE >, gtsam::GPSFactor, gtsam::EssentialMatrixFactor, gtsam::MagFactor, gtsam::OrientedPlane3DirectionPrior, gtsam::PoseRotationPrior< POSE >, gtsam::BoundingConstraint1< VALUE >, gtsam::FrobeniusPrior< Rot >, gtsam::PoseTranslationPrior< POSE >, gtsam::RotateFactor, and ResectioningFactor.
|
inline |
Definition at line 298 of file NonlinearFactor.h.
|
inlineprivate |
Definition at line 350 of file NonlinearFactor.h.
|
inlineoverridevirtual |
Calls the 1-key specific version of evaluateError below, which is pure virtual so must be implemented in the derived class.
Implements gtsam::NoiseModelFactor.
Definition at line 316 of file NonlinearFactor.h.
Friends And Related Function Documentation
|
friend |
Serialization function
Definition at line 348 of file NonlinearFactor.h.
The documentation for this class was generated from the following file: