#include <MagFactor.h>

Inheritance diagram for gtsam::MagFactor1:

[legend]

Public Member Functions
NonlinearFactor::shared_ptr	clone () const override

Vector	evaluateError (const Rot3 &nRb, boost::optional< Matrix & > H=boost::none) const override
	vector of errors More...

	MagFactor1 (Key key, const Point3 &measured, double scale, const Unit3 &direction, const Point3 &bias, const SharedNoiseModel &model)

Public Member Functions inherited from gtsam::NoiseModelFactor1< Rot3 >
	NoiseModelFactor1 ()

	NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1)

	~NoiseModelFactor1 () override

Key	key () const

Vector	unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override

Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const

size_t	dim () const override

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

double	error (const Values &c) const override

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

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

Vector	unweightedWhitenedError (const Values &c) 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)

virtual	~NonlinearFactor ()

virtual bool	active (const Values &) const

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

shared_ptr	rekey (const KeyVector &new_keys) const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. 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...

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Private Attributes
const Point3	bias_
	bias More...

const Point3	measured_
	The measured magnetometer values. More...

const Point3	nM_
	Local magnetic field (mag output units) More...

Additional Inherited Members
Public Types inherited from gtsam::NoiseModelFactor1< Rot3 >
typedef Rot3	X

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

Public Types inherited from gtsam::NonlinearFactor
typedef boost::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...

Protected Types inherited from gtsam::NoiseModelFactor1< Rot3 >
typedef NoiseModelFactor	Base

typedef NoiseModelFactor1< Rot3 >	This

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)

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

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

Factor to estimate rotation given magnetometer reading This version uses model measured bM = scale * bRn * direction + bias and assumes scale, direction, and the bias are given

Definition at line 88 of file MagFactor.h.

Constructor & Destructor Documentation

gtsam::MagFactor1::MagFactor1	(	Key	key,
		const Point3 &	measured,
		double	scale,
		const Unit3 &	direction,
		const Point3 &	bias,
		const SharedNoiseModel &	model
	)

inline

Constructor

Definition at line 97 of file MagFactor.h.

Member Function Documentation

NonlinearFactor::shared_ptr gtsam::MagFactor1::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 105 of file MagFactor.h.

Vector gtsam::MagFactor1::evaluateError	(	const Rot3 &	nRb,
		boost::optional< Matrix & >	H = `boost::none`
	)		const

inlineoverridevirtual

vector of errors

Implements gtsam::NoiseModelFactor1< Rot3 >.

Definition at line 113 of file MagFactor.h.

Member Data Documentation

const Point3 gtsam::MagFactor1::bias_

private

bias

Definition at line 92 of file MagFactor.h.

const Point3 gtsam::MagFactor1::measured_

private

The measured magnetometer values.

Definition at line 90 of file MagFactor.h.

const Point3 gtsam::MagFactor1::nM_

private

Local magnetic field (mag output units)

Definition at line 91 of file MagFactor.h.

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

MagFactor.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation