Skip to content

Commit f67e1c8

Browse files
committed
add function documentation
1 parent f0abaa0 commit f67e1c8

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/functions_description.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ and returns a structure with an additional field with Pix suffix holding that ne
6464

6565
This will handle the Eye Tracker (EyeLink set up) and can be called to initialize the connection and start the calibration, start/stop eye(s) movement recordings and save the `*.edf` file (named with BIDS specification from cpp-lln-lab/CPP_BIDS).
6666

67+
There are several actions to perform:
68+
69+
- Calibration: to initialize EyeLink and run calibration
70+
- 'default calibration' (default) will run a calibration with 6 points
71+
- 'custom calibration' (cfg.eyeTracker.defaultCalibration = 'false') will run a calibration with 6 points but the experimenter can choose their position on the screen
72+
- StartRecording: to start eye movements recording
73+
- StopRecordings: to stop eye movements recornding
74+
- Shutdown: to save the `.edf` file with BIDS compliant name, from cpp-lln-lab/CPP_BIDS, in the output folder and shut the connection between the stimulation computer and the EyeLink computer
75+
6776
### 1.7. <a name='standByScreen'></a>standByScreen
6877

6978
It shows a basic one-page instruction stored in `cfg.task.instruction` and wait for `space` stroke.
@@ -120,4 +129,4 @@ Define the parameters of the fixation cross in `cfg` and `expParameters` and thi
120129

121130
## 4. <a name='Drawingdots'></a>Drawing dots
122131

123-
## 5. <a name='Drawingapertures'></a>Drawing apertures
132+
## 5. <a name='Drawingapertures'></a>Drawing apertures

0 commit comments

Comments
 (0)