gtsam::NonlinearISAM Class Reference

#include <NonlinearISAM.h>

Collaboration diagram for gtsam::NonlinearISAM:

Public Member Functions
Standard Constructors
	NonlinearISAM (int reorderInterval=1, const GaussianFactorGraph::Eliminate &eliminationFunction=GaussianFactorGraph::EliminationTraitsType::DefaultEliminate)
Standard Interface
Values	estimate () const
Matrix	marginalCovariance (Key key) const
const GaussianISAM &	bayesTree () const
const Values &	getLinearizationPoint () const
const NonlinearFactorGraph &	getFactorsUnsafe () const
int	reorderInterval () const
	TODO: comment. More...
int	reorderCounter () const
	TODO: comment.
void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
void	printStats () const
void	saveGraph (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
Advanced Interface
void	update (const NonlinearFactorGraph &newFactors, const Values &initialValues)
void	reorder_relinearize ()

Protected Attributes
gtsam::GaussianISAM	isam_
Values	linPoint_
NonlinearFactorGraph	factors_
int	reorderInterval_
int	reorderCounter_
GaussianFactorGraph::Eliminate	eliminationFunction_

Detailed Description

Wrapper class to manage ISAM in a nonlinear context

Constructor & Destructor Documentation

NonlinearISAM()

gtsam::NonlinearISAM::NonlinearISAM ( int  reorderInterval = 1, const GaussianFactorGraph::Eliminate &  eliminationFunction = GaussianFactorGraph::EliminationTraitsType::DefaultEliminate  )

inline

Periodically reorder and relinearize

Parameters

reorderInterval

is the number of updates between reorderings, 0 never reorders (and is dangerous for memory consumption) 1 (default) reorders every time, in worse case is batch every update typical values are 50 or 100

Member Function Documentation

bayesTree()

const GaussianISAM& gtsam::NonlinearISAM::bayesTree ( ) const

inline

access the underlying bayes tree

estimate()

Values gtsam::NonlinearISAM::estimate

(

)

const

Return the current solution estimate

getFactorsUnsafe()

const NonlinearFactorGraph& gtsam::NonlinearISAM::getFactorsUnsafe ( ) const

inline

get underlying nonlinear graph

getLinearizationPoint()

const Values& gtsam::NonlinearISAM::getLinearizationPoint ( ) const

inline

Return the current linearization point

marginalCovariance()

Matrix gtsam::NonlinearISAM::marginalCovariance

(

Key

key

)

const

find the marginal covariance for a single variable

print()

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

prints out all contents of the system

printStats()

void gtsam::NonlinearISAM::printStats

(

)

const

prints out clique statistics

reorder_relinearize()

void gtsam::NonlinearISAM::reorder_relinearize

(

)

Relinearization and reordering of variables

reorderInterval()

int gtsam::NonlinearISAM::reorderInterval ( ) const

inline

TODO: comment.

get counters

saveGraph()

void gtsam::NonlinearISAM::saveGraph	(	const std::string &	s,
		const KeyFormatter &	keyFormatter = DefaultKeyFormatter
	)		const

saves the Tree to a text file in GraphViz format

update()

void gtsam::NonlinearISAM::update	(	const NonlinearFactorGraph &	newFactors,
		const Values &	initialValues
	)

Add new factors along with their initial linearization points

Member Data Documentation

eliminationFunction_

GaussianFactorGraph::Eliminate gtsam::NonlinearISAM::eliminationFunction_

protected

The elimination function

factors_

NonlinearFactorGraph gtsam::NonlinearISAM::factors_

protected

The original factors, used when relinearizing

isam_

gtsam::GaussianISAM gtsam::NonlinearISAM::isam_

protected

The internal iSAM object

linPoint_

Values gtsam::NonlinearISAM::linPoint_

protected

The current linearization point

reorderInterval_

int gtsam::NonlinearISAM::reorderInterval_

protected

The reordering interval and counter

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/gtsam-jlblanco-docs/checkouts/latest/gtsam/nonlinear/NonlinearISAM.h