# 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.
The current support matrix is:
| Platform | Compiler | Build Status |
|:------------:|:---------:|:-------------:|
| Ubuntu 18.04 | gcc/clang |  |
| macOS | clang |  |
| Windows | MSVC |  |
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:
- [Boost](http://www.boost.org/users/download/) >= 1.58 (Ubuntu: `sudo apt-get install libboost-all-dev`)
- [CMake](http://www.cmake.org/cmake/resources/software.html) >= 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:
- [Intel Threaded Building Blocks (TBB)](http://www.threadingbuildingblocks.org/) (Ubuntu: `sudo apt-get install libtbb-dev`)
- [Intel Math Kernel Library (MKL)](http://software.intel.com/en-us/intel-mkl) (Ubuntu: [installing using APT](https://software.intel.com/en-us/articles/installing-intel-free-libs-and-python-apt-repo))
- See [INSTALL.md](INSTALL.md) for more installation information
- Note that MKL may not provide a speedup in all cases. Make sure to benchmark your problem with and without MKL.
## 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](python/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).
Raw data
{
"_id": null,
"home_page": "https://gtsam.org/",
"name": "gtsam",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "slam sam robotics localization mapping optimization",
"author": "Frank Dellaert et. al.",
"author_email": "frank.dellaert@gtsam.org",
"download_url": "",
"platform": "",
"description": "# README - Georgia Tech Smoothing and Mapping Library\n\n**Important Note**\n\nAs 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. \n\nHowever, most are easily converted and can be tracked down (in 4.0.3) by disabling the cmake flag `GTSAM_ALLOW_DEPRECATED_SINCE_V4`.\n\n## What is GTSAM?\n\nGTSAM is a C++ library that implements smoothing and\nmapping (SAM) in robotics and vision, using Factor Graphs and Bayes\nNetworks as the underlying computing paradigm rather than sparse\nmatrices.\n\nThe current support matrix is:\n\n| Platform | Compiler | Build Status |\n|:------------:|:---------:|:-------------:|\n| Ubuntu 18.04 | gcc/clang |  |\n| macOS | clang |  |\n| Windows | MSVC |  |\n\n\nOn top of the C++ library, GTSAM includes [wrappers for MATLAB & Python](#wrappers).\n\n\n## Quickstart\n\nIn the root library folder execute:\n\n```sh\n#!bash\n$ mkdir build\n$ cd build\n$ cmake ..\n$ make check (optional, runs unit tests)\n$ make install\n```\n\nPrerequisites:\n\n- [Boost](http://www.boost.org/users/download/) >= 1.58 (Ubuntu: `sudo apt-get install libboost-all-dev`)\n- [CMake](http://www.cmake.org/cmake/resources/software.html) >= 3.0 (Ubuntu: `sudo apt-get install cmake`)\n- A modern compiler, i.e., at least gcc 4.7.3 on Linux.\n\nOptional prerequisites - used automatically if findable by CMake:\n\n- [Intel Threaded Building Blocks (TBB)](http://www.threadingbuildingblocks.org/) (Ubuntu: `sudo apt-get install libtbb-dev`)\n- [Intel Math Kernel Library (MKL)](http://software.intel.com/en-us/intel-mkl) (Ubuntu: [installing using APT](https://software.intel.com/en-us/articles/installing-intel-free-libs-and-python-apt-repo))\n - See [INSTALL.md](INSTALL.md) for more installation information\n - Note that MKL may not provide a speedup in all cases. Make sure to benchmark your problem with and without MKL.\n\n## GTSAM 4 Compatibility\n\nGTSAM 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.\n\nGTSAM 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.\n\nGTSAM 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.\n\n\n## Wrappers\n\nWe provide support for [MATLAB](matlab/README.md) and [Python](python/README.md) wrappers for GTSAM. Please refer to the linked documents for more details.\n\n## The Preintegrated IMU Factor\n\nGTSAM includes a state of the art IMU handling scheme based on\n\n- 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)\n\nOur implementation improves on this using integration on the manifold, as detailed in\n\n- 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)\n- 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)\n\nIf you are using the factor in academic work, please cite the publications above.\n\nIn 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.\n\n\n## Additional Information\n\nThere is a [`GTSAM users Google group`](https://groups.google.com/forum/#!forum/gtsam-users) for general discussion.\n\nRead about important [`GTSAM-Concepts`](GTSAM-Concepts.md) here. A primer on GTSAM Expressions,\nwhich support (superfast) automatic differentiation,\ncan be found on the [GTSAM wiki on BitBucket](https://bitbucket.org/gtborg/gtsam/wiki/Home).\n\nSee the [`INSTALL`](INSTALL.md) file for more detailed installation instructions.\n\nGTSAM is open source under the BSD license, see the [`LICENSE`](LICENSE) and [`LICENSE.BSD`](LICENSE.BSD) files.\n\nPlease see the [`examples/`](examples) directory and the [`USAGE`](USAGE.md) file for examples on how to use GTSAM.\n\nGTSAM 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).\n\n\n",
"bugtrack_url": null,
"license": "Simplified BSD license",
"summary": "Georgia Tech Smoothing And Mapping library",
"version": "4.1.1",
"split_keywords": [
"slam",
"sam",
"robotics",
"localization",
"mapping",
"optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc1c1c26dcb858c77e4ffb355ef23a1fa9f5cc74e66b0dd9b8b5d45e4342f874",
"md5": "70236b3ff8108d54ad7906f9de8bd623",
"sha256": "794065cb300b7e2ad63fe9631538c8501fb0f83baa1104efbdf22b33047d2736"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp36-cp36m-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "70236b3ff8108d54ad7906f9de8bd623",
"packagetype": "bdist_wheel",
"python_version": "cp36",
"requires_python": null,
"size": 20164257,
"upload_time": "2021-12-22T02:45:24",
"upload_time_iso_8601": "2021-12-22T02:45:24.111779Z",
"url": "https://files.pythonhosted.org/packages/fc/1c/1c26dcb858c77e4ffb355ef23a1fa9f5cc74e66b0dd9b8b5d45e4342f874/gtsam-4.1.1-cp36-cp36m-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7c82f08b127ae5e48a025f8d12da6b63b591b8cd0073d9282840e64b558bf92",
"md5": "95f3d61c4b19e28c2f39d4b3ea6fe8e2",
"sha256": "744f333a2db3c70d260859a58b8e978c6fa4cbbe4d9fb04ac2b2d118323405b0"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "95f3d61c4b19e28c2f39d4b3ea6fe8e2",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": null,
"size": 20166131,
"upload_time": "2021-12-22T02:44:10",
"upload_time_iso_8601": "2021-12-22T02:44:10.996664Z",
"url": "https://files.pythonhosted.org/packages/e7/c8/2f08b127ae5e48a025f8d12da6b63b591b8cd0073d9282840e64b558bf92/gtsam-4.1.1-cp37-cp37m-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1894e6cd95aad297573b13be49ba88cc0257138fe0d005a5279294891b3f82ad",
"md5": "3f5f6bd9938f2e08dd066c5193b8937b",
"sha256": "770d8ec95243c65a456e2ee7ab6e9a9d45764cb580063d251e58afd3373b2aa6"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "3f5f6bd9938f2e08dd066c5193b8937b",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 20068967,
"upload_time": "2021-12-22T16:31:17",
"upload_time_iso_8601": "2021-12-22T16:31:17.803183Z",
"url": "https://files.pythonhosted.org/packages/18/94/e6cd95aad297573b13be49ba88cc0257138fe0d005a5279294891b3f82ad/gtsam-4.1.1-cp38-cp38-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "667b3355cf86be16a7929565cc7fe61a3fddd5afa1c82a1f7131fc17d868c62a",
"md5": "917c92c609cda80334f6edaea8de719d",
"sha256": "c7b4db2a54b11eca37906e31316f4276a11d18a56176aa7b609b8553d43f521e"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp38-cp38-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "917c92c609cda80334f6edaea8de719d",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 19954227,
"upload_time": "2021-12-22T02:45:49",
"upload_time_iso_8601": "2021-12-22T02:45:49.713012Z",
"url": "https://files.pythonhosted.org/packages/66/7b/3355cf86be16a7929565cc7fe61a3fddd5afa1c82a1f7131fc17d868c62a/gtsam-4.1.1-cp38-cp38-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d6acfddc25c3d121e50f8c355475c24bf8ce27457d5ecc50d201a4e50153eed",
"md5": "c7bb63d3194dec40df7408e00e9ed884",
"sha256": "7ecaba8c693653a303daa01d6a633247ecade5e3752b69e3f4b5345e3eeed0dc"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "c7bb63d3194dec40df7408e00e9ed884",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 20071605,
"upload_time": "2021-12-22T16:31:34",
"upload_time_iso_8601": "2021-12-22T16:31:34.867106Z",
"url": "https://files.pythonhosted.org/packages/3d/6a/cfddc25c3d121e50f8c355475c24bf8ce27457d5ecc50d201a4e50153eed/gtsam-4.1.1-cp39-cp39-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39286b8bcdb1ed9bb3c9dce1a716dcac663e263256cbd8de7cd226251dd00ee2",
"md5": "6268fa069b37b1215e77d4475f4f4eae",
"sha256": "931e0cbedecea97245fb5f3d905e3ad6ade91595c6d35aea4150be007a332874"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl",
"has_sig": false,
"md5_digest": "6268fa069b37b1215e77d4475f4f4eae",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 18566443,
"upload_time": "2021-12-22T15:26:36",
"upload_time_iso_8601": "2021-12-22T15:26:36.486517Z",
"url": "https://files.pythonhosted.org/packages/39/28/6b8bcdb1ed9bb3c9dce1a716dcac663e263256cbd8de7cd226251dd00ee2/gtsam-4.1.1-cp39-cp39-macosx_12_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "849045b322eb9d30cdf4f4848b15ad13e2541b1c04f54d4715f9f0c98eef0162",
"md5": "7de7cf72d513cafd930f561a824eb9d6",
"sha256": "67045d29c891fcf9074570d7fbf4e9f905f3cc335ec7fa4932c1e6405341d529"
},
"downloads": -1,
"filename": "gtsam-4.1.1-cp39-cp39-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "7de7cf72d513cafd930f561a824eb9d6",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 19953578,
"upload_time": "2021-12-22T02:46:24",
"upload_time_iso_8601": "2021-12-22T02:46:24.218345Z",
"url": "https://files.pythonhosted.org/packages/84/90/45b322eb9d30cdf4f4848b15ad13e2541b1c04f54d4715f9f0c98eef0162/gtsam-4.1.1-cp39-cp39-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-12-22 02:45:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "gtsam"
}
JSON