manif

A small header-only library for Lie theory

Package Summary

manif is a Lie theory library for state-estimation targeted at robotics applications. It is developed as a header-only C++11 library with Python 3 wrappers.

At the moment, it provides the groups:

ℝ(n): Euclidean space with addition.
SO(2): rotations in the plane.
SE(2): rigid motion (rotation and translation) in the plane.
SO(3): rotations in 3D space.
SE(3): rigid motion (rotation and translation) in 3D space.
SE_2(3): extended pose (rotation, translation and velocity) in 3D space, introduced (to the best of knowledge) in this paper. NOTE: The implementation here differs slightly from the developments in the paper.
SGal(3): The Special Galilean group (rotation, translation, velocity and time) in 3D space, described in these papers [1] & [2].
Bundle<>: allows manipulating a manifold bundle as a single Lie group. Referred to as a composite manifold in Section IV of the reference paper.

Other Lie groups can and will be added, contributions are welcome.

manif is based on the mathematical presentation of the Lie theory available in this paper. We recommend every user of manif to read the paper (17 pages) before starting to use the library. The paper provides a thorough introduction to Lie theory, in a simplified way so as to make the entrance to Lie theory easy for the average roboticist who is interested in designing rigorous and elegant state estimation algorithms.

You may also find the following video online, 'Lie theory for the roboticist', a lecture given at IRI-UPC. In a rush? Check out our Lie group cheat sheet.

It provides analytic computation of Jacobians for all the operations listed below.

Details

Maintainer status: maintained
Maintainer: Jeremie Deray
Authors:
- Jeremie Deray deray.jeremie@gmail.com
- Joan Sola jsola@iri.upc.edu
License: MIT
Bug / feature tracker: github.com/artivis/manif/issues
Source: github.com/artivis/manif.git (branch: devel)

Quick Start

Get quickly started with manif following our 'quick start' guides for both C++ and Python.

Features

Available Operations

Operation		Code
	Base Operation
Inverse	$\mathbf\Phi^{-1}$	`X.inverse()`
Composition	$\mathbf\mathcal{X}\circ\mathbf\mathcal{Y}$	`X * Y` `X.compose(Y)`
Hat	$\varphi^\wedge$	`w.hat()`
Act on vector	$\mathbf\mathcal{X}\circ\mathbf v$	`X.act(v)`
Retract to group element	$\exp(\mathbf\varphi^\wedge$	`w.exp()`
Lift to tangent space	$\log(\mathbf\mathcal{X})^\vee$	`X.log()`
Manifold Adjoint	$\operatorname{Adj}(\mathbf\mathcal{X})$	`X.adj()`
Tangent adjoint	$\operatorname{adj}(\mathbf\varphi^\wedge$	`w.smallAdj()`
	Composed Operation
Manifold right plus	$\mathbf\mathcal{X}\circ\exp(\mathbf\varphi^\wedge)$	`X + w` `X.plus(w)` `X.rplus(w)`
Manifold left plus	$\exp(\mathbf\varphi^\wedge)\circ\mathbf\mathcal{X}$	`w + X` `w.plus(X)` `w.lplus(X)`
Manifold right minus	$\log(\mathbf\mathcal{Y}^{-1}\circ\mathbf\mathcal{X})^\vee$	`X - Y` `X.minus(Y)` `X.rminus(Y)`
Manifold left minus	$\log(\mathbf\mathcal{X}\circ\mathbf\mathcal{Y}^{-1})^\vee$	`X.lminus(Y)`
Between	$\mathbf\mathcal{X}^{-1}\circ\mathbf\mathcal{Y}$	`X.between(Y)`
Inner Product	$\langle\varphi,\tau\rangle$	`w.inner(t)`
Norm	$\left\lVert\varphi\right\rVert$	`w.weightedNorm()` `w.squaredWeightedNorm()`

Above, $\mathbf\mathcal{X},\mathbf\mathcal{Y}$ represent group elements, $\mathbf\varphi^\wedge,\tau^\wedge$ represent elements in the Lie algebra of the Lie group, $\mathbf\varphi,\tau$ or w,t represent the same elements of the tangent space but expressed in Cartesian coordinates in $\mathbb{R}^n$ , and $\mathbf{v}$ or v represents any element of $\mathbb{R}^n$ .

Jacobians

All operations come with their respective analytical Jacobian matrices. Throughout manif, Jacobians are differentiated with respect to a local perturbation on the tangent space. These Jacobians map tangent spaces, as described in this paper.

Currently, manif implements the right Jacobian, whose definition reads:

$\frac{\delta f(\mathbf\mathcal{X})}{\delta\mathbf\mathcal{X}}$

The Jacobians of any of the aforementionned operations can then be evaluated:

in C++,

  SE3d X = SE3d::Random();
  SE3Tangentd w = SE3Tangentd::Random();

  SE3d::Jacobian J_o_x, J_o_w;

  auto X_plus_w = X.plus(w, J_o_x, J_o_w);

in Python,

  X = SE3.Random()
  w = SE3Tangentd.Random()

  J_o_x = np.zeros((SE3.DoF, SE3.DoF))
  J_o_w = np.zeros((SE3.DoF, SE3.DoF))

  X_plus_w = X.plus(w, J_o_x, J_o_w)

Note

While Jacobians in manif are differentiated with respect to a local perturbation on the tangent space, many non-linear solvers (e.g. Ceres) expect functions to be differentiated with respect to the underlying representation vector of the group element (e.g. with respect to quaternion vector for SO3).

For this reason, manif is compliant with the auto-differentiation libraries ceres::Jet, autodiff::Dual & autodiff::Real.

Documentation

The documentation is available online at the accompanying website. Both the C++ and the Python APIs are documented.

Do you want to build it locally? Find out how on the dedicated page.

Note: throughout the code documentation we refer to 'the paper' which you can find on the dedicated page.

Tutorials and application demos

We provide some self-contained and self-explained C++ examples to help you get started.

You prefer Python? The same examples are also available in Python.

Publications

Check out our related publications and how to cite them.

They use manif

Find out who's already using manif.

Contributing

Want to contribute? Great! Check out our contribution guidelines.

sailfish009/manif