Welcome to Stytra’s documentation!¶
Stytra is a package to build and run behavioral experiments.
Contents:
- Installation guide
- Examples gallery
- Stimulation
- Configuring a computer for Stytra experiments
- Data and metadata saving
- Calibration
- Triggering a Stytra protocol
- Parameters in stytra
- A note on coordinate systems in Stytra
- Hardware description
- Stytra user interface
- Image processing pipelines
- Configuring tracking of freely-swimming fish
- Configuring tracking of embedded fish
- Replaying the camera feed to refine tracking
Modules¶
stytra- The root module, contains the Stytra class for running the experiment (selecting the appropriate experiment subtypes and setting the parameters)
stytra.experiments- The controller classes organizing different kinds of experiments (with and without behavioral tracking, closed loop stimulation and with video recording). The classes put together everything required for a particular kind of experiment
stytra.gui- Defines windows and widgets used for the different experiment types
stytra.hardware- Communication with external hardware, from cameras to NI boards
stytra.triggering- Communication with other equipment for starting or stopping experiments
stytra.metadata- Classes that manage the metadata
stytra.stimulation- Definitions of various stimuli and management of experimental protocols
stytra.calibration- Classes to register the camera view to the projector display and set physical dimensions
stytra.tracking- Fish, eye and tail tracking functions together with appropriate interfaces