FreemoVR is a system for creating virtual reality for freely moving animals.
The principle of operation is that a realtime animal tracker provides near-instantaneous 3D animal position data to a realtime rendering engine, which draws perspective-correct visual stimuli for the animal on the walls using calibrated computer displays.
"FreemoVR" itself refers to a system of several components:
-
The FreemoVR engine draws the visual stimuli, and can use different tracking systems to provide position input.
-
Flydra is used as the source of 3D position input in most of our work.
This repository hold information relevant to the entire system rather than about any specific part. Most of the source code will be in the individual code repositories, but it makes sense to have a top-level repository for documentation and issues related to the combined system.
For questions or discussion, please use the "freemovr" Google Group.
For installation, we recommend using our Ansible
playbooks. In particular,
the ros-kinetic-freemovr-engine role or the ros-kinetic-freemovr role install
either the FreemoVR engine alone or a full FreemoVR system, including
flydra (on Ubuntu 16.04 with ROS Kinetic).
FreemoVR is described in the following paper:
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 (2017) doi:10.1038/nmeth.4399.
Please cite this if you use FreemoVR.
The software, documentation and other resouces are licensed under either of
- 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) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Anyone who interacts with FreemoVR in any space including but not limited to this GitHub repository is expected to follow our code of conduct.