#include <PosePriorFactor.h>

Inheritance diagram for gtsam::PosePriorFactor< POSE >:

[legend]

Public Types
typedef std::shared_ptr< PosePriorFactor< POSE > >	shared_ptr
	shorthand for a smart pointer to a factor More...

Public Types inherited from gtsam::NoiseModelFactorN< POSE >
enum
	N is the number of variables (N-way factor) More...

using	ValueType = typename std::tuple_element< I - 1, std::tuple< ValueTypes... > >::type

Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::NonlinearFactor
typedef std::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
gtsam::NonlinearFactor::shared_ptr	clone () const override

bool	equals (const NonlinearFactor &expected, double tol=1e-9) const override

Vector	evaluateError (const POSE &p, OptionalMatrixType H) const override

	PosePriorFactor ()

	PosePriorFactor (Key key, const POSE &prior, const SharedNoiseModel &model, std::optional< POSE > body_P_sensor={})

void	print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override

const POSE &	prior () const

	~PosePriorFactor () override

Public Member Functions inherited from gtsam::NoiseModelFactorN< POSE >
Key	key () const

	~NoiseModelFactorN () override

	NoiseModelFactorN ()
	Default Constructor for I/O. More...

	NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)

	NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)

Vector	unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const override

virtual Vector	evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0

Vector	evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const

Vector	evaluateError (const ValueTypes &... x) const

AreAllMatrixRefs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const

AreAllMatrixPtrs< Vector, OptionalJacArgs... >	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const

Key	key1 () const

Key	key2 () const

Key	key3 () const

Key	key4 () const

Key	key5 () const

Key	key6 () const

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

std::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)

Vector	unweightedWhitenedError (const Values &c) const

Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) 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)

double	error (const HybridValues &c) const override

virtual bool	active (const Values &) const

virtual shared_ptr	rekey (const std::map< Key, Key > &rekey_mapping) const

virtual shared_ptr	rekey (const KeyVector &new_keys) const

virtual bool	sendable () const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. More...

bool	empty () const
	Whether the factor is empty (involves zero variables). 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...

bool	equals (const This &other, double tol=1e-9) const
	check equality More...

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Private Types
typedef NoiseModelFactorN< POSE >	Base

typedef PosePriorFactor< POSE >	This

Private Attributes
std::optional< POSE >	body_P_sensor_
	The pose of the sensor in the body frame. More...

POSE	prior_

Additional Inherited Members
Protected Types inherited from gtsam::NoiseModelFactorN< POSE >
using	Base = NoiseModelFactor

using	KeyType = Key

using	MatrixTypeT = Matrix

using	OptionalMatrixTypeT = Matrix *

using	This = NoiseModelFactorN< ValueTypes... >

using	IsConvertible = typename std::enable_if< std::is_convertible< From, To >::value, void >::type

using	IndexIsValid = typename std::enable_if<(I >=1) &&(I<=N), void >::type

using	ContainerElementType = typename std::decay< decltype(*std::declval< Container >().begin())>::type

using	IsContainerOfKeys = IsConvertible< ContainerElementType< Container >, Key >

using	AreAllMatrixRefs = std::enable_if_t<(... &&std::is_convertible< Args, Matrix &>::value), Ret >

using	IsMatrixPointer = std::is_same< typename std::decay_t< Arg >, Matrix *>

using	IsNullpointer = std::is_same< typename std::decay_t< Arg >, std::nullptr_t >

using	AreAllMatrixPtrs = std::enable_if_t<(... &&(IsMatrixPointer< Args >::value\|\|IsNullpointer< Args >::value)), Ret >

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)

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 POSE>
class gtsam::PosePriorFactor< POSE >

A class for a soft prior on any Value type

Definition at line 29 of file PosePriorFactor.h.

Member Typedef Documentation

◆ Base

template<class POSE >

typedef NoiseModelFactorN<POSE> gtsam::PosePriorFactor< POSE >::Base

private

Definition at line 34 of file PosePriorFactor.h.

◆ shared_ptr

template<class POSE >

typedef std::shared_ptr<PosePriorFactor<POSE> > gtsam::PosePriorFactor< POSE >::shared_ptr

shorthand for a smart pointer to a factor

Definition at line 48 of file PosePriorFactor.h.

◆ This

template<class POSE >

typedef PosePriorFactor<POSE> gtsam::PosePriorFactor< POSE >::This

private

Definition at line 33 of file PosePriorFactor.h.

Constructor & Destructor Documentation

◆ PosePriorFactor() [1/2]

template<class POSE >

gtsam::PosePriorFactor< POSE >::PosePriorFactor ( )

inline

default constructor - only use for serialization

Definition at line 51 of file PosePriorFactor.h.

◆ ~PosePriorFactor()

template<class POSE >

gtsam::PosePriorFactor< POSE >::~PosePriorFactor ( )

inlineoverride

Definition at line 53 of file PosePriorFactor.h.

◆ PosePriorFactor() [2/2]

template<class POSE >

gtsam::PosePriorFactor< POSE >::PosePriorFactor	(	Key	key,
		const POSE &	prior,
		const SharedNoiseModel &	model,
		std::optional< POSE >	body_P_sensor = `{}`
	)

inline

Constructor

Definition at line 56 of file PosePriorFactor.h.

Member Function Documentation

◆ clone()

template<class POSE >

gtsam::NonlinearFactor::shared_ptr gtsam::PosePriorFactor< POSE >::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 62 of file PosePriorFactor.h.

◆ equals()

template<class POSE >

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

inlineoverridevirtual

equals

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 78 of file PosePriorFactor.h.

◆ evaluateError()

template<class POSE >

Vector gtsam::PosePriorFactor< POSE >::evaluateError	(	const POSE &	p,
		OptionalMatrixType	H
	)		const

inlineoverride

implement functions needed to derive from Factor vector of errors

Definition at line 89 of file PosePriorFactor.h.

◆ print()

template<class POSE >

void gtsam::PosePriorFactor< POSE >::print	(	const std::string &	s,
		const KeyFormatter &	keyFormatter = `DefaultKeyFormatter`
	)		const

inlineoverridevirtual

implement functions needed for Testable print

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 69 of file PosePriorFactor.h.

◆ prior()

template<class POSE >

const POSE& gtsam::PosePriorFactor< POSE >::prior ( ) const

inline

Definition at line 100 of file PosePriorFactor.h.

Member Data Documentation

◆ body_P_sensor_

template<class POSE >

std::optional<POSE> gtsam::PosePriorFactor< POSE >::body_P_sensor_

private

The pose of the sensor in the body frame.

The measurement

Definition at line 37 of file PosePriorFactor.h.

◆ prior_

template<class POSE >

POSE gtsam::PosePriorFactor< POSE >::prior_

private

Definition at line 36 of file PosePriorFactor.h.

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

PosePriorFactor.h

Public Types

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class POSE> class gtsam::PosePriorFactor< POSE >

Member Typedef Documentation

◆ Base

◆ shared_ptr

◆ This

Constructor & Destructor Documentation

◆ PosePriorFactor() [1/2]

◆ ~PosePriorFactor()

◆ PosePriorFactor() [2/2]

Member Function Documentation

◆ clone()

◆ equals()

◆ evaluateError()

◆ print()

◆ prior()

Member Data Documentation

◆ body_P_sensor_

◆ prior_

template<class POSE>
class gtsam::PosePriorFactor< POSE >