orbslam3-python 2.0.0

Enhanced Python bindings for ORB-SLAM3 with hardware adaptation and performance monitoring

ORB-SLAM3

Python bindings for the ORB-SLAM3 visual SLAM library.

Installation online via pypi

pip install orbslam3-python

Installation locally

1. Basic installation (enhanced bindings by default)

pip install -e .

2. Legacy bindings only

BUILD_ENHANCED_BINDINGS=OFF pip install -e .

3. Enhanced bindings with CUDA support

BUILD_ENHANCED_BINDINGS=ON ENABLE_CUDA=ON pip install -e .

4. Development installation with all tools

pip install -e ".[dev]"

5. With custom Pangolin path

export Pangolin_DIR="/path/to/Pangolin/build"
pip install -e .

6. Debug build

CMAKE_BUILD_TYPE=Debug pip install -e .

7. Custom parallel build jobs

CMAKE_BUILD_PARALLEL_LEVEL=4 pip install -e .

TODO (Click me)

Changes from Original Version of ORB_SLAM2-PythonBindings

add method for retrieve the intrinsic parameter of camera

    get_camera_matrix //return a numpy array with the camera matrix
    get_dist_coef //return a tuple with the distortion coefficient

add method for retrieve the pose of the frame wrt initial frame

    get_frame_pose //return a numpy array with the pose

add method for retrieve the keypoint in the frame and it's world position

    get_current_points //return a list with a tuple pair ((world position),(2d keypoints))

add python 3.8 Support

ORB_SLAM2-PythonBindings

A python wrapper for ORB_SLAM2, which can be found at https://github.com/raulmur/ORB_SLAM2. This is designed to work with the base version of ORB_SLAM2, with a couple of minimal API changes to access the system output. It has been tested on ubuntu 14.04 and 16.04 and built against Python3, although it does not rely on any python3 features.

Installation

Prerequesities

• ORBSLAM2 source code
• ORBSLAM2 compiliation dependencies (Pangolin, Eigen, OpenCV)
• Boost, specifically its python component (python38)
• Numpy development headers (to represent images in python, automatically converted to cv::Mat)

Setup

Modifying ORBSLAM2

First, we need an additional API method from ORBSLAM to extract completed trajectories. Apply the patch file "orbslam-changes.diff" to the ORBSLAM2 source, which should create an additional method and add some installation instructions to the end of CMakeLists.txt. Build orbslam as normal, and then run make install. This will install the ORBSLAM2 headers and .so to /usr/local (if an alternative installation directory is desired, specify it to cmake using -DCMAKE_INSTALL_PREFIX=/your/desired/location).

Compilation

Return to the ORBSLAM-Python source, build and install it by running

mkdir build
cd build
cmake ..
make
make install

This will install the .so file to /usr/local/lib/python3.5/dist-packages, such that it should If you have changed the install location of ORBSLAM2, you need to indicate where it is installed using -DORB_SLAM2_DIR=/your/desired/location, which should be the same as the install prefix above (and contain 'include' and 'lib' folders).

Verify your installation by typing

python3
>>> import orbslam2

And there should be no errors.

Examples

ORBSLAM2's examples have been re-implemented in python in the examples folder. Run them with the same parameters as the ORBSLAM examples, i.e.:

python3 orbslam_mono_kitti.py [PATH_TO_ORBSLAM]/Vocabulary/ORBvoc.txt [PATH_TO_ORBSLAM]/Examples/Monocular/KITTI00-02.yaml [PATH_TO_KITTI]/sequences/00/

Alternative Python Versions

At the moment, CMakeLists is hard-coded to use python 3.5. If you wish to use a different version, simply change the boost component used (python-35) to the desired version (say, python-27), on line 38 of CMakeLists.txt. You will also need to change the install location on line 73 of CMakeLists.txt to your desired dist/site packages directory.

License

This code is licensed under the BSD Simplified license, although it requires and links to ORB_SLAM2, which is available under the GPLv3 license

It uses pyboostcvconverter (https://github.com/Algomorph/pyboostcvconverter) by Gregory Kramida under the MIT licence (see pyboostcvconverter-LICENSE).