search

NikolausDemmel / rootba

Square Root Bundle Adjustment for Large-Scale Reconstruction
BSD 3-Clause "New" or "Revised" License
291 stars 37 forks source link

readme

RootBA: Square Root Bundle Adjustment

Project Page | Paper | Poster | Video | Code

teaser image

Table of Contents

Citation

If you find our work useful in your research, please consider citing:

@inproceedings{weber2023poba,
 author = {Simon Weber and Nikolaus Demmel and Tin Chon Chan and Daniel Cremers},
 title = {Power Bundle Adjustment for Large-Scale 3D Reconstruction},
 booktitle = {IEEE Conference on Computer Vision and Pattern Recognition (CVPR)},
 year = {2023}
}

@inproceedings{demmel2021rootba,
 author = {Nikolaus Demmel and Christiane Sommer and Daniel Cremers and Vladyslav Usenko},
 title = {Square Root Bundle Adjustment for Large-Scale Reconstruction},
 booktitle = {IEEE Conference on Computer Vision and Pattern Recognition (CVPR)},
 year = {2021}
}

Note: This repository contains the code for the CVPR'21 Square Root BA paper, as well as the CVPR'23 Power Bundle Adjustment paper. This README describes the implementation and tools in this repository as well as the tutorial for reproducing the RootBA paper results. There is a dedicated self-contained tutorial for reproducing the PoBA results.

Dependencies

The following describes the needed dependencies in general, followed by concrete instructions to install them on Linux or macOS.

Toolchain

Included as submodule or copy

See the external folder and the scripts/build-external.sh script.

The following libraries are submodules:

Some external libraries have their source copied directly as part of this repository, see the external/download_copied_sources.sh script:

Externally supplied

The following dependencies are expected to be supplied externally, e.g. from a system-wide install:

Python

Python dependencies are needed for scripts and tools to generate config files, run experiments, plot results, etc. For generating result tables and plots you additionally need latexmk and a LaTeX distribution.

Developer Tools

These additional dependencies are useful if you plan to work on the code:

There are scripts to help apply formatting and style checks to all source code files:

Installing dependencies on Linux

Ubuntu 20.04 and newer are supported.

Toolchain and libraries

# for RootBA and Ceres
sudo apt install \
    libgoogle-glog-dev \
    libgflags-dev \
    libtbb-dev \
    libatlas-base-dev \
    libsuitesparse-dev
# for Pangolin GUI
sudo apt install \
    libglew-dev \
    ffmpeg \
    libavcodec-dev \
    libavutil-dev \
    libavformat-dev \
    libswscale-dev \
    libavdevice-dev \
    libjpeg-dev \
    libpng-dev \
    libtiff5-dev \
    libopenexr-dev

To get a recent version of cmake you can easily install it from pip.

sudo apt install python3-pip
python3 -m pip install --user -U cmake

# put this in your .bashrc to ensure cmake from pip is found
export PATH="$HOME/.local/bin:$PATH"

Note: If you run this in a plain Ubuntu docker container you might need to install some additional basic packages (which should already be installed on a desktop system):

sudo apt install git-core wget curl time software-properties-common

Python (optional)

Other python dependencies (for tools and scripts) can also be installed via pip.

python3 -m pip install --user -U py_ubjson matplotlib numpy munch scipy pylatex toml

For generating result tables and plots you additionally need latexmk and a LaTeX distribution.

sudo apt install texlive-latex-extra latexmk

Developer tools (optional)

For developer tools, you can install ninja and ccache from apt:

sudo apt install ccache ninja-build

You can install yapf from pip:

python3 -m pip install --user -U yapf

For clang-tidy you need at least version 12, so even on Ubuntu 20.04 you need to get it from the llvm website:

wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
sudo add-apt-repository "deb http://apt.llvm.org/$(lsb_release -sc)/ llvm-toolchain-$(lsb_release -sc)-12 main"
sudo apt update
sudo apt install clang-tidy-12

On Ubuntu 20.04 and above, clang-format from apt is recent enough (we require at least version 10):

sudo apt install clang-format

Installing depedencies on macOS

We support macOS 10.15 "Catalina" and newer.

Note: We have not yet tested this codebase on M1 macs.

Toolchain and libraries

Install Homebrew, then use it to install dependencies:

brew install cmake glog gflags tbb suitesparse
brew install glew ffmpeg libjpeg libpng libtiff

Python (optional)

Python dependencies (for tools and scripts) can be installed via pip after installing python 3 from homebrew.

brew install python bash gnu-getopt
python3 -m pip install --user -U py_ubjson matplotlib numpy munch scipy pylatex toml

For generating result tables and plots you additionally need latexmk and a LaTeX distribution.

brew install --cask mactex

Developer tools (optional)

Developer tools can be installed with homebrew.

brew install ccache ninja clang-format llvm yapf

Building

Build dependencies

./scripts/build-external.sh [BUILD_TYPE]

You can optionally pass the cmake BUILD_TYPE used to compile the third party libraries as the first argument. If you don't pass anything the deafult is Release. This build script will use ccache and ninja automaticaly if they are found on PATH.

Note: The build-external.sh build script will init, synchronize and update all submodules, so usually you don't have to worry about submodules. For example, you don't have to run git submodule update --recursive manually when the submodules were updated upstream, as long as you run the build-external.sh script. But there is a small caveat, should you ever want to update a submodule yourself (e.g. update Eigen to a new version). In that case you need to commit that change before running this script, else the script will revert the submodule back to the committed version.

Build RootBA option a)

Use the build script.

./scripts/build-rootba.sh [BUILD_TYPE]

You can optionally pass the cmake BUILD_TYPE used to compile RootBA as the first argument. If you don't pass anything the default is Release. The cmake build folder is build, inside the project root. This build script will use ccache and ninja automaticaly if they are found on PATH.

Build RootBA option b)

Manually build with the standard cmake workflow.

mkdir build && cd build
cmake ..
make -j8

The cmake project will automatically use ccache if it is found on PATH (unless you override by manually specifying CMAKE_C_COMPILER_LAUNCHER/CMAKE_CXX_COMPILER_LAUNCHER). To use ninja instead of make, you can use:

cmake .. -G Ninja
ninja

CMake Options

You can set the following options when calling cmake. For setting option OPTION to a value of VALUE, add the command line argument -DOPTION=VALUE to the cmake call above.

Running Unit Tests

Unit tests are implemented with the GoogleTest framework and can be run with CMake's ctest command after compilation.

cd build
ctest

BAL Problems

In the "Bundle Adjustment in the Large" (BAL) problem formulation cameras are represented as world-to-cam poses and points as 3D points in world frame, and each camera has its own set of independent intrinsics, using the "Snavely projection" function with one focal length f and two radial distortion parameters k1 and k2. This is implemented in the BalProblem class. Besides the BAL format, we also implement a reader for "bundle" files, but the internal representation is the same.

Note: In our code we follow the convention that the positive z-axis points forward in camera viewing direction. Both BAL and bundle files specify the projection function assuming the negative z-axis pointing in viewing direction. We convert to our convention when reading the datasets.

For testing and development, two example datasets from BAL are included in the data/rootba/bal folder:

data/rootba/bal/ladybug/problem-49-7776-pre.txt
data/rootba/bal/final/problem-93-61203-pre.txt

We moreover include a download-bal-problems.sh script to conveniently download the BAL datasets. See the batch evaluation tutorial below for more details.

Additionally, we provide a mirror of BAL and some additional publicly available datasets: https://gitlab.vision.in.tum.de/rootba/rootba_data

Please refer to the README files in the corresponding folders of that repository for further details on the data source, licensing and any preprocessing we applied. Large files in that repository are stored with Git LFS. Beware that the full download including LFS objects is around 15GB.

Note: The tutorial examples below assume that the data is found in a rootba_data folder parallel to the source folder, so if you decide to clone the data git repository, you can use (after installing and enabling Git LFS):

cd ..
git clone https://gitlab.vision.in.tum.de/rootba/rootba_data.git

Testing Bundle Adjustment

Visualization of BAL Problems

With a simple GUI application you can visualize the BAL problems, including 3D camera poses and landmark positions, as well as feature detections and landmark reprojections.

./bin/bal_gui --input data/rootba/bal/final/problem-93-61203-pre.txt

Plots

Running Bundle Adjustment

The main executable to run bundle adjustment is bal. This implements bundle adjustment in all evaluated variants and can be configured from the command line and/or a rootba_config.toml file.

There are also three additional variants, bal_qr, bal_sc and bal_ceres, which override the solver_type option accordingly. They can be useful during development, since they only link the corresponding modules and thus might have faster compile times.

For example, you can run the square root solver with default parameters on one of the included test datasets with:

./bin/bal --input data/rootba/bal/ladybug/problem-49-7776-pre.txt

This generates a ba_log.json file with per-iteration log information that can be evaluated and visualized.

Config Options

Options can be configured in a rootba_config.toml configuration file or from the command line, where the command line takes precedence.

The --help command line argument provides comprehensive documentation of available options and you can generate a config file with default values with:

./bin/bal --dump-config --config /dev/null > rootba_config.toml

For futher details and a discussion of the options corresponding to the evaluated solver variants from the CVPR'21 paper see Configuration.md.

Visualization of Results

The different variants of bundle adjustment all log their progress to a ba_log.json or ba_log.ubjson file. Some basic information can be displayed with the plot-logs.py script:

./scripts/plot-logs.py ba_log.json

You can also pass multiple files, or folders, which are searched for ba_log.json and ba_log.ubjson files. In the plots, the name of the containing folder is used as a label for each ba_log.json file.

Let's run a small example and compare solver performance:

mkdir -p ../rootba_testing/qr32/
mkdir -p ../rootba_testing/sc64/
./bin/bal -C ../rootba_testing/qr32/ --no-use-double --input ../../rootba/data/rootba/bal/ladybug/problem-49-7776-pre.txt
./bin/bal -C ../rootba_testing/sc64/ --solver-type SCHUR_COMPLEMENT --input ../../rootba/data/rootba/bal/ladybug/problem-49-7776-pre.txt
./scripts/plot-logs.py ../rootba_testing/

On this small example problem both solvers converge to the same cost and are similarly fast:

Plots

Batch Evaluation

For scripts to run systematic experiments and do more sophisticated analysis of the generated log files, please follow the Batch Evaluation Tutorial.

This also includes instructions to reproduce the results presented in the CVPR'21 paper.

PDF Preview

There is a dedicated self-contained tutorial for reproducing the results presented in the CVPR'23 paper.

Repository Layout

The following gives a brief overview over the layout of top-level folders in this repository.

Code Layout

The main modules in the src folder are as follows.

Corresponding header and source files are found in the same folder with extension .hpp and .cpp. If there are corresponding unit tests they are found in the same folder with a .test.cpp file extension.

License

The code of the RootBA project is licensed under a BSD 3-Clause License.

Parts of the code are derived from Ceres Solver. Please also consider licenses of used third-party libraries. See ACKNOWLEDGEMENTS.