diff --git a/allensdk/core/brain_observatory_cache.py b/allensdk/core/brain_observatory_cache.py index 3d66ae615..9c80c0630 100644 --- a/allensdk/core/brain_observatory_cache.py +++ b/allensdk/core/brain_observatory_cache.py @@ -654,9 +654,19 @@ def get_eye_tracking(self, ophys_experiment_id) -> np.ndarray: Returns ------- `numpy.ndarray` - Contents of array unknown. Assumed to be [n_frames, 5] where - the meaning of the values in each column are unknown. - Ask Saskia De Vries saskiad@alleninstitute.org + Shape of array is (n_frames, 5); axis=1 stores the following: + [:, 0] is the 2-photon frame number. Can be parsed as int and + used to index calcium imaging dF/F arrays, for example. + [:, 1] is the computed eye area in cm^2 + [:, 2] is the pupil area in cm^2 + [:, 3] is the x (azimuth) position of the pupil in degrees + [:, 4] is the y (altitude) position of the pupil in degrees + Metrics are computed using DeepLabCut (Mathis et al., 2018, Nature) + from videos of the mouse's eye during experimentation. + See King et al., 2023, eNeuro, and de Vries et al., 2018, Nature + for more info on eye tracking methods. + Contact saskiad@alleninstitute.org, chase.king@alleninstitute.org + with any questions. """ cloud_cache = S3CloudCache( cache_dir=Path(self.manifest_path).parent / "s3_cache",