Skip to content

Commit d7033a1

Browse files
committed
adding to readme
1 parent 9e5344d commit d7033a1

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,14 @@ DynoSAM current provides full-batch and sliding-window optimisation procedures a
1515
The offical code used for our paper:
1616
- [Jesse Morris](https://jessemorris.github.io/), Yiduo Wang, Mikolaj Kliniewski, Viorela Ila, [*DynoSAM: Open-Source Smoothing and Mapping Framework for Dynamic SLAM*](https://arxiv.org/pdf/2501.11893), Arxiv. Submitted Transactions on Robotics (T-RO) Visual SLAM Special Issue (2025).
1717

18-
We kindly ask to cite our paper if you find this work useful:
18+
19+
#### ** Update September 2025 **
20+
This code now also contains the code for our new work
21+
- J.Morris, Y. Wang, V. Ila. [*Online Dynamic SLAM with Incremental Smoothing and Mapping*](https://www.arxiv.org/abs/2509.08197), Arxiv. Submitted RA-L (2025)
22+
23+
24+
We kindly ask to cite our papers if you find these works useful:
25+
1926

2027
```bibtex
2128
@@ -29,7 +36,14 @@ We kindly ask to cite our paper if you find this work useful:
2936
url={https://arxiv.org/abs/2501.11893},
3037
}
3138
39+
@article{morris2025online,
40+
title={Online Dynamic SLAM with Incremental Smoothing and Mapping},
41+
author={Morris, Jesse and Wang, Yiduo and Ila, Viorela},
42+
journal={arXiv preprint arXiv:2509.08197},
43+
year={2025}
44+
}
3245
```
46+
3347
## Related Publications
3448

3549
DynoSAM was build as a culmination of several works:
@@ -148,6 +162,18 @@ All the cmdline functionality can be replicated programtically using python in o
148162
See [run_experiments_tro.py](./dynosam_utils/src/run_experiments_tro.py) for examples.
149163

150164

165+
## Running different backends
166+
Most of the research here is associated with different backend formulations.
167+
To run the different backends set `--backend_updater_enum`
168+
169+
> NOTE: this enum value is mapped to the enum [RGBDFormulationType](./dynosam/include/dynosam/backend/RGBDBackendDefinitions.hpp)
170+
171+
- WCME (`backend_updater_enum=0`) and WCPE(`backend_updater_enum=1`) are from TRO-2025, ICRA 2024 and previous works
172+
- HYBRID (`backend_updater_enum=2`) and PARALLEL_HYBRID (`backend_updater_enum=3`) are from RA-L 2025
173+
174+
All others are internal/experimental.
175+
176+
151177
## Tests
152178
We use [gtest](https://github.com/google/googletest) for unit testing. This is installed automagically. When building with ROS, all tests will go into the install folder.
153179

@@ -294,6 +320,19 @@ This allows each data-loader to specfy/loaded the camera params from the dataset
294320

295321
# 4. Evaluation
296322

323+
## Replicating results from papers
324+
This code base contains implementations for many papers (as noted in Related Publications).
325+
The `main` or `devel` branches should be able to run each method as described in the papers, however their may be discrepencies as new updates are added to different parts of the system.
326+
327+
Additionally, I try to maintain backwards compatability as new code gets pushed to main but cannot ensure this.
328+
329+
See different package releases associated with a paper.
330+
331+
When running evaluations for each paper there usually is an associated python script that includes all the experiments.
332+
- [TRO 2025 experiments](./dynosam_utils/src/run_experiments_tro.py)
333+
- [RAL 2025 experiments](./dynosam_utils/src/run_experiments_ecmr.py)
334+
335+
297336
## Output logs
298337
When the DynoSAM pipeline is run it will output log files in the given output directory. The log files record the output of the state-estimation as well as various interal data.
299338
As mentioned, the output directory is specified by `--output_path=/path/to/results` (and may be further specified using `--name` when using `eval_launch.py`).

0 commit comments

Comments
 (0)