Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide accurate documentation for brain_observatory_cache.get_eye_tracking #2740

Open
wants to merge 5 commits into
base: rc/2.16.3
Choose a base branch
from
Open

Provide accurate documentation for brain_observatory_cache.get_eye_tracking #2740

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57832ed
Update get_eye_tracking method in brain observatory cache with more d…
chaseking Jan 7, 2024
256826c
Better DLC notes
chaseking Jan 7, 2024
7cc4d37
Notes on frame number
chaseking Jan 7, 2024
faacaed
Fix notes on frame
chaseking Jan 7, 2024
359b54b
Fix max line width
chaseking Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions allensdk/core/brain_observatory_cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
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 [email protected], [email protected]
with any questions.
"""
cloud_cache = S3CloudCache(
cache_dir=Path(self.manifest_path).parent / "s3_cache",
Expand Down
Loading