Package: gtsam
README - Georgia Tech Smoothing and Mapping LibraryImportant NoteAs of Dec 2021, thedevelopbranch is officially in "Pre 4.2" mode. A great new feature we will be adding in 4.2 ishybrid inferencea la DCSLAM (Kevin Doherty et al) and we envision several API-breaking changes will happen in the discrete folder.In addition, features deprecated in 4.1 will be removed. Please use the last4.1.1 releaseif you need those features. However, most (not all, unfortunately) are easily converted and can be tracked down (in 4.1.1) by disabling the cmake flagGTSAM_ALLOW_DEPRECATED_SINCE_V42.What is GTSAM?GTSAM is a C++ library that implements smoothing and
mapping (SAM) in robotics and vision, using Factor Graphs and Bayes
Networks as the underlying computing paradigm rather than sparse
matrices.The current support matrix is:PlatformCompilerBuild StatusUbuntu 18.04gcc/clangmacOSclangWindowsMSVCOn top of the C++ library, GTSAM includeswrappers for MATLAB & Python.QuickstartIn the root library folder execute:#!bashmkdirbuildcdbuild
cmake..
makecheck(optional,runsunittests)makeinstallPrerequisites:Boost>= 1.65 (Ubuntu:sudo apt-get install libboost-all-dev)CMake>= 3.0 (Ubuntu:sudo apt-get install cmake)A modern compiler, i.e., at least gcc 4.7.3 on Linux.Optional prerequisites - used automatically if findable by CMake:Intel Threaded Building Blocks (TBB)(Ubuntu:sudo apt-get install libtbb-dev)Intel Math Kernel Library (MKL)(Ubuntu:installing using APT)SeeINSTALL.mdfor more installation informationNote that MKL may not provide a speedup in all cases. Make sure to benchmark your problem with and without MKL.GTSAM 4 CompatibilityGTSAM 4 introduces several new features, most notably Expressions and a Python toolbox. It also introduces traits, a C++ technique that allows optimizing with non-GTSAM types. That opens the door to retiring geometric types such as Point2 and Point3 to pure Eigen types, which we also do. A significant change which will not trigger a compile error is that zero-initializing of Point2 and Point3 is deprecated, so please be aware that this might render functions using their default constructor incorrect.There is a flagGTSAM_ALLOW_DEPRECATED_SINCE_V42for newly deprecated methods since the 4.2 release, which is on by default, allowing anyone to just pull version 4.2 and compile.WrappersWe provide support forMATLABandPythonwrappers for GTSAM. Please refer to the linked documents for more details.CitationIf you are using GTSAM for academic work, please use the following citation:@software{gtsam,author={Frank Dellaert and GTSAM Contributors},title={borglab/gtsam},month=May,year=2022,publisher={Georgia Tech Borg Lab},version={4.2a8},doi={10.5281/zenodo.5794541},url={https://github.com/borglab/gtsam)}}}To cite theFactor Graphs for Robot Perceptionbook, please use:@book{factor_graphs_for_robot_perception,author={Frank Dellaert and Michael Kaess},year={2017},title={Factor Graphs for Robot Perception},publisher={Foundations and Trends in Robotics, Vol. 6},url={http://www.cs.cmu.edu/~kaess/pub/Dellaert17fnt.pdf}}If you are using the IMU preintegration scheme, please cite:@book{imu_preintegration,author={Christian Forster and Luca Carlone and Frank Dellaert and Davide Scaramuzza},title={IMU preintegration on Manifold for Efficient Visual-Inertial Maximum-a-Posteriori Estimation},year={2015}}The Preintegrated IMU FactorGTSAM includes a state of the art IMU handling scheme based onTodd Lupton and Salah Sukkarieh,"Visual-Inertial-Aided Navigation for High-Dynamic Motion in Built Environments Without Initial Conditions", TRO, 28(1):61-76, 2012.[link]Our implementation improves on this using integration on the manifold, as detailed inLuca Carlone, Zsolt Kira, Chris Beall, Vadim Indelman, and Frank Dellaert,"Eliminating conditionally independent sets in factor graphs: a unifying perspective based on smart factors", Int. Conf. on Robotics and Automation (ICRA), 2014.[link]Christian Forster, Luca Carlone, Frank Dellaert, and Davide Scaramuzza,"IMU Preintegration on Manifold for Efficient Visual-Inertial Maximum-a-Posteriori Estimation", Robotics: Science and Systems (RSS), 2015.[link]If you are using the factor in academic work, please cite the publications above.In GTSAM 4 a new and more efficient implementation, based on integrating on the NavState tangent space and detailed inthis document, is enabled by default. To switch to the RSS 2015 version, set the flagGTSAM_TANGENT_PREINTEGRATIONto OFF.Additional InformationThere is aGTSAM users Google groupfor general discussion.Read about importantGTSAM-Conceptshere. A primer on GTSAM Expressions,
which support (superfast) automatic differentiation,
can be found on theGTSAM wiki on BitBucket.See theINSTALLfile for more detailed installation instructions.GTSAM is open source under the BSD license, see theLICENSEandLICENSE.BSDfiles.Please see theexamples/directory and theUSAGEfile for examples on how to use GTSAM.GTSAM was developed in the lab ofFrank Dellaertat theGeorgia Institute of Technology, with the help of many contributors over the years, seeTHANKS.