#include <BasisFactors.h>

Inheritance diagram for gtsam::VectorEvaluationFactor< BASIS >:

[legend]

Public Member Functions
	VectorEvaluationFactor ()

	VectorEvaluationFactor (Key key, const Vector &z, const SharedNoiseModel &model, const size_t M, const size_t N, double x)
	Construct a new VectorEvaluationFactor object. More...

	VectorEvaluationFactor (Key key, const Vector &z, const SharedNoiseModel &model, const size_t M, const size_t N, double x, double a, double b)
	Construct a new VectorEvaluationFactor object. More...

virtual	~VectorEvaluationFactor ()

Public Member Functions inherited from gtsam::FunctorizedFactor< Vector, Matrix >
NonlinearFactor::shared_ptr	clone () const override

Vector	evaluateError (const Matrix &params, OptionalMatrixType H) const override

	FunctorizedFactor ()

	FunctorizedFactor (Key key, const Vector &z, const SharedNoiseModel &model, const std::function< Vector(Matrix, OptionalMatrixType)> func)

	~FunctorizedFactor () override

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

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

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

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

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

Additional Inherited Members
Public Types inherited from gtsam::NoiseModelFactorN< Matrix >
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...

Static Public Attributes inherited from gtsam::NoiseModelFactorN< Matrix >
constexpr static auto	N
	N is the number of variables (N-way factor) More...

Protected Types inherited from gtsam::NoiseModelFactorN< Matrix >
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 BASIS>
class gtsam::VectorEvaluationFactor< BASIS >

Unary factor for enforcing BASIS polynomial evaluation on a parameter Matrix of size (M, N) is equal to a vector-valued measurement at the same point, when using a pseudo-spectral parameterization.

This factors tries to enforce the basis function evaluation f(x;p) to take on the value z at location x, providing a gradient on the parameters p. In a probabilistic estimation context, z is known as a measurement, and the parameterized basis function can be seen as a measurement prediction function.

Parameters

BASIS The basis class to use e.g. Chebyshev2

Definition at line 94 of file BasisFactors.h.

Member Typedef Documentation

◆ Base

template<class BASIS >

using gtsam::VectorEvaluationFactor< BASIS >::Base = FunctorizedFactor<Vector, Matrix>

private

Definition at line 96 of file BasisFactors.h.

Constructor & Destructor Documentation

◆ VectorEvaluationFactor() [1/3]

template<class BASIS >

gtsam::VectorEvaluationFactor< BASIS >::VectorEvaluationFactor ( )

inline

Definition at line 99 of file BasisFactors.h.

◆ VectorEvaluationFactor() [2/3]

template<class BASIS >

gtsam::VectorEvaluationFactor< BASIS >::VectorEvaluationFactor	(	Key	key,
		const Vector &	z,
		const SharedNoiseModel &	model,
		const size_t	M,
		const size_t	N,
		double	x
	)

inline

Construct a new VectorEvaluationFactor object.

Parameters

key	The key to the parameter Matrix object used to represent the polynomial.
z	The measurement value.
model	The noise model.
M	Size of the evaluated state vector.
N	The degree of the polynomial.
x	The point at which to evaluate the basis polynomial.

Definition at line 112 of file BasisFactors.h.

◆ VectorEvaluationFactor() [3/3]

template<class BASIS >

gtsam::VectorEvaluationFactor< BASIS >::VectorEvaluationFactor	(	Key	key,
		const Vector &	z,
		const SharedNoiseModel &	model,
		const size_t	M,
		const size_t	N,
		double	x,
		double	a,
		double	b
	)

inline

Construct a new VectorEvaluationFactor object.

Parameters

key	The key to the parameter Matrix object used to represent the polynomial.
z	The measurement value.
model	The noise model.
M	Size of the evaluated state vector.
N	The degree of the polynomial.
x	The point at which to evaluate the basis polynomial.
a	Lower bound for the polynomial.
b	Upper bound for the polynomial.

Definition at line 130 of file BasisFactors.h.

◆ ~VectorEvaluationFactor()

template<class BASIS >

virtual gtsam::VectorEvaluationFactor< BASIS >::~VectorEvaluationFactor ( )

inlinevirtual

Definition at line 136 of file BasisFactors.h.

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

BasisFactors.h

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

template<class BASIS> class gtsam::VectorEvaluationFactor< BASIS >

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ VectorEvaluationFactor() [1/3]

◆ VectorEvaluationFactor() [2/3]

◆ VectorEvaluationFactor() [3/3]

◆ ~VectorEvaluationFactor()

template<class BASIS>
class gtsam::VectorEvaluationFactor< BASIS >