#include <InvDepthFactorVariant1.h>

Inheritance diagram for gtsam::InvDepthFactorVariant1:

[legend]

Public Types
typedef NoiseModelFactor2< Pose3, Vector6 >	Base
	shorthand for base class type More...

typedef std::shared_ptr< This >	shared_ptr
	shorthand for a smart pointer to a factor More...

typedef InvDepthFactorVariant1	This
	shorthand for this class More...

Public Types inherited from gtsam::NoiseModelFactorN< Pose3, Vector6 >
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
const Cal3_S2::shared_ptr	calibration () const

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

Vector	evaluateError (const Pose3 &pose, const Vector6 &landmark, OptionalMatrixType H1, OptionalMatrixType H2) const override
	Evaluate error h(x)-z and optionally derivatives. More...

const Point2 &	imagePoint () const

	InvDepthFactorVariant1 ()
	Default constructor. More...

	InvDepthFactorVariant1 (const Key poseKey, const Key landmarkKey, const Point2 &measured, const Cal3_S2::shared_ptr &K, const SharedNoiseModel &model)

Vector	inverseDepthError (const Pose3 &pose, const Vector6 &landmark) const

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

	~InvDepthFactorVariant1 () override

Public Member Functions inherited from gtsam::NoiseModelFactorN< Pose3, Vector6 >
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 ()

Protected Attributes
Cal3_S2::shared_ptr	K_
	shared pointer to calibration object More...

Point2	measured_
	2D measurement More...

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor. More...

Additional Inherited Members
Protected Types inherited from gtsam::NoiseModelFactorN< Pose3, Vector6 >
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)

Detailed Description

Binary factor representing a visual measurement using an inverse-depth parameterization

Definition at line 25 of file InvDepthFactorVariant1.h.

Member Typedef Documentation

◆ Base

typedef NoiseModelFactor2<Pose3, Vector6> gtsam::InvDepthFactorVariant1::Base

shorthand for base class type

Definition at line 35 of file InvDepthFactorVariant1.h.

◆ shared_ptr

typedef std::shared_ptr<This> gtsam::InvDepthFactorVariant1::shared_ptr

shorthand for a smart pointer to a factor

Definition at line 44 of file InvDepthFactorVariant1.h.

◆ This

typedef InvDepthFactorVariant1 gtsam::InvDepthFactorVariant1::This

shorthand for this class

Definition at line 41 of file InvDepthFactorVariant1.h.

Constructor & Destructor Documentation

◆ InvDepthFactorVariant1() [1/2]

gtsam::InvDepthFactorVariant1::InvDepthFactorVariant1 ( )

inline

Default constructor.

Definition at line 47 of file InvDepthFactorVariant1.h.

◆ InvDepthFactorVariant1() [2/2]

gtsam::InvDepthFactorVariant1::InvDepthFactorVariant1	(	const Key	poseKey,
		const Key	landmarkKey,
		const Point2 &	measured,
		const Cal3_S2::shared_ptr &	K,
		const SharedNoiseModel &	model
	)

inline

Constructor

Parameters

poseKey	is the index of the camera pose
pointKey	is the index of the landmark
measured	is the 2 dimensional location of point in image (the measurement)
K	shared pointer to the constant calibration
model	is the standard deviation

Definition at line 59 of file InvDepthFactorVariant1.h.

◆ ~InvDepthFactorVariant1()

gtsam::InvDepthFactorVariant1::~InvDepthFactorVariant1 ( )

inlineoverride

Virtual destructor

Definition at line 64 of file InvDepthFactorVariant1.h.

Member Function Documentation

◆ calibration()

const Cal3_S2::shared_ptr gtsam::InvDepthFactorVariant1::calibration ( ) const

inline

return the calibration object

Definition at line 130 of file InvDepthFactorVariant1.h.

◆ equals()

bool gtsam::InvDepthFactorVariant1::equals	(	const NonlinearFactor &	p,
		double	tol = `1e-9`
	)		const

inlineoverridevirtual

equals

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 78 of file InvDepthFactorVariant1.h.

◆ evaluateError()

Vector gtsam::InvDepthFactorVariant1::evaluateError	(	const Pose3 &	pose,
		const Vector6 &	landmark,
		OptionalMatrixType	H1,
		OptionalMatrixType	H2
	)		const

inlineoverride

Evaluate error h(x)-z and optionally derivatives.

Definition at line 106 of file InvDepthFactorVariant1.h.

◆ imagePoint()

const Point2& gtsam::InvDepthFactorVariant1::imagePoint ( ) const

inline

return the measurement

Definition at line 125 of file InvDepthFactorVariant1.h.

◆ inverseDepthError()

Vector gtsam::InvDepthFactorVariant1::inverseDepthError	(	const Pose3 &	pose,
		const Vector6 &	landmark
	)		const

inline

Definition at line 86 of file InvDepthFactorVariant1.h.

◆ print()

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

inlineoverridevirtual

print

Parameters

s	optional string naming the factor
keyFormatter	optional formatter useful for printing Symbols

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 71 of file InvDepthFactorVariant1.h.

Member Data Documentation

◆ K_

Cal3_S2::shared_ptr gtsam::InvDepthFactorVariant1::K_

protected

shared pointer to calibration object

Definition at line 30 of file InvDepthFactorVariant1.h.

◆ measured_

Point2 gtsam::InvDepthFactorVariant1::measured_

protected

2D measurement

Definition at line 29 of file InvDepthFactorVariant1.h.

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

InvDepthFactorVariant1.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ shared_ptr

◆ This

Constructor & Destructor Documentation

◆ InvDepthFactorVariant1() [1/2]

◆ InvDepthFactorVariant1() [2/2]

◆ ~InvDepthFactorVariant1()

Member Function Documentation

◆ calibration()

◆ equals()

◆ evaluateError()

◆ imagePoint()

◆ inverseDepthError()

◆ print()

Member Data Documentation

◆ K_

◆ measured_