Skip to content

Commit

Permalink
[MAINT] Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
AlessandroFornasier committed Nov 20, 2023
1 parent f7c5314 commit 178e5f5
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It is based on the recent advances in equivaraint inertial navigation systems [[
- Supports unit-plane projection method
- Supports anchored euclidean, anchored inverse depth and anchored polar feature representation methods
- Includes a static initialization routine as well as parametric initialization with custom origin
- Includes an equivariant zero-velocity update routine
- Includes an equivariant zero velocity update routine

### Vision frontend features

Expand All @@ -27,6 +27,15 @@ It is based on the recent advances in equivaraint inertial navigation systems [[
- Supports different features detector including FAST and Shi-Tomasi
- Supports different image enhancment tecniques, including Histogram and CLAHE

### Future roadmap

- [x] ROS1 wrapper
- [x] ROS2 wrapper
- [x] Equivariant Zero velocity Update (EqZVU)
- [ ] Unit-sphere projection method support
- [ ] Equivariant Persistent (SLAM) features update support


## Dependencies

MSCEqF has the following dependencies which are automatically downloaded and linked against:
Expand Down Expand Up @@ -54,7 +63,10 @@ $ cd msceqf/build/<build_type>
$ ./msceqf_tests
```

### Run example
### Run example (Euroc)

After downloading the [Euroc](https://projects.asl.ethz.ch/datasets/doku.php?id=kmavvisualinertialdatasets) follows

```sh
$ cd msceqf/build/<build_type>
$ ./msceqf_euroc <sequence_name> <euroc_dataset_folder> <euroc_example_folder>
Expand Down Expand Up @@ -87,6 +99,12 @@ $ xhost +
$ docker run --net=host -it --gpus all --env="NVIDIA_DRIVER_CAPABILITIES=all" --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" msceqf:ros<ros_version> .
```

If Nvidia drivere are not supported, simply run docker as follows

```sh
$ docker run --net=host -it --gpus all --env="NVIDIA_DRIVER_CAPABILITIES=all" --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" msceqf:ros<ros_version> .
```

## License

This software is made available to the public to use (source-available), licensed under the terms of the BSD-2-Clause-License with no commercial use allowed, the full terms of which are made available in the [LICENSE](LICENSE) file.
Expand All @@ -98,7 +116,6 @@ If you use this software in an academic research setting, please cite the corres
@article{fornasier2023msceqf,
title={MSCEqF: A Multi State Constraint Equivariant Filter for Vision-aided Inertial Navigation},
author={Fornasier, Alessandro and van Goor, Pieter and Allak, Eren and Mahony, Robert and Weiss, Stephan},
journal={arXiv preprint arXiv:XXXX.XXXXX},
year={2023}
}
Expand Down

0 comments on commit 178e5f5

Please sign in to comment.