Go to file
yao aac6a29c9b Added several code files and gtsam.pdf. 2016-06-10 20:48:42 -04:00
.settings Merge remote-tracking branch 'origin/develop' into feature/Similarity 2015-01-23 08:10:21 -05:00
CppUnitLite add macro TEST_DISABLED for disabling tests without commenting them out 2014-09-13 01:29:25 -04:00
cmake fix CMAKE_BUILD_TYPE var to cache varible in default 2016-05-13 12:18:18 -04:00
doc Added several code files and gtsam.pdf. 2016-06-10 20:48:42 -04:00
examples fix gtsam::ValuesIncorrectType 2016-06-06 11:11:57 -04:00
gtsam Deleted one blank line 2016-06-06 13:33:30 -04:00
gtsam_unstable Removed headers 2016-05-22 14:22:36 -07:00
matlab Merge remote-tracking branch 'origin/develop' into feature/Feature/FixedValues 2016-04-10 17:40:26 -07:00
package_scripts solve 'redefine MKL warning' 2014-11-13 20:59:45 -05:00
python TRying to get past compile issue on Jenkins 2016-06-05 01:16:35 -07:00
tests Removed headers 2016-05-22 14:22:36 -07:00
timing Removed headers 2016-05-22 14:22:36 -07:00
wrap Removed headers 2016-05-22 14:22:36 -07:00
.cproject Restored to develop 2016-02-07 19:41:11 -08:00
.gitignore Moved numpy_eigen headers to a more logical place 2016-01-28 16:47:12 -08:00
.project Fixed build command 2014-11-23 10:43:00 +01:00
CMakeLists.txt Added flag 2016-05-15 13:15:37 -07:00
DEVELOP Start a DEVELOP document and update INSTALL 2014-05-05 14:42:46 -04:00
GTSAM-Concepts.md Many small improvements, bug-fixes, and tests 2016-02-24 11:01:19 -08:00
INSTALL Start a DEVELOP document and update INSTALL 2014-05-05 14:42:46 -04:00
LICENSE Final cleanup of text files - README.md, LICENSE*, USAGE, and INSTALL. 2014-01-30 14:42:23 -05:00
LICENSE.BSD Final cleanup of text files - README.md, LICENSE*, USAGE, and INSTALL. 2014-01-30 14:42:23 -05:00
README.md Added ImuFactor things in readme 2016-06-05 11:02:54 -07:00
THANKS Adding Ellon to list of contributors. Very important :-) 2016-01-24 23:59:22 -05:00
USAGE.md Fixed some top-level files 2014-12-03 20:15:19 +01:00
gtsam.h fix matlab compile issue, by removing abstract class PreintegrationBase from wrapper declearation 2016-06-02 21:04:52 -04:00
gtsam_extra.cmake.in Append full Eigen include path to GTSAM_INCLUDE_DIR to dependent projects can find the same Eigen that GTSAM was configured with 2015-03-18 14:20:45 -04:00
gtsampy.h Deprecated some more methods 2016-02-08 15:16:11 -08:00
makestats.sh Command line for generating svn stats, needs statsvn from statsvn.org 2012-06-11 14:31:32 +00:00
matlab.h Fixed compilation problems (and used some c++11 for loops) 2016-02-17 16:06:10 -08:00
package.xml Adding a minimal version of catkin compatibility 2014-10-02 16:51:29 +02:00

README.md

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 >= 2.6 (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.

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.

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.
  • 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.

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

Read about important GTSAM-Concepts here.

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.