PiVR: virtual reality for small animals¶
The Raspberry Pi based Virtual Reality system (PiVR) is a virtual reality system for small animals. It has been developed by David Tadres and Matthieu Louis (Louis Lab).
The tool has been published in PLOS Biology: PiVR: An affordable and versatile closed-loop platform to study unrestrained sensorimotor behavior.
The code is open source (BSD license)
The source code for all the PiVR software can be found on Gitlab
You can also find a Bug Tracker on Gitlab
What can PiVR do?¶
PiVR has been used to create virtual odor realities for fruit fly larvae.¶
PiVR has also been used to create virtual taste realities for adult fruit flies.¶
PiVR was also used to create a virtual light bulb for a number of animals, including larval zebrafish.¶
PiVR is also able to create dynamic virtual gradients¶
While it is often convenient to present static virtual gradients (see examples above) animals usually have to navigate an environment that is changing over time. PiVR is able to present animals with dynamic virtual realities.
We presented Drosophila larva expressing the optogenetic tool Chrimson in the Or42a olfactory sensory neuron with a dynamic odor plume based on the measurement of a real odor plume (Álvarez-Salvado et. al.,). PiVR thus enables researchers to study how Drosophila larvae are orienting themselves in a more naturalistic environments.
How does it work?¶
PiVR combines high speed/low latency tracking with temporally defined light stimuli to create arbitrary virtual realities.
PiVR is capable of tracking Drosophila larvae, adult flies, zebrafish and many other small animals.
The position of the animal in the real world is then mapped onto the user provided virtual reality and the appropriate stimulus is presented.
Sounds great. I want one! How?¶
PiVR has been designed to make building one as easy as possible so that you do not spend a lot of time building the setup and spend more time running experiments.
Please follow the Build your own PiVR to see step-by-step instructions on how to build your own PiVR setup.
Don’t worry, it’s not hard and it won’t take too long. Please see the timelapse video below for an example of one setup being built: from 3D printing to running experiments!
I’ve got a setup. How do I use it?¶
If you are a first time user, check out the Step-By-Step Guide which will walk you through each of the four recording modes:
You have just run an experiment. What to make of the output data? See here to understand what each output file means and what it contains.
To see how PiVR can help you analyse data check out the tools available on the PC version of PiVR.
If you are running into trouble with the closed loop tracking, please head over to How to simulate real time tracking.
If you want to understand what each button in the GUI is doing, please see the PiVR Software Manual.
If you want to gain a high-level understanding on how the code identifies the animal and tracks them please read the Code Explanation
- PiVR: virtual reality for small animals
- 1. Build your own PiVR
- 2. Bill of Materials (BOM)
- 3. Step-by-step experimental guide
- 4. Code explanation
- 5. PiVR Software Manual
- 6. Explanation of PiVR output
- 7. Tools
- 8. Advanced topics
- 9. PiVR software installation
- 10. PiVR software documentation
- 11. PiVR Benchmark
- 12. FAQ
- 13. Contact
- 14. Community Building
- 15. Legacy Options