Detailed Description

template<class VALUE>
class gtsam::PartialPriorFactor< VALUE >

A class for a soft partial prior on any Lie type, with a mask over Expmap parameters.

Note that this will use Logmap() to find a tangent space parameterization for the variable attached, so this may fail for highly nonlinear manifolds.

The prior vector used in this factor is stored in compressed form, such that it only contains values for measurements that are to be compared, and they are in the same order as VALUE::Logmap(). The provided indices will determine which components to extract in the error function.

Template Parameters

VALUE is the type of variable the prior effects

Inheritance diagram for gtsam::PartialPriorFactor< VALUE >:

Public Member Functions
	PartialPriorFactor (Key key, size_t idx, double prior, const SharedNoiseModel &model)
	Single Element Constructor: Prior on a single parameter at index 'idx' in the tangent vector.
	PartialPriorFactor (Key key, const std::vector< size_t > &indices, const Vector &prior, const SharedNoiseModel &model)
	Indices Constructor: Specify the relevant measured indices in the tangent vector.
gtsam::NonlinearFactor::shared_ptr	clone () const override
void	print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
	implement functions needed for Testable
bool	equals (const NonlinearFactor &expected, double tol=1e-9) const override
	equals
Vector	evaluateError (const T &p, boost::optional< Matrix & > H=boost::none) const override
	implement functions needed to derive from Factor
const Vector &	prior () const
const std::vector< size_t > &	indices () const
Public Member Functions inherited from gtsam::NoiseModelFactorN< VALUE >
Key	key () const
	Returns a key.
	NoiseModelFactorN ()
	Default Constructor for I/O.
	NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)
	Constructor.
	NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)
	Constructor.
Vector	unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
	This implements the unwhitenedError virtual function by calling the n-key specific version of evaluateError, which is pure virtual so must be implemented in the derived class.
virtual Vector	evaluateError (const ValueTypes &... x, OptionalMatrix< ValueTypes >... H) const=0
	Override evaluateError to finish implementing an n-way factor.
Vector	evaluateError (const ValueTypes &... x) const
	No-Jacobians requested function overload.
Vector	evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
	Some (but not all) optional Jacobians are omitted (function overload).
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
	NoiseModelFactor ()
	Default constructor for I/O only.
	~NoiseModelFactor () override
	Destructor.
template<typename CONTAINER>
	NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
	Constructor.
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
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.
boost::shared_ptr< GaussianFactor >	linearize (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) \).
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
	Creates a shared_ptr clone of the factor with a new noise model.
	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.
double	error (const HybridValues &c) const override
	All factor types need to implement an error function.
virtual bool	active (const Values &) const
	Checks whether a factor should be used based on a set of values.
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
Public Types inherited from gtsam::NoiseModelFactorN< VALUE >
using	ValueType
	The type of the I'th template param can be obtained as ValueType.
enum
	N is the number of variables (N-way factor).
Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< This >	shared_ptr
	Noise model.
Public Types inherited from gtsam::NonlinearFactor
typedef boost::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 Types
typedef NoiseModelFactorN< VALUE >	Base
typedef PartialPriorFactor< VALUE >	This
Protected Types inherited from gtsam::NoiseModelFactorN< VALUE >
using	Base
using	This
using	OptionalMatrix
using	KeyType
using	IsConvertible
using	IndexIsValid
using	ContainerElementType
using	IsContainerOfKeys
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
	PartialPriorFactor ()
	default constructor - only use for serialization
	PartialPriorFactor (Key key, const SharedNoiseModel &model)
	constructor with just minimum requirements for a factor - allows more computation in the constructor.
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.

Protected Attributes
Vector	prior_
	Measurement on tangent space parameters, in compressed form.
std::vector< size_t >	indices_
	Indices of the measured tangent space parameters.
Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_
Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor.

Friends
class	boost::serialization::access
	Serialization function.

Additional Inherited Members
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.

Constructor & Destructor Documentation

◆ PartialPriorFactor()

template<class VALUE>

gtsam::PartialPriorFactor< VALUE >::PartialPriorFactor	(	Key	key,
		const SharedNoiseModel &	model )

inlineprotected

constructor with just minimum requirements for a factor - allows more computation in the constructor.

This should only be used by subclasses

Member Function Documentation

◆ clone()

template<class VALUE>

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

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

◆ equals()

template<class VALUE>

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

inlineoverridevirtual

equals

Reimplemented from gtsam::NoiseModelFactor.

◆ evaluateError()

template<class VALUE>

Vector gtsam::PartialPriorFactor< VALUE >::evaluateError	(	const T &	p,
		boost::optional< Matrix & >	H = boost::none ) const

inlineoverride

implement functions needed to derive from Factor

Returns a vector of errors for the measured tangent parameters.

◆ print()

template<class VALUE>

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

inlineoverridevirtual

implement functions needed for Testable

print

Reimplemented from gtsam::NoiseModelFactor.

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

/tmp/gtsam-4.2-docs.H5EUbA/src/gtsam_unstable/slam/PartialPriorFactor.h

Detailed Description

Public Member Functions

Public Types

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ PartialPriorFactor()

Member Function Documentation

◆ clone()

◆ equals()

◆ evaluateError()

◆ print()