Skip to content

Commit f0abaa0

Browse files
committed
add function help sections
1 parent 28147b1 commit f0abaa0

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

src/eyeTracker.m

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
function [el, edfFile] = eyeTracker(input, cfg)
1+
function [el] = eyeTracker(input, cfg)
2+
% [el] = eyeTracker(input, cfg)
3+
%
4+
% Wrapper function that deals with all the necessery actions to implement Eye Tracker recording.
5+
%
6+
% INPUT
7+
%
8+
% - action: Defines what we want the function to do
9+
% - Calibration: to initialize EyeLink and run calibration
10+
% -- 'default calibration' (default) will run a calibration with 6 points
11+
% -- 'custom calibration' (cfg.eyeTracker.defaultCalibration = 'false') will run a
12+
% calibration with 6 points but the experimenter can choose their position on the screen
13+
% - StartRecording: to start eye movements recording
14+
% - StopRecordings: to stop eye movements recornding
15+
% - Shutdown: to save the `.edf` file with BIDS compliant name, from cpp-lln-lab/CPP_BIDS, in
16+
% the output folder and shut the connection between the stimulation computer and the EyeLink
17+
% computer
18+
%
19+
% OUTPUT
20+
%
21+
% `el` is a structure where are stored EyeLink setup variables
222

323
if ~cfg.eyeTracker.do
424

0 commit comments

Comments
 (0)