Strand Camera is low-latency camera acquisition and tracking software. It is useful for 2D tracking of animals, robots, or other moving objects. It also serves as the basis for 3D tracking using Braid.
Braid is multi-camera acquisition and tracking software. It is useful for 3D tracking of animals, robots, or other moving objects. It operates with low latency and is suitable for closed-loop experimental systems such as virtual reality for freely moving animals.
This repository is a mono repository that houses the source code for both pieces of software as well as many other related pieces, mostly written as Rust crates.
Users, as opposed to developers, of this software should refer to the docs/user-docs directory which contains user documentation and scripts for interacting with the software and performing data analysis.
| Category | Type | Path | Description |
|---|---|---|---|
| User | User Guide | docs/user-docs/users-guide/src/*.md | Installation, calibration, and troubleshooting |
| User | General | docs/user-docs/README.md | Introduction to user package |
| User | Main | README.md | Repository entry point |
| Dev | Architecture | docs/developer-docs/repository-organization.md | Monorepo structure and components |
| Dev | Component | Various README.md |
Library APIs and build instructions |
| Dev | Notes | scratch/*.md | Technical investigations and brainstorming |
| Dev | History | CHANGELOG.md | Versioning and change history |
| Dev | Schema | braid/braid-types/braidz-schema.md | braidz data format specification |
| Dev | Legal | LICENSE.txt, code_of_conduct.md | Licensing and contribution guidelines |
While a new publication specifically about Braid should be written, in the meantime, please cite the following paper about the predecessor to Braid:
- Straw AD, Branson K, Neumann TR, Dickinson MH. Multicamera Realtime 3D Tracking of Multiple Flying Animals. Journal of The Royal Society Interface 8(11), 395-409 (2011) doi:10.1098/rsif.2010.0230
If you additionally make use of 3D tracking of objects under water with cameras above water (i.e. perform fish tracking), please additionally cite this:
- Stowers JR*, Hofbauer M*, Bastien R, Griessner J⁑, Higgins P⁑, Farooqui S⁑, Fischer RM, Nowikovsky K, Haubensak W, Couzin ID, Tessmar-Raible K✎, Straw AD✎. Virtual Reality for Freely Moving Animals. Nature Methods 14, 995–1002 (2017) doi:10.1038/nmeth.4399
Please see the Installation section of our User Guide.
Please see docs/developer-docs/building-for-development.md for detailed instructions.
This software is developed by Prof. Dr. Andrew Straw at the University of Freiburg, Germany.
This open-source software is distributable under the terms of the Affero General Public License v1.0 only. See COPYRIGHT and LICENSE.txt for more details.
We have a goal to release many of the generally useful crates under licenses such as the MIT license, the Apache License (Version 2.0), and BSD-like licenses. Please get in touch if there are specific pieces of code where this would be helpful so we can judge interest and prioritize this.
Any kinds of contributions are welcome as a pull request.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this software by you, as defined in the Apache-2.0 license, shall be dual licensed under the terms of the
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
without any additional terms or conditions. (This helps us realize the future license plans as described above.)
Anyone who interacts with this software in any space, including but not limited to this GitHub repository, must follow our code of conduct.