Go to file
Richard Roberts ffd439d89a Added unit tests for Values::find, lower_bound, and upper_bound 2014-01-07 17:34:00 -05:00
CppUnitLite
cmake Path fix for projects referencing cmake libs without using a submodule 2013-12-29 15:13:13 -05:00
doc gitinspector stats 2013-12-23 13:16:32 -05:00
examples Merge branch 'origin/release/2.4.0' 2013-12-25 07:49:43 -05:00
gtsam Added unit tests for Values::find, lower_bound, and upper_bound 2014-01-07 17:34:00 -05:00
gtsam_unstable Disabled non-working smartfactors test 2014-01-02 17:32:31 -05:00
matlab MATLAB wrapping and Monocular VO example 2013-12-17 16:18:31 +00:00
package_scripts
tests Switched to new Eigen built-in special comma initializer 2013-12-16 21:33:12 +00:00
wrap Merged wrap improvements back from develop branch 2013-12-23 14:41:49 -05:00
.cproject Generating random directions. Somewhat clumsy use of forward declaration, issue #19 applies as well. 2013-12-26 13:59:15 -05:00
.gitignore Added .pyc files to ignore 2014-01-06 21:19:53 -05:00
.project
CMakeLists.txt Cherry-picked devlop fixes into 2.4: 2013-12-22 16:04:47 -05:00
LICENSE
LICENSE.BSD Renamed LICENSE to LICENSE.BSD 2014-01-04 13:59:43 -05:00
README
README.md Renamed LICENSE to LICENSE.BSD 2014-01-04 13:59:43 -05:00
THANKS
USAGE
gtsam.h new constructor, getBasis->basis, rotate and distance 2013-12-18 03:11:58 +00:00
gtsam_extra.cmake.in Some cleanup in compiling wrappers 2013-12-12 18:37:27 +00:00
makestats.sh
matlab.h

README.md

README - Georgia Tech Smoothing and Mapping library

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)

Optional prerequisites - used automatically if findable by CMake:

Tested compilers

  • GCC 4.2-4.7
  • OSX Clang 2.9-5.0
  • OSX GCC 4.2
  • MSVC 2010, 2012

Tested systems:

  • Ubuntu 11.04 - 13.10
  • MacOS 10.6 - 10.9
  • Windows 7, 8

See the INSTALL file for more detailed installation instructions.

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.

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

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

The library is organized according to the following directory structure:

3rdparty      local copies of third party libraries - Eigen3 and CCOLAMD
base          provides some base Math and data structures, as well as test-related utilities
geometry      points, poses, tensors, etc
inference     core graphical model inference such as factor graphs, junction trees, Bayes nets, Bayes trees 
linear        inference specialized to Gaussian linear case, GaussianFactorGraph etc...
nonlinear     non-linear factor graphs and non-linear optimization
slam          SLAM and visual SLAM application code

This library contains unchanged copies of two third party libraries, with documentation of licensing as follows:

  • CCOLAMD 2.73: Tim Davis' constrained column approximate minimum degree ordering library
  • Eigen 3.2: General C++ matrix and linear algebra library
    • Licenced under MPL2, provided in gtsam/3rdparty/Eigen/COPYING.README (some code that is 3rd-party to Eigen is BSD and LGPL)