Example datasets included in pypillometry#
pypillometry comes with a set of example datasets so that you can start trying out the package right away.
Small datasets are included in the package itself; larger ones are downloaded from OSF the first time they are requested and stored in a cache directory (~/.cache/pypillometry by default), so later calls do not download them again.
[1]:
import pypillometry as pp
You can get an overview of all available datasets with get_available_datasets():
[2]:
pp.get_available_datasets()
[2]:
| Dataset | Type | Description | |
|---|---|---|---|
| 0 | rlmw_002 | ASC (OSF) | Binocular data from a 20-minute reinforcement ... |
| 1 | rlmw_002_short | ASC (local) | Short version (first 40 sec) of a 20-minute re... |
| 2 | rlmw_010_edf | EDF | Binocular data from a 20-minute reinforcement ... |
Using the identifier in the first column, you can load a dataset with get_example_data(). The result is a regular EyeData object:
[3]:
d = pp.get_example_data("rlmw_002_short")
d
[3]:
EyeData — rlmw_002_short
Samples
20,465
Sampling rate
500.0 Hz
Duration
0.68 min (start 0.00, end 0.68)
Eyes
left, right
Variables
left_x, left_y, left_pupil, right_x, right_y, right_pupil
Events
40
Size
1.4MiB
Signal overview
left_pupil
left_x
left_y
right_pupil
right_x
right_y
Data glimpse
EyeDataDict(vars=6,n=20465,shape=(20465,)): left_x (float64): 655.6, 655.7, 655.0, 654.5, 655.0... left_y (float64): 599.9, 598.9, 597.6, 597.8, 597.8... left_pupil (float64): 1121.0, 1122.0, 1124.0, 1126.0, 1126.0... right_x (float64): 773.1, 773.8, 774.8, 776.3, 776.7... right_y (float64): 594.2, 593.9, 596.5, 597.4, 597.3... right_pupil (float64): 949.0, 951.0, 956.0, 959.0, 960.0...
Recent history
- reset_time()
The full-length version ("rlmw_002", about 20 minutes) is downloaded from OSF on first use. If you want to store downloads somewhere else than in the default cache directory, use the cache_dir= argument:
d = pp.get_example_data("rlmw_002", cache_dir="example_data")