{"id":29115638,"url":"https://github.com/tub-rip/event_based_bos","last_synced_at":"2025-06-29T11:13:23.558Z","repository":{"id":204798465,"uuid":"643498781","full_name":"tub-rip/event_based_bos","owner":"tub-rip","description":"Event-based Background-Oriented Schlieren (IEEE TPAMI 2023)","archived":false,"fork":false,"pushed_at":"2025-03-12T22:39:31.000Z","size":229,"stargazers_count":21,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T23:28:03.576Z","etag":null,"topics":["air-convection","background-oriented-schlieren","co-capture-system","event-based-vision","event-camera","event-data","events-and-frames","motion-estimation","optical-flow","schlieren"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tub-rip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-05-21T11:07:28.000Z","updated_at":"2025-03-12T22:39:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"fc6bfec5-5d61-49cc-b1d7-58310259536c","html_url":"https://github.com/tub-rip/event_based_bos","commit_stats":null,"previous_names":["tub-rip/event_based_bos"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tub-rip/event_based_bos","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tub-rip%2Fevent_based_bos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tub-rip%2Fevent_based_bos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tub-rip%2Fevent_based_bos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tub-rip%2Fevent_based_bos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tub-rip","download_url":"https://codeload.github.com/tub-rip/event_based_bos/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tub-rip%2Fevent_based_bos/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262581512,"owners_count":23331925,"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":["air-convection","background-oriented-schlieren","co-capture-system","event-based-vision","event-camera","event-data","events-and-frames","motion-estimation","optical-flow","schlieren"],"created_at":"2025-06-29T11:13:10.848Z","updated_at":"2025-06-29T11:13:23.437Z","avatar_url":"https://github.com/tub-rip.png","language":"Python","funding_links":[],"categories":["Schlieren Imaging"],"sub_categories":[],"readme":"# Event-based Background-Oriented Schlieren\n\nThis is the official repository for [**Event-based Background-Oriented Schlieren**](https://doi.org/10.1109/TPAMI.2023.3328188), **IEEE T-PAMI 2023** by  \n[Shintaro Shiba](http://shibashintaro.com/), [Friedhelm Hamann](https://friedhelmhamann.github.io/), [Yoshimitsu Aoki](https://aoki-medialab.jp/aokiyoshimitsu-en/) and [Guillermo Callego](http://www.guillermogallego.es).\n\n\u003ch2 align=\"left\"\u003e\n  \n[Paper](https://arxiv.org/pdf/2311.00434) | [Video](https://youtu.be/Ev52n8KgxIU) | [Dataset](https://doi.org/10.14279/depositonce-19492) | [News](https://www.tu.berlin/en/about/profile/press-releases-news/schlierenfotografie)\n\u003c/h2\u003e\n\n[![Event-based Background-Oriented Schlieren](docs/img/event_based_bos_pami23.jpg)](https://youtu.be/Ev52n8KgxIU)\n\n\nIf you use this work in your research, please cite it (see also [here](#citation)):\n\n```bibtex\n@Article{Shiba23pami,\n  author        = {Shintaro Shiba and Friedhelm Hamann and Yoshimitsu Aoki and Guillermo Gallego},\n  title         = {Event-based Background-Oriented Schlieren},\n  journal       = {IEEE Trans. Pattern Anal. Mach. Intell. (T-PAMI)},\n  year          = {2024},\n  volume        = {46},\n  number        = {4},\n  pages         = {2011-2026},\n  doi           = {10.1109/TPAMI.2023.3328188}\n}\n```\n\n-------\n# Setup\n\n## Requirements\n\n- python: 3.8.x, 3.9.x, 3.10.x\n\n- [ffmpeg](https://ffmpeg.org/) ... This is necessary for `ffmpeg-python`.\n\n### Tested environments\n\n- Mac OS Monterey (both M1 and non-M1)\n- Ubuntu (CUDA 11.1, 11.3, 11.8)\n- PyTorch 1.9-1.12.1, or PyTorch 2.0.\n\n## Installation\n\n### Quick setup\n\nMinimal quick setup is to use [venv](https://docs.python.org/3/library/venv.html).\n\n```shell\npython3 -m venv ~/work/venv\nsource ~/work/venv/bin/activate  # activate env\npython3 -V  # make sure the version, 3.8 or higher\npip3 install scipy==1.9.1 optuna==2.10.1 opencv-python matplotlib plotly \\\nffmpeg-python h5py hdf5plugin PyYAML Pillow sklearn scikit-image argparse openpiv \\\ntorch torchvision black isort kaleido\n```\n\n### Full setup\n\nYou can use [poetry](https://python-poetry.org/docs/).\n\n```shell\npoetry install\n```\n\nThis install dev dependencies (format, test) too.\n\n## Download dataset\n\nPlease download the dataset and put into your local folder. You can download the files from [the official source](https://doi.org/10.14279/depositonce-19492) or [Google Drive](https://drive.google.com/drive/folders/1kMnCKRI6QE8AmtxXe_jU9DTjlMbldpZM?usp=sharing)\nThe structure of the folder is as follows:\n\n```shell\n(root)/datasets/\n    CCS/   # fixed keyword: dataset recorded with the co-capture system (CCS).\n        (sequence_name)/\n            basler_0/\n                frames.mp4          # frame data\n                config.yaml\n            prophesee_0/\n                cd_events.raw       # event data in .raw format (Prophesee)\n                events.hdf5         # event data converted in HDF5 format\n                trigger_events.txt\n            homography.txt          # calibration file\n```\n\n## EBOS dataset recorded with Co-Capture System (CCS)\n\nThe Prophesee camera provides `.raw` format file, which requires to install `OpenEB`.\nWe converted this file into hdf5 file formats for better compatibility among languages and OS.\nSo, there is no need to install OpenEB.\n\n# Execution\n\n## Run\n\nAn example is:\n\n```shell\npython3 bos_event.py --config_file ./configs/hot_plate1.yaml --eval\n```\n\n## Config\n\nThe configuration for each experiment is provided to the script through yaml files.\n\nPlease see the [readme](./configs/README.md).\n\n## Development\n\nNote you use poetry for development.\n\n## Format\n\nYou can quickly run format of the codes:\n\n```shell\nmake fmt\n```\n\n\u003c!--\n# Citation\n\nIf you use this work in your research, please cite it as follows:\n\n```bibtex\n@Article{Shiba23pami,\n  author        = {Shintaro Shiba and and Friedhelm Hamann and Yoshimitsu Aoki and Guillermo Gallego},\n  title         = {Event-based Background-Oriented Schlieren},\n  booktitle     = {IEEE T-PAMI},\n  pages         = {},\n  doi           = {10.1109/TPAMI.2023.3328188},\n  year          = 2023\n}\n```\n--\u003e\n\n# Code Authors\n\n- [@shiba24](https://github.com/shiba24)\n- [@FriedhelmHamann](https://github.com/FriedhelmHamann)\n\n## LICENSE\n\nPlease check [License](./LICENSE).\n\n-------\n# Additional Resources\n\n* [CoCapture: GUI for recording with multi camera systems.](https://github.com/tub-rip/CoCapture)\n* [Secrets of Event-Based Optical Flow (TPAMI 2024)](https://github.com/tub-rip/event_based_optical_flow)\n* [Motion-prior Contrast Maximization (ECCV 2024)](https://github.com/tub-rip/MotionPriorCMax)\n* [Event Collapse in Contrast Maximization Frameworks](https://github.com/tub-rip/event_collapse)\n* [EVILIP: Event-based Image Reconstruction as a Linear Inverse Problem (TPAMI 2022)](https://github.com/tub-rip/event_based_image_rec_inverse_problem)\n* [EPBA: Event-based Photometric Bundle Adjustment](https://github.com/tub-rip/epba)\n* [Research page (TU Berlin, RIP lab)](https://sites.google.com/view/guillermogallego/research/event-based-vision)\n* [Research page (Keio University, Aoki Media Lab)](https://aoki-medialab.jp/home-en/)\n* [Course at TU Berlin](https://sites.google.com/view/guillermogallego/teaching/event-based-robot-vision)\n* [Survey paper](http://rpg.ifi.uzh.ch/docs/EventVisionSurvey.pdf)\n* [List of Resources](https://github.com/uzh-rpg/event-based_vision_resources)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftub-rip%2Fevent_based_bos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftub-rip%2Fevent_based_bos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftub-rip%2Fevent_based_bos/lists"}