Skip to content

Commit

Permalink
feat: Add gaze.from_ipc() (#568)
Browse files Browse the repository at this point in the history
  • Loading branch information
@prassepaul
prassepaul authored Sep 22, 2023
1 parent 869534f commit 4edba55
Show file tree
Hide file tree
Showing 8 changed files with 138 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/source/bibliography.bib
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ @article{GazeOnFaces
number={14},
pages={16--16},
year={2016},
publisher={The Association for Research in Vision and Ophthalmology}
publisher={The Association for Research in Vision and Ophthalmology},
}
2 changes: 2 additions & 0 deletions src/pymovements/gaze/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
from pymovements.gaze.integration import from_numpy
from pymovements.gaze.integration import from_pandas
from pymovements.gaze.io import from_csv
from pymovements.gaze.io import from_ipc
from pymovements.gaze.screen import Screen


Expand All @@ -75,4 +76,5 @@
'transforms_numpy',
'transforms',
'from_csv',
'from_ipc',
]
83 changes: 69 additions & 14 deletions src/pymovements/gaze/io.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,14 @@ def from_csv(
│ i64 ┆ i64 ┆ i64 │
╞══════╪════════════╪════════════╡
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 1 ┆ 0 ┆ 0 │
│ 2 ┆ 0 ┆ 0 │
│ 3 ┆ 0 ┆ 0 │
│ … ┆ … ┆ … │
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 0 ┆ 0 ┆ 0 │
│ 6 ┆ 0 ┆ 0 │
│ 7 ┆ 0 ┆ 0 │
│ 8 ┆ 0 ┆ 0 │
│ 9 ┆ 0 ┆ 0 │
└──────┴────────────┴────────────┘
We can now load the data into a ``GazeDataFrame`` by specyfing the experimental setting
Expand All @@ -132,14 +132,14 @@ def from_csv(
│ i64 ┆ list[i64] │
╞══════╪═══════════╡
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 1 ┆ [0, 0] │
│ 2 ┆ [0, 0] │
│ 3 ┆ [0, 0] │
│ … ┆ … │
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 0 ┆ [0, 0] │
│ 6 ┆ [0, 0] │
│ 7 ┆ [0, 0] │
│ 8 ┆ [0, 0] │
│ 9 ┆ [0, 0] │
└──────┴───────────┘
"""
Expand All @@ -158,3 +158,58 @@ def from_csv(
acceleration_columns=acceleration_columns,
)
return gaze_df


def from_ipc(
file: str | Path,
experiment: Experiment | None = None,
**read_ipc_kwargs: Any,
) -> GazeDataFrame:
"""Initialize a :py:class:`pymovements.gaze.gaze_dataframe.GazeDataFrame`.
Parameters
----------
file:
Path of IPC/feather file.
experiment : Experiment
The experiment definition.
**read_ipc_kwargs:
Additional keyword arguments to be passed to polars to read in the ipc file.
Examples
--------
Let's assume we have an IPC file stored at `tests/gaze/io/files/monocular_example.feather`.
We can then load the data into a ``GazeDataFrame``:
>>> from pymovements.gaze.io import from_ipc
>>> gaze = from_ipc(
... file='tests/gaze/io/files/monocular_example.feather',
... )
>>> gaze.frame
shape: (10, 2)
┌──────┬───────────┐
│ time ┆ pixel │
│ --- ┆ --- │
│ i64 ┆ list[i64] │
╞══════╪═══════════╡
│ 0 ┆ [0, 0] │
│ 1 ┆ [0, 0] │
│ 2 ┆ [0, 0] │
│ 3 ┆ [0, 0] │
│ … ┆ … │
│ 6 ┆ [0, 0] │
│ 7 ┆ [0, 0] │
│ 8 ┆ [0, 0] │
│ 9 ┆ [0, 0] │
└──────┴───────────┘
"""
# read data
gaze_data = pl.read_ipc(file, **read_ipc_kwargs)

# create gaze data frame
gaze_df = GazeDataFrame(
gaze_data,
experiment=experiment,
)
return gaze_df
18 changes: 9 additions & 9 deletions tests/gaze/io/files/binocular_example.csv
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
time,x_left_pix,y_left_pix,x_right_pix,y_right_pix,x_left_pos,y_left_pos,x_right_pos,y_right_pos
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
0,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
1,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
2,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
3,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
4,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
5,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
6,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
7,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
8,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
9,0,0,0,0,-23.104783, -13.489493,-23.104783, -13.489493
Binary file added tests/gaze/io/files/binocular_example.feather
View file
Binary file not shown.
18 changes: 9 additions & 9 deletions tests/gaze/io/files/monocular_example.csv
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
time,x_left_pix,y_left_pix
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
0,0,0
1,0,0
2,0,0
3,0,0
4,0,0
5,0,0
6,0,0
7,0,0
8,0,0
9,0,0
Binary file added tests/gaze/io/files/monocular_example.feather
View file
Binary file not shown.
48 changes: 48 additions & 0 deletions tests/gaze/io/ipc_test.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Copyright (c) 2023 The pymovements Project Authors
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Test read from IPC/feather."""
import pytest

import pymovements as pm


@pytest.mark.parametrize(
('kwargs', 'shape'),
[
pytest.param(
{
'file': 'tests/gaze/io/files/monocular_example.feather',
},
(10, 2),
id='feather_mono_shape',
),
pytest.param(
{
'file': 'tests/gaze/io/files/binocular_example.feather',
},
(10, 3),
id='feather_bino_shape',
),
],
)
def test_shapes(kwargs, shape):
gaze_dataframe = pm.gaze.from_ipc(**kwargs)

assert gaze_dataframe.frame.shape == shape

0 comments on commit 4edba55

Please sign in to comment.