Skip to content
GTSAM is a library of C++ classes that implement smoothing and mapping (SAM) in robotics and vision, using factor graphs and Bayes networks as the underlying computing paradigm rather than sparse matrices.
C++ MATLAB CMake Python Shell C Other
Branch: develop
Clone or download
dellaert Merge pull request #164 from borglab/fix/debian-dependencies
Fix broken dependencies in Debian packages
Latest commit eafc379 Nov 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE moved templates from .github to .github/ISSUE_TEMPLATE Jun 14, 2019
.settings Merge remote-tracking branch 'origin/develop' into feature/Similarity Jan 23, 2015
CppUnitLite Revert "Fix cmake handling newer boost versions (Closes: #442)" Oct 7, 2019
cmake Use gcc -fPIC flag when building gtsam libraries Nov 11, 2019
cython expose GPSFactor in python wrapper, and add example for it Oct 19, 2019
debian Fix broken dependencies in Debian packages Nov 11, 2019
doc Fix missing "t" typo Sep 6, 2019
docker/ubuntu-boost-tbb-eigen3 Trying bionic, again, with -j2 flag Oct 9, 2018
examples Tightened odometry sigmas to avoid ILS Jun 12, 2019
gtsam Merge pull request #156 from borglab/fix/boost-optional Nov 13, 2019
gtsam_unstable Merge pull request #156 from borglab/fix/boost-optional Nov 13, 2019
matlab cleaned up Matlab script for visualizing mEstimators Oct 9, 2019
package_scripts Generate PPA packages for Ubuntu 19.10 (eoan) Aug 14, 2019
tests Update test cases for new preferred syntax Oct 28, 2019
timing fix compile error Oct 13, 2019
wrap Revert "Fix cmake handling newer boost versions (Closes: #442)" Oct 7, 2019
.cproject went back to cproject from develop branch Dec 20, 2018
.gitignore cmake fixes May 19, 2019
.project Created a new expressions.h file in nonlinear Nov 23, 2014
.travis.sh Refactor build flags via CMake target properties Jun 15, 2019
.travis.yml Excluded build that consistently times out Jun 15, 2019
CMakeLists.txt Merge pull request #135 from borglab/boost-exported-targets Oct 12, 2019
DEVELOP.md renamed all READMEs to README.md and updated markdown syntax Jun 13, 2019
GTSAM-Concepts.md Added information about LieGroup helper class Mar 14, 2019
INSTALL.md Merged in matt_broadway/gtsam/mkl_readme (pull request #382) May 17, 2019
LICENSE Update LICENSE to enumerate all dependencies in gtsam/3rdparty Jan 2, 2019
LICENSE.BSD Final cleanup of text files - README.md, LICENSE*, USAGE, and INSTALL. Jan 30, 2014
README.md update to README to include link to READMEs of MATLAB and Python wrap… Sep 16, 2019
THANKS.md make all top level docs as markdown files Jun 13, 2019
USAGE.md renamed all READMEs to README.md and updated markdown syntax Jun 13, 2019
Using-GTSAM-EXPORT.md Updated Using GTSAM_EXPORT document Jul 16, 2019
gtsam.h expose GPSFactor in python wrapper, and add example for it Oct 19, 2019
gtsam_extra.cmake.in Install GTSAMConfigVersion.cmake Oct 7, 2019
makestats.sh Command line for generating svn stats, needs statsvn from statsvn.org Jun 11, 2012
package.xml updated README to nicer Markdown, added links to papers for convenien… May 31, 2019

README.md

Build Status

README - Georgia Tech Smoothing and Mapping library

What is GTSAM?

GTSAM is a library of C++ classes that implement smoothing and mapping (SAM) in robotics and vision, using factor graphs and Bayes networks as the underlying computing paradigm rather than sparse matrices.

On top of the C++ library, GTSAM includes a MATLAB interface (enable GTSAM_INSTALL_MATLAB_TOOLBOX in CMake to build it). A Python interface is under development.

Quickstart

In the root library folder execute:

#!bash
$ mkdir build
$ cd build
$ cmake ..
$ make check (optional, runs unit tests)
$ make install

Prerequisites:

  • Boost >= 1.43 (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:

GTSAM 4 Compatibility

GTSAM 4 will introduce several new features, most notably Expressions and a python toolbox. We will also deprecate some legacy functionality and wrongly named methods, but by default the flag GTSAM_ALLOW_DEPRECATED_SINCE_V4 is enabled, allowing anyone to just pull V4 and compile. To build the python toolbox, however, you will have to explicitly disable that flag.

Also, GTSAM 4 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 will also do. A significant change which will not trigger a compile error is that zero-initializing of Point2 and Point3 will be deprecated, so please be aware that this might render functions using their default constructor incorrect.

Wrappers

We provide support for MATLAB and Python wrappers for GTSAM. Please refer to the linked documents for more details.

The Preintegrated IMU Factor

GTSAM includes a state of the art IMU handling scheme based on

  • Todd 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 in

  • Luca 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 in docs/ImuFactor.pdf, is enabled by default. To switch to the RSS 2015 version, set the flag GTSAM_TANGENT_PREINTEGRATION to OFF.

Additional Information

There is a GTSAM users Google group for general discussion.

Read about important GTSAM-Concepts here. A primer on GTSAM Expressions, which support (superfast) automatic differentiation, can be found on the GTSAM wiki on BitBucket.

See the INSTALL file for more detailed installation instructions.

GTSAM is open source under the BSD license, see the LICENSE and LICENSE.BSD files.

Please see the examples/ directory and the USAGE file for examples on how to use GTSAM.

GTSAM was developed in the lab of Frank Dellaert at the Georgia Institute of Technology, with the help of many contributors over the years, see THANKS.

You can’t perform that action at this time.