Detailed Description

template<class VALUE>
class gtsam::BetweenFactor< VALUE >

A class for a measurement predicted by "between(config[key1],config[key2])".

The noise model applies to Local(measured, between(p1, p2)). For pose types using GTSAM's right-hand retraction, this means the covariance is expressed in the local frame of the second (target) pose. For Pose3, the tangent-space order is rotation followed by translation.

See gtsam/slam/doc/BetweenFactor.ipynb for a detailed discussion of coordinate frames and covariance conventions.

Template Parameters

VALUE the Value type

Inheritance diagram for gtsam::BetweenFactor< VALUE >:

Public Member Functions
gtsam::NonlinearFactor::shared_ptr	clone () const override
virtual ErrorVector	evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const =0
	The measurement.
Vector	evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const
	The measurement.
Vector	evaluateError (const ValueTypes &... x) const
	The measurement.
AreAllMatrixRefs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
	The measurement.
Standard Constructors
	BetweenFactor ()
	default constructor - only use for serialization
	BetweenFactor (Key key1, Key key2, const VALUE &measured, const SharedNoiseModel &model=nullptr)
	Constructor.
Testable
void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
	print with optional string
bool	equals (const NonlinearFactor &expected, double tol=1e-9) const override
	assert equality up to a tolerance
NoiseModelFactorN methods
ErrorVector	evaluateError (const T &p1, const T &p2, OptionalMatrixType H1, OptionalMatrixType H2) const override
	evaluate error, returns vector of errors size of tangent space
Standard interface
const VALUE &	measured () const
	return the measurement
Public Member Functions inherited from gtsam::NoiseModelFactorT< traits< VALUE >::TangentVector, VALUE, VALUE >
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.
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 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.
void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
	print
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 VALUE	T
using	ErrorVector = typename traits<VALUE>::TangentVector
typedef std::shared_ptr< BetweenFactor >	shared_ptr
Public Types inherited from gtsam::NoiseModelFactorT< traits< VALUE >::TangentVector, VALUE, VALUE >
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.

Additional Inherited Members
Static Public Attributes inherited from gtsam::NoiseModelFactorT< traits< VALUE >::TangentVector, VALUE, VALUE >
static constexpr auto	N
	N is the number of variables (N-way factor).
Protected Types inherited from gtsam::NoiseModelFactorT< traits< VALUE >::TangentVector, VALUE, VALUE >
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
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.
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 VALUE>

gtsam::NonlinearFactor::shared_ptr gtsam::BetweenFactor< VALUE >::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

◆ equals()

template<class VALUE>

bool gtsam::BetweenFactor< VALUE >::equals	(	const NonlinearFactor &	expected,
		double	tol = 1e-9 ) const

inlineoverridevirtual

assert equality up to a tolerance

Reimplemented from gtsam::NonlinearFactor.

◆ evaluateError()

template<class VALUE>

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

virtual

The measurement.

Implements gtsam::NoiseModelFactorT< traits< VALUE >::TangentVector, VALUE, VALUE >.

◆ print()

template<class VALUE>

void gtsam::BetweenFactor< VALUE >::print	(	const std::string &	s = "",
		const KeyFormatter &	keyFormatter = DefaultKeyFormatter ) const

inlineoverridevirtual

print with optional string

Reimplemented from gtsam::Factor.

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

/tmp/gtsam-4.3.0-doxygen.rsXPUS/source/gtsam/slam/BetweenFactor.h

Detailed Description

Public Member Functions

Public Types

Additional Inherited Members

Member Function Documentation

◆ clone()

◆ equals()

◆ evaluateError()

◆ print()