aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md
blob: 2156f3bb164804f51f5f5af257a57773bae61ff3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Edit timestamped gaze positions
===============================

Whatever eye data comes from a file on disk or from a live stream, timestamped gaze positions are required before to go further.

![Timestamped gaze positions](../../img/timestamped_gaze_positions.png)

## Import gaze positions from CSV file

It is possible to load timestamped gaze positions from a [Pandas DataFrame](https://pandas.pydata.org/docs/getting_started/intro_tutorials/01_table_oriented.html#min-tut-01-tableoriented) object which can be loaded from a CSV file.

```python
from argaze import GazeFeatures
import pandas

# Load gaze positions from a CSV file into Panda Dataframe
dataframe = pandas.read_csv('gaze_positions.csv', delimiter=",", low_memory=False)

# Convert Panda dataframe into timestamped gaze positions precising the use of each specific column labels
ts_gaze_positions = GazeFeatures.TimeStampedGazePositions.from_dataframe(dataframe, timestamp = 'Recording timestamp [ms]', x = 'Gaze point X [px]', y = 'Gaze point Y [px]')

# Iterate over timestamped gaze positions
for timestamp, gaze_position in ts_gaze_positions.items():

	# Do something with each timestamped gaze position
	...
```

## Edit gaze positions from live stream

When gaze positions comes from a real time input, gaze position can be edited thanks to [GazePosition](../../argaze.md/#argaze.GazeFeatures.GazePosition) class.
Besides, timestamps can be edited from the incoming data stream or, if not available, they can be edited thanks to the python [time package](https://docs.python.org/3/library/time.html).

``` python
from argaze import GazeFeatures

# Assuming to be inside the function where timestamp_µs, gaze_x and gaze_y values are catched
...

	# Edit a second timestamp from a microsecond second timestamp
	timestamp = timestamp_µs * 1e-6

	# Define a basic gaze position
	gaze_position = GazeFeatures.GazePosition((gaze_x, gaze_y))

	# Do something with each timestamped gaze position
	...
```

``` python
from argaze import GazeFeatures

import time

# Init timestamp
start_time = time.time()

# Assuming to be inside the function where only gaze_x and gaze_y values are catched (no timestamp)
...

	# Edit a millisecond timestamp
	timestamp = int((time.time() - start_time) * 1e3)

	# Define a basic gaze position
	gaze_position = GazeFeatures.GazePosition((gaze_x, gaze_y))

	# Do something with each timestamped gaze position
	...
```

!!! warning "Free time unit"
	Timestamps can either be integer or float, second, millisecond or what ever you need. The only concern is that all time values used in further configurations have to be all the same unit.

Now we have timestamped gaze positions at expected format, let's see how to analyze them.