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

The current support matrix is:

Platform Compiler Build Status
Ubuntu 18.04 gcc/clang Linux CI
macOS clang macOS CI
Windows MSVC Windows CI

On top of the C++ library, GTSAM includes wrappers for MATLAB & Python.

Quickstart

In the root library folder execute:

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

Prerequisites:

  • Boost >= 1.58 (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 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 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 this document, 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.

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.1-cp39-cp39-manylinux2014_x86_64.whl (20.0 MB view details)

Uploaded CPython 3.9

gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl (18.6 MB view details)

Uploaded CPython 3.9 macOS 12.0+ ARM64

gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl (20.1 MB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

gtsam-4.1.1-cp38-cp38-manylinux2014_x86_64.whl (20.0 MB view details)

Uploaded CPython 3.8

gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl (20.1 MB view details)

Uploaded CPython 3.8 macOS 11.0+ x86-64

gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.7m

gtsam-4.1.1-cp36-cp36m-manylinux2014_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.6m

File details

Details for the file gtsam-4.1.1-cp39-cp39-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.1-cp39-cp39-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 20.0 MB
  • Tags: CPython 3.9
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp39-cp39-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 67045d29c891fcf9074570d7fbf4e9f905f3cc335ec7fa4932c1e6405341d529
MD5 7de7cf72d513cafd930f561a824eb9d6
BLAKE2b-256 849045b322eb9d30cdf4f4848b15ad13e2541b1c04f54d4715f9f0c98eef0162

See more details on using hashes here.

File details

Details for the file gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl.

File metadata

  • Download URL: gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl
  • Upload date:
  • Size: 18.6 MB
  • Tags: CPython 3.9, macOS 12.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 931e0cbedecea97245fb5f3d905e3ad6ade91595c6d35aea4150be007a332874
MD5 6268fa069b37b1215e77d4475f4f4eae
BLAKE2b-256 39286b8bcdb1ed9bb3c9dce1a716dcac663e263256cbd8de7cd226251dd00ee2

See more details on using hashes here.

File details

Details for the file gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 20.1 MB
  • Tags: CPython 3.9, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 7ecaba8c693653a303daa01d6a633247ecade5e3752b69e3f4b5345e3eeed0dc
MD5 c7bb63d3194dec40df7408e00e9ed884
BLAKE2b-256 3d6acfddc25c3d121e50f8c355475c24bf8ce27457d5ecc50d201a4e50153eed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gtsam-4.1.1-cp38-cp38-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 20.0 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp38-cp38-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c7b4db2a54b11eca37906e31316f4276a11d18a56176aa7b609b8553d43f521e
MD5 917c92c609cda80334f6edaea8de719d
BLAKE2b-256 667b3355cf86be16a7929565cc7fe61a3fddd5afa1c82a1f7131fc17d868c62a

See more details on using hashes here.

File details

Details for the file gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl
  • Upload date:
  • Size: 20.1 MB
  • Tags: CPython 3.8, macOS 11.0+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 770d8ec95243c65a456e2ee7ab6e9a9d45764cb580063d251e58afd3373b2aa6
MD5 3f5f6bd9938f2e08dd066c5193b8937b
BLAKE2b-256 1894e6cd95aad297573b13be49ba88cc0257138fe0d005a5279294891b3f82ad

See more details on using hashes here.

File details

Details for the file gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl.

File metadata

  • Download URL: gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 744f333a2db3c70d260859a58b8e978c6fa4cbbe4d9fb04ac2b2d118323405b0
MD5 95f3d61c4b19e28c2f39d4b3ea6fe8e2
BLAKE2b-256 e7c82f08b127ae5e48a025f8d12da6b63b591b8cd0073d9282840e64b558bf92

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gtsam-4.1.1-cp36-cp36m-manylinux2014_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for gtsam-4.1.1-cp36-cp36m-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 794065cb300b7e2ad63fe9631538c8501fb0f83baa1104efbdf22b33047d2736
MD5 70236b3ff8108d54ad7906f9de8bd623
BLAKE2b-256 fc1c1c26dcb858c77e4ffb355ef23a1fa9f5cc74e66b0dd9b8b5d45e4342f874

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