gtsam  4.1.0
gtsam
gtsam::FunctorizedFactor< R, T > Class Template Reference

Detailed Description

template<typename R, typename T>
class gtsam::FunctorizedFactor< R, T >

Factor which evaluates provided unary functor and uses the result to compute error with respect to the provided measurement.

Template parameters are

Parameters
RThe return type of the functor after evaluation.
TThe argument type for the functor.

Example: Key key = Symbol('X', 0); auto model = noiseModel::Isotropic::Sigma(9, 1);

/// Functor that takes a matrix and multiplies every element by m class MultiplyFunctor { double m_; ///< simple multiplier public: MultiplyFunctor(double m) : m_(m) {} Matrix operator()(const Matrix &X, OptionalJacobian<-1, -1> H = boost::none) const { if (H) *H = m_ * Matrix::Identity(X.rows()*X.cols(), X.rows()*X.cols()); return m_ * X; } };

Matrix measurement = Matrix::Identity(3, 3); double multiplier = 2.0;

FunctorizedFactor<Matrix, Matrix> factor(keyX, measurement, model, MultiplyFunctor(multiplier));

+ Inheritance diagram for gtsam::FunctorizedFactor< R, T >:

Public Member Functions

 FunctorizedFactor ()
 default constructor - only use for serialization
 
 FunctorizedFactor (Key key, const R &z, const SharedNoiseModel &model, const std::function< R(T, boost::optional< Matrix & >)> func)
 Construct with given x and the parameters of the basis. More...
 
NonlinearFactor::shared_ptr clone () const override
 
Vector evaluateError (const T &params, boost::optional< Matrix & > H=boost::none) const override
 Override this method to finish implementing a unary factor. More...
 
Testable
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 print
 
bool equals (const NonlinearFactor &other, double tol=1e-9) const override
 Check if two factors are equal.
 
- Public Member Functions inherited from gtsam::NoiseModelFactor1< T >
 NoiseModelFactor1 ()
 Default constructor for I/O only.
 
 NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1)
 Constructor. More...
 
virtual ~NoiseModelFactor1 ()
 
Key key () const
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 Calls the 1-key specific version of evaluateError below, which is pure virtual so must be implemented in the derived class.
 
- Public Member Functions inherited from gtsam::NoiseModelFactor
 NoiseModelFactor ()
 Default constructor for I/O only.
 
virtual ~NoiseModelFactor ()
 Destructor.
 
template<typename CONTAINER >
 NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
 Constructor.
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 Print.
 
bool equals (const NonlinearFactor &f, double tol=1e-9) const override
 Check if two factors are equal.
 
size_t dim () const override
 get the dimension of the factor (number of rows on linearization)
 
const SharedNoiseModelnoiseModel () const
 access to the noise model
 
Vector whitenedError (const Values &c) const
 Vector of errors, whitened This is the raw error, i.e., i.e. More...
 
Vector unweightedWhitenedError (const Values &c) const
 Vector of errors, whitened, but unweighted by any loss function.
 
double weight (const Values &c) const
 Compute the effective weight of the factor from the noise model.
 
double error (const Values &c) const override
 Calculate the error of the factor. More...
 
boost::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 Linearize a non-linearFactorN to get a GaussianFactor, \( Ax-b \approx h(x+\delta x)-z = h(x) + A \delta x - z \) Hence \( b = z - h(x) = - \mathtt{error\_vector}(x) \).
 
- Public Member Functions inherited from gtsam::NonlinearFactor
 NonlinearFactor ()
 Default constructor for I/O only.
 
template<typename CONTAINER >
 NonlinearFactor (const CONTAINER &keys)
 Constructor from a collection of the keys involved in this factor.
 
virtual ~NonlinearFactor ()
 Destructor.
 
virtual bool active (const Values &) const
 Checks whether a factor should be used based on a set of values. More...
 
shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 Creates a shared_ptr clone of the factor with different keys using a map from old->new keys.
 
shared_ptr rekey (const KeyVector &new_keys) const
 Clones a factor and fully replaces its keys. More...
 
- Public Member Functions inherited from gtsam::Factor
Key front () const
 First key.
 
Key back () const
 Last key.
 
const_iterator find (Key key) const
 find
 
const KeyVectorkeys () const
 Access the factor's involved variable keys.
 
const_iterator begin () const
 Iterator at beginning of involved variable keys.
 
const_iterator end () const
 Iterator at end of involved variable keys.
 
size_t size () const
 
void print (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print
 
void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys
 
KeyVectorkeys ()
 
iterator begin ()
 Iterator at beginning of involved variable keys.
 
iterator end ()
 Iterator at end of involved variable keys.
 

Friends

class boost::serialization::access
 Serialization function.
 

Additional Inherited Members

- Public Types inherited from gtsam::NoiseModelFactor1< T >
typedef T X
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< Thisshared_ptr
 Noise model.
 
- Public Types inherited from gtsam::NonlinearFactor
typedef boost::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::Factor
typedef KeyVector::iterator iterator
 Iterator over keys.
 
typedef KeyVector::const_iterator const_iterator
 Const iterator over keys.
 
- Protected Types inherited from gtsam::NoiseModelFactor1< T >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor1< T > 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)
 Constructor - only for subclasses, as this does not set keys.
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 Default constructor for I/O.
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
bool equals (const This &other, double tol=1e-9) const
 check equality
 
- Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor FromKeys (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
static Factor FromIterators (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor.
 

Constructor & Destructor Documentation

◆ FunctorizedFactor()

template<typename R , typename T >
gtsam::FunctorizedFactor< R, T >::FunctorizedFactor ( Key  key,
const R &  z,
const SharedNoiseModel model,
const std::function< R(T, boost::optional< Matrix & >)>  func 
)
inline

Construct with given x and the parameters of the basis.

Parameters
keyFactor key
zMeasurement object of same type as that returned by functor
modelNoise model
funcThe instance of the functor object

Member Function Documentation

◆ clone()

template<typename R , typename T >
NonlinearFactor::shared_ptr gtsam::FunctorizedFactor< R, T >::clone ( ) const
inlineoverridevirtual
Returns
a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

◆ evaluateError()

template<typename R , typename T >
Vector gtsam::FunctorizedFactor< R, T >::evaluateError ( const T &  x,
boost::optional< Matrix & >  H = boost::none 
) const
inlineoverridevirtual

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.

Implements gtsam::NoiseModelFactor1< T >.


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