gtsam::ReferenceFrameFactor< POINT, TRANSFORM > Class Template Reference

Detailed Description

template<class POINT, class TRANSFORM>
class gtsam::ReferenceFrameFactor< POINT, TRANSFORM >

A constraint between two landmarks in separate maps Templated on: Point : Type of landmark Transform : Transform variable class.

The transform is defined as transforming global to local: l = lTg * g

The Point and Transform concepts must be Lie types, and the transform relationship "Point = transformFrom(Transform, Point)" must exist.

To implement this function in new domains, specialize a new version of Point transform_point<Transform,Point>(transform, global, Dtrans, Dglobal) to use the correct point and transform types.

This base class should be specialized to implement the cost function for specific classes of landmarks

Inheritance diagram for gtsam::ReferenceFrameFactor< POINT, TRANSFORM >:

Public Member Functions
	ReferenceFrameFactor (Key globalKey, Key transKey, Key localKey, const noiseModel::Base::shared_ptr &model)
	General constructor with arbitrary noise model (constrained or otherwise).
	ReferenceFrameFactor (double mu, Key globalKey, Key transKey, Key localKey)
	Construct a hard frame of reference reference constraint with equal mu values for each degree of freedom.
	ReferenceFrameFactor (Key globalKey, Key transKey, Key localKey, double sigma=1e-2)
	Simple soft constraint constructor for frame of reference, with equal weighting for each degree of freedom.
NonlinearFactor::shared_ptr	clone () const override
	Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses.
ErrorVector	evaluateError (const Point &_global, const Transform &trans, const Point &local, OptionalMatrixType Dforeign, OptionalMatrixType Dtrans, OptionalMatrixType Dlocal) const override
	Combined cost and derivative function using boost::optional.
void	print (const std::string &s="", const gtsam::KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
	Print.
Key	global_key () const
Key	transform_key () const
Key	local_key () const
virtual OutputVec	evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0
	Override evaluateError to finish implementing an n-way factor.
Vector	evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const
	If all the optional arguments are matrices then redirect the call to the one which takes pointers.
Vector	evaluateError (const ValueTypes &... x) const
	No-Jacobians requested function overload.
template<typename... OptionalJacArgs, typename = IndexIsValid<sizeof...(OptionalJacArgs) + 1>>
AreAllMatrixRefs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
	Some (but not all) optional Jacobians are omitted (function overload) and the jacobians are l-value references to matrices.
Public Member Functions inherited from gtsam::NoiseModelFactorT< traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >
Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) const
	support taking in the actual vector instead of the pointer as well to get access to this version of the function from derived classes one will need to use the "using" keyword and specify that like this: public: using NoiseModelFactor::unwhitenedError;
Key	key () const
	Returns a key.
	NoiseModelFactorT ()
	Default Constructor for I/O.
Key	key1 () const
Key	key2 () const
Key	key3 () const
Key	key4 () const
Key	key5 () const
Key	key6 () const
std::shared_ptr< GaussianFactor >	linearize (const Values &values) const override
	Linearize factors whose error and argument dimensions are all fixed to an arbitrary-arity FixedJacobianFactor.
Public Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor ()
	Default constructor for I/O only.
	~NoiseModelFactor () override
	Destructor.
template<typename CONTAINER>
	NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
	Constructor.
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 SharedNoiseModel &	noiseModel () const
	access to the noise model
virtual Vector	unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const =0
	Error function without the NoiseModel, \( z-h(x) \).
Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) const
	support taking in the actual vector instead of the pointer as well to get access to this version of the function from derived classes one will need to use the "using" keyword and specify that like this: public: using NoiseModelFactor::unwhitenedError;
Vector	whitenedError (const Values &c) const
	Vector of errors, whitened This is the raw error, i.e., i.e.
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.
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
	Creates a shared_ptr clone of the factor with a new noise model.
double	error (const HybridValues &c) const override
	All factor types need to implement an error function.
	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.
double	error (const HybridValues &c) const override
	All factor types need to implement an error function.
virtual bool	active (const Values &c) const
	Checks whether a factor should be used based on a set of values.
virtual void	qcqpFactors (NonlinearFactorGraph *costs, NonlinearEqualityConstraints *constraints, size_t columnDimension=1) const
	Add this factor's QCQP cost and constraints over matrix-valued QCQP variables with the given column dimension.
virtual 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.
virtual shared_ptr	rekey (const KeyVector &new_keys) const
	Clones a factor and fully replaces its keys.
virtual bool	sendable () const
	Should the factor be evaluated in the same thread as the caller This is to enable factors that has shared states (like the Python GIL lock).
Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor.
bool	empty () const
	Whether the factor is empty (involves zero variables).
Key	front () const
	First key.
Key	back () const
	Last key.
const_iterator	find (Key key) const
	find
const KeyVector &	keys () 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
virtual void	printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print only keys
bool	equals (const This &other, double tol=1e-9) const
	check equality
KeyVector &	keys ()
iterator	begin ()
	Iterator at beginning of involved variable keys.
iterator	end ()
	Iterator at end of involved variable keys.

Public Types
typedef NoiseModelFactorT< typename traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >	Base
using	ErrorVector = typename traits<POINT>::TangentVector
typedef ReferenceFrameFactor< POINT, TRANSFORM >	This
typedef POINT	Point
typedef TRANSFORM	Transform
Public Types inherited from gtsam::NoiseModelFactorT< traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >
using	ValueType
	The type of the I'th template param can be obtained as ValueType.
Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< This >	shared_ptr
	Noise model.
Public Types inherited from gtsam::NonlinearFactor
typedef std::shared_ptr< This >	shared_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 Member Functions
	ReferenceFrameFactor ()
	default constructor for serialization only
Protected Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor (const SharedNoiseModel &noiseModel)
	Constructor - only for subclasses, as this does not set keys.
	Factor ()
	Default constructor for I/O.
template<typename CONTAINER>
	Factor (const CONTAINER &keys)
	Construct factor from container of keys.
template<typename ITERATOR>
	Factor (ITERATOR first, ITERATOR last)
	Construct factor from iterator keys.

Additional Inherited Members
Static Public Attributes inherited from gtsam::NoiseModelFactorT< traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >
static constexpr auto	N
	N is the number of variables (N-way factor).
Protected Types inherited from gtsam::NoiseModelFactorT< traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >
using	Base
using	This
using	OptionalMatrixTypeT
using	KeyType
using	MatrixTypeT
using	IsConvertible
using	IndexIsValid
using	ContainerElementType
using	IsContainerOfKeys
using	AreAllMatrixRefs
	A helper alias to check if a list of args are all references to a matrix or not.
using	IsMatrixPointer
using	IsNullpointer
using	AreAllMatrixPtrs
	A helper alias to check if a list of args are all pointers to a matrix or not.
Protected Types inherited from gtsam::NoiseModelFactor
typedef NonlinearFactor	Base
typedef NoiseModelFactor	This
Protected Types inherited from gtsam::NonlinearFactor
typedef Factor	Base
typedef NonlinearFactor	This
template<typename CONTAINER>
static Factor	FromKeys (const CONTAINER &keys)
	Construct factor from container of keys.
template<typename ITERATOR>
static Factor	FromIterators (ITERATOR first, ITERATOR last)
	Construct factor from iterator keys.
Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_
Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor.

Member Function Documentation

clone()

template<class POINT, class TRANSFORM>

NonlinearFactor::shared_ptr gtsam::ReferenceFrameFactor< POINT, TRANSFORM >::clone ( ) const

inlineoverridevirtual

Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses.

By default, throws exception if subclass does not implement the function.

Reimplemented from gtsam::NonlinearFactor.

evaluateError() [1/4]

template<class POINT, class TRANSFORM>

Vector gtsam::NoiseModelFactorT< OutputVec, ValueTypes >::evaluateError ( const ValueTypes &... x ) const

inline

No-Jacobians requested function overload.

This specializes the version below to avoid recursive calls since this is commonly used.

e.g. const Vector error = factor.evaluateError(pose, point);

evaluateError() [2/4]

template<class POINT, class TRANSFORM>

Vector gtsam::NoiseModelFactorT< OutputVec, ValueTypes >::evaluateError ( const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H ) const

inline

If all the optional arguments are matrices then redirect the call to the one which takes pointers.

To get access to this version of the function from derived classes one will need to use the "using" keyword and specify that like this: public: using NoiseModelFactorT<list the value types here>::evaluateError;

evaluateError() [3/4]

template<class POINT, class TRANSFORM>

template<typename... OptionalJacArgs, typename = IndexIsValid<sizeof...(OptionalJacArgs) + 1>>

AreAllMatrixRefs< Vector, OptionalJacArgs... > gtsam::NoiseModelFactorT< OutputVec, ValueTypes >::evaluateError ( const ValueTypes &... x, OptionalJacArgs &&... H ) const

inline

Some (but not all) optional Jacobians are omitted (function overload) and the jacobians are l-value references to matrices.

e.g. const Vector error = factor.evaluateError(pose, point, Hpose);

evaluateError() [4/4]

template<class POINT, class TRANSFORM>

virtual OutputVec gtsam::NoiseModelFactorT< OutputVec, ValueTypes >::evaluateError ( const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H ) const

virtual

Override evaluateError to finish implementing an n-way factor.

Both the x and H arguments are written here as parameter packs, but when overriding this method, you probably want to explicitly write them out. For example, for a 2-way factor with variable types Pose3 and Point3, you should implement:

Vector evaluateError(
    const Pose3& x1, const Point3& x2,
    OptionalMatrixType H1 = OptionalNone,
    OptionalMatrixType H2 = OptionalNone) const override { ... }

If any of the optional Matrix reference arguments are specified, it should compute both the function evaluation and its derivative(s) in the requested variables.

Parameters

	x	The values of the variables to evaluate the error for. Passed in as separate arguments.
[out]	H	The Jacobian with respect to each variable (optional).

Implements gtsam::NoiseModelFactorT< traits< POINT >::TangentVector, POINT, TRANSFORM, POINT >.

print()

template<class POINT, class TRANSFORM>

void gtsam::ReferenceFrameFactor< POINT, TRANSFORM >::print ( const std::string & s = "", const gtsam::KeyFormatter & keyFormatter = DefaultKeyFormatter ) const

inlineoverridevirtual

Print.

Reimplemented from gtsam::NoiseModelFactor.

---

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

• /tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/slam/ReferenceFrameFactor.h