Skip to main content

Georgia Tech Smoothing And Mapping library

Project description

# README - Georgia Tech Smoothing and Mapping Library

Important Note

As of August 1 2020, the ‘develop‘ branch is officially in “Pre 4.1” mode, and features deprecated in 4.0 have been removed. Please use the last [4.0.3 release](https://github.com/borglab/gtsam/releases/tag/4.0.3) if you need those features.

However, most are easily converted and can be tracked down (in 4.0.3) by disabling the cmake flag ‘GTSAM_ALLOW_DEPRECATED_SINCE_V4‘.

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

On top of the C++ library, GTSAM includes [wrappers for MATLAB & Python](#wrappers).

## Quickstart

In the root library folder execute:

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

Prerequisites:

Optional prerequisites - used automatically if findable by CMake:

## GTSAM 4 Compatibility

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

GTSAM 4 also deprecated some legacy functionality and wrongly named methods. If you are on a 4.0.X release, you can define the flag GTSAM_ALLOW_DEPRECATED_SINCE_V4 to use the deprecated methods.

GTSAM 4.1 added a new pybind wrapper, and removed the deprecated functionality. There is a flag GTSAM_ALLOW_DEPRECATED_SINCE_V41 for newly deprecated methods since the 4.1 release, which is on by default, allowing anyone to just pull version 4.1 and compile.

## Wrappers

We provide support for [MATLAB](matlab/README.md) and [Python](cython/README.md) 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]](https://ieeexplore.ieee.org/document/6092505)

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]](https://ieeexplore.ieee.org/abstract/document/6907483)

  • 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]](http://www.roboticsproceedings.org/rss11/p06.pdf)

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 [this document](doc/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‘](https://groups.google.com/forum/#!forum/gtsam-users) for general discussion.

Read about important [‘GTSAM-Concepts‘](GTSAM-Concepts.md) here. A primer on GTSAM Expressions, which support (superfast) automatic differentiation, can be found on the [GTSAM wiki on BitBucket](https://bitbucket.org/gtborg/gtsam/wiki/Home).

See the [‘INSTALL‘](INSTALL.md) file for more detailed installation instructions.

GTSAM is open source under the BSD license, see the [‘LICENSE‘](LICENSE) and [‘LICENSE.BSD‘](LICENSE.BSD) files.

Please see the [‘examples/‘](examples) directory and the [‘USAGE‘](USAGE.md) file for examples on how to use GTSAM.

GTSAM was developed in the lab of [Frank Dellaert](http://www.cc.gatech.edu/~dellaert) at the [Georgia Institute of Technology](http://www.gatech.edu), with the help of many contributors over the years, see [THANKS](THANKS.md).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

gtsam-4.1.0-cp38-none-macosx_10_9_x86_64.whl (7.9 MB view details)

Uploaded CPython 3.8macOS 10.9+ x86-64

gtsam-4.1.0-cp38-cp38-manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.8

gtsam-4.1.0-cp36-cp36m-manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.6m

gtsam-4.1.0-cp35-cp35m-manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.5m

gtsam-4.1.0-1-cp37-cp37m-manylinux2014_x86_64.whl (5.5 MB view details)

Uploaded CPython 3.7m

File details

Details for the file gtsam-4.1.0-cp38-none-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.0-cp38-none-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 7.9 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.5

File hashes

Hashes for gtsam-4.1.0-cp38-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d3e89bd669aa52e060b02306d0fdedcf26f356ceed5ca565a46cfa53f0573855
MD5 073ed8aae399d2c00170641ca2193c8d
BLAKE2b-256 ed915863b04217b388cc275b331cbc5700f53cad923436ee59889cee45bf0f25

See more details on using hashes here.

File details

Details for the file gtsam-4.1.0-cp38-cp38-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.0-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.5

File hashes

Hashes for gtsam-4.1.0-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 918ad883d256eedebc15e5ee366a1247dad6308cc732e0d4d1ff16dd53906123
MD5 e64ad33fc02be10746695b3c92cd8ed8
BLAKE2b-256 9eefe109df0f2dd65b19e35ab060c8e73838676d71a5caee0d1f1f7c9f45f0f9

See more details on using hashes here.

File details

Details for the file gtsam-4.1.0-cp36-cp36m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.0-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.5

File hashes

Hashes for gtsam-4.1.0-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cc5ab9a45a901037c0665bf37919b3b8f278a09d6b8eefac0721a520307bf467
MD5 45c064c8d162432ff56522c267dac260
BLAKE2b-256 0f92600b5aad16fcaaecf67a2b447976d4681dc4ece50ddb8b7420fb8afc59b8

See more details on using hashes here.

File details

Details for the file gtsam-4.1.0-cp35-cp35m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.0-cp35-cp35m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.5

File hashes

Hashes for gtsam-4.1.0-cp35-cp35m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5e402e24b4ac00ede3886c2d47fbe15a66edf43d8387cb8441bb024ee6866ee7
MD5 f44738e2c1fe92072d792025248b8938
BLAKE2b-256 d39b92d9dcdb6fef51197a651b3ac983287521a1600dc7bc7db59afecc1c7a37

See more details on using hashes here.

File details

Details for the file gtsam-4.1.0-1-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.0-1-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 5.5 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.6

File hashes

Hashes for gtsam-4.1.0-1-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ba3e701fa1b933ef5dce95ce6f3fd91b7470e4e97dbe1781cdb1e23ced9679b9
MD5 5f189cc54dd852778798257c34874b1e
BLAKE2b-256 bd91603421fa6cc30b6663a77f4b5d32fba04dc3c24f015aff996672356bb281

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page