aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorThéo de la Hogue2022-05-09 08:27:32 +0200
committerThéo de la Hogue2022-05-09 08:27:32 +0200
commited509e42456a240007e96e61a1e5ad351faa22e3 (patch)
tree25cf3736f83814441850c48653f93f3b10672fc6 /src
parentb1c719163e6a1867c968da69b8068ee5080fd1cd (diff)
downloadargaze-ed509e42456a240007e96e61a1e5ad351faa22e3.zip
argaze-ed509e42456a240007e96e61a1e5ad351faa22e3.tar.gz
argaze-ed509e42456a240007e96e61a1e5ad351faa22e3.tar.bz2
argaze-ed509e42456a240007e96e61a1e5ad351faa22e3.tar.xz
Updating ready to use command documentation.
Diffstat (limited to 'src')
-rw-r--r--src/argaze/utils/README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/argaze/utils/README.md b/src/argaze/utils/README.md
index 3243b26..cd7b0bc 100644
--- a/src/argaze/utils/README.md
+++ b/src/argaze/utils/README.md
@@ -24,25 +24,25 @@ python ./src/argaze/utils/export_aruco_markers.py -o export/markers
python ./src/argaze/utils/export_calibration_board.py 7 5 5 3 -o export
```
-- Calibrate Tobii Glasses Pro 2 camera (replace IP_ADDRESS) using a 7 columns and 5 rows calibration board with 5cm squares and 3cm markers inside. Then, export its optical parameters into an tobii_camera.json file:
+- Calibrate Tobii Glasses Pro 2 camera (-t IP_ADDRESS) using a 7 columns and 5 rows calibration board with 5cm squares and 3cm markers inside. Then, export its optical parameters into an tobii_camera.json file:
```
python ./src/argaze/utils/calibrate_tobii_camera.py 7 5 5 3 -t IP_ADDRESS -o export/tobii_camera.json
```
-- Display Tobii Glasses Pro 2 camera video stream (replace IP_ADDRESS) and gaze
+- Display Tobii Glasses Pro 2 camera video stream (-t IP_ADDRESS) with a live gaze pointer:
```
python ./src/argaze/utils/live_tobii_session.py -t IP_ADDRESS
```
-- Record a Tobii Glasses Pro 2 'Test' session for a participant '1' on Tobii interface's SD card (replace IP_ADDRESS).
+- Record a Tobii Glasses Pro 2 'myProject' session for a 'myUser' participant on Tobii interface's SD card (-t IP_ADDRESS):
```
-python ./src/argaze/utils/record_tobii_session.py -t IP_ADDRESS -p myProject -u mySelf
+python ./src/argaze/utils/record_tobii_session.py -t IP_ADDRESS -p myProject -u myUser
```
-- Explore Tobii Glasses Pro 2 interface's SD Card (replace DRIVE_PATH, PROJECT_PATH, RECORDING_PATH, SEGMENT_PATH)
+- Explore Tobii Glasses Pro 2 interface's SD Card (-d DRIVE_PATH, -p PROJECT_PATH, -r RECORDING_PATH, -s SEGMENT_PATH):
```
python ./src/argaze/utils/explore_tobii_sdcard.py -d DRIVE_PATH
@@ -60,26 +60,26 @@ python ./src/argaze/utils/explore_tobii_sdcard.py -r RECORDING_PATH
python ./src/argaze/utils/explore_tobii_sdcard.py -s SEGMENT_PATH
```
-- Replay a time range selection (replace IN OUT) Tobii Glasses Pro 2 session (replace SEGMENT_PATH) synchronizing video and data together.
+- Replay a time range selection (-r IN OUT) Tobii Glasses Pro 2 session (-s SEGMENT_PATH) synchronizing video and gaze data together:
```
python ./src/argaze/utils/replay_tobii_session.py -s SEGMENT_PATH -r IN OUT
```
-- Export Tobii segment fixations (replace SEGMENT_PATH) from a time range selection (replace IN OUT) as a fixations.json file saved into the segment folder
+- Export Tobii segment fixations and saccades (-s SEGMENT_PATH) from a time range selection (-r IN OUT) as fixations.csv and saccades.csv files saved into the segment folder:
```
-python ./src/argaze/utils/export_tobii_segment_fixations.py -s SEGMENT_PATH -r IN OUT
+python ./src/argaze/utils/export_tobii_segment_movements.py -s SEGMENT_PATH -r IN OUT
```
-- Track ArUco markerinto a Tobii camera video segment (replace SEGMENT_PATH) into a time range selection (replace IN OUT). Load an aoi scene (replace AOI_SCENE) .obj file, position it virtually relatively to any detected ArUco markers and project the scene into camera frame. Then, detect if Tobii gaze point is inside any AOI. Export AOIs video and visual scan data.
+- Track ArUco markers (-i MARKERS_ID) into a Tobii camera video segment (-s SEGMENT_PATH) into a time range selection (-r IN OUT). Load an aoi scene (-a AOI_SCENE) .obj file, position it virtually relatively to the detected ArUco markers and project the scene into camera frame. Then, detect if Tobii gaze point is focusing onto AOIs to build the segment visual scan and export it as a visual_scan.csv, visual_scan.jpg, visual_scan.mp4 files:
```
-python ./src/argaze/utils/export_tobii_segment_aruco_visual_scan.py -s SEGMENT_PATH -c export/tobii_camera.json -m 7.5 -a AOI_SCENE -r IN OUT
+python ./src/argaze/utils/export_tobii_segment_aruco_visual_scan.py -s SEGMENT_PATH -c export/tobii_camera.json -m 7.5 -a AOI_SCENE -r IN OUT -i MARKERS_ID
```
-- Track ArUco markers (replace MARKER_ID) into Tobii camera video stream (replace IP_ADDRESS). Load an aoi scene (replace AOI_SCENE) .obj file, position it virtually relatively to any detected ArUco markers and project the scene into camera frame. Then, detect if Tobii gaze point is inside any AOI.
+- Track ArUco markers (-i MARKERS_ID) into Tobii camera video stream (-t IP_ADDRESS). Load an aoi scene (-a AOI_SCENE) .obj file, position it virtually relatively to any detected ArUco markers and project the scene into camera frame. Then, detect if Tobii gaze point is inside any AOI:
```
-python ./src/argaze/utils/live_tobii_aruco_aois.py -t IP_ADDRESS -c export/tobii_camera.json -m 7.5 -a AOI_SCENE -i MARKER_ID
+python ./src/argaze/utils/live_tobii_aruco_aois.py -t IP_ADDRESS -c export/tobii_camera.json -m 7.5 -a AOI_SCENE -i MARKERS_ID
```