{"id":18792498,"url":"https://github.com/prbonn/overlap_localization","last_synced_at":"2025-04-09T10:09:52.008Z","repository":{"id":39854526,"uuid":"276891886","full_name":"PRBonn/overlap_localization","owner":"PRBonn","description":"chen2020iros: Learning an Overlap-based Observation Model for 3D LiDAR Localization.","archived":false,"fork":false,"pushed_at":"2023-03-24T22:26:57.000Z","size":15085,"stargazers_count":275,"open_issues_count":2,"forks_count":68,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-02T08:11:44.945Z","etag":null,"topics":["learning","lidar","localization","mcl","monte-carlo"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PRBonn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-03T12:13:55.000Z","updated_at":"2025-02-20T02:38:28.000Z","dependencies_parsed_at":"2024-11-07T21:33:24.332Z","dependency_job_id":null,"html_url":"https://github.com/PRBonn/overlap_localization","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRBonn%2Foverlap_localization","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRBonn%2Foverlap_localization/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRBonn%2Foverlap_localization/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PRBonn%2Foverlap_localization/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PRBonn","download_url":"https://codeload.github.com/PRBonn/overlap_localization/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018061,"owners_count":21034048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["learning","lidar","localization","mcl","monte-carlo"],"created_at":"2024-11-07T21:20:10.195Z","updated_at":"2025-04-09T10:09:51.975Z","avatar_url":"https://github.com/PRBonn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overlap-based 3D LiDAR Monte Carlo Localization\n\n\nThis repo contains the code for our IROS2020 paper: Learning an Overlap-based Observation Model for 3D LiDAR Localization.\n \nIt uses the [OverlapNet](https://github.com/PRBonn/OverlapNet) to train an observation model for Monte Carlo Localization and achieves global localization with 3D LiDAR scans.\n\nDeveloped by [Xieyuanli Chen](https://www.ipb.uni-bonn.de/people/xieyuanli-chen/) and [Thomas Läbe](https://www.ipb.uni-bonn.de/people/thomas-laebe/).\n\n\n\u003cimg src=\"data/demo.gif\" width=\"800\"\u003e\n\nLocalization results of overlap-based Monte Carlo Localization.\n\n\n## Publication\nIf you use our implementation in your academic work, please cite the corresponding [paper](https://www.ipb.uni-bonn.de/pdfs/chen2020iros.pdf):\n    \n\t@inproceedings{chen2020iros,\n\t\tauthor = {X. Chen and T. L\\\"abe and L. Nardi and J. Behley and C. Stachniss},\n\t\ttitle = {{Learning an Overlap-based Observation Model for 3D LiDAR Localization}},\n\t\tbooktitle = {Proceedings of the IEEE/RSJ Int. Conf. on Intelligent Robots and Systems (IROS)},\n\t\tyear = {2020},\n\t\turl={https://www.ipb.uni-bonn.de/pdfs/chen2020iros.pdf},\n\t}\n\n## Dependencies\n\nWe are using standalone Keras with a TensorFlow backend as a library for neural networks. \n\nThe code was tested with Ubuntu **18.04** with its standard python version **3.6**.\n\nIn order to do training and testing on a whole dataset, you need an Nvidia GPU.\n\nTo use a GPU, first you need to install the Nvidia driver and CUDA, so have fun!\n\n- CUDA Installation guide: [link](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html)\n\n- System dependencies:\n\n  ```bash\n  sudo apt-get update \n  sudo apt-get install -y python3-pip python3-tk\n  sudo -H pip3 install --upgrade pip\n  ```\n\n- Python dependencies (may also work with different versions than mentioned in the requirements file)\n\n  ```bash\n  sudo -H pip3 install -r requirements.txt\n  ```\n\n- OverlapNet: To use this implementation, one needs to clone OverlapNet to the local folder by:\n  ```bash\n  git clone https://github.com/PRBonn/OverlapNet\n  ```\n\n## How to use\n\n#### Quick use\nFor a quick demo, one could download the [feature volumes](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/feature_volumes.zip) and pre-trained sensor [model](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/model.weight), extract the feature volumes in the `/data` folder following the recommended [data structure](data/README.md), and then run:\n  ```bash\n  cd src/\n  python3 main_overlap_mcl.py\n  ```\nOne could then get the online visualization of overlap-based MCL as shown in the gif.\n\n#### More detailed usage\nFor more details about the usage and each module of this implementation, one could find them in MCL [README.md](src/README.md).\n\n#### Train a new observation model\nTo train a new observation model, one could find more information in prepare_training [README.md](src/prepare_training/README.md).\n\n#### Collection of preprocessed data\n- KITTI Odometry Sequence 07: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/kitti_07.zip).\n- Pre-trained Sensor Model: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/model.weight).\n- Feature Volumes: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/feature_volumes.zip).\n- Map Data: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/map.zip).\n- Query Data: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/query.zip).\n- Training Data: [download](https://www.ipb.uni-bonn.de/html/projects/overlap_mcl/training.zip).\n\n## License\n\nCopyright 2020, Xieyuanli Chen, Thomas Läbe, Cyrill Stachniss, Photogrammetry and Robotics Lab, University of Bonn.\n\nThis project is free software made available under the MIT License. For details see the LICENSE file.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprbonn%2Foverlap_localization","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprbonn%2Foverlap_localization","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprbonn%2Foverlap_localization/lists"}