Skip to content

Commit e891e46

Browse files
committed
update function details
1 parent eda0ab8 commit e891e46

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

src/eyeTracker.m

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
% (C) Copyright 2020 CPP_PTB developers
22

33
function [el, cfg] = eyeTracker(input, cfg, varargin)
4-
%
5-
% Wrapper function that deals with all the necessery actions to implement
6-
% Eye Tracker recording with eyelink.
7-
%
8-
% USAGE:
9-
%
10-
% function [el, cfg] = eyeTracker(input, cfg, [message])
11-
%
12-
% :param input: action: Defines what we want the function to do:
13-
% - Calibration: to initialize EyeLink and run calibration
14-
% - 'default calibration' (default) will run a calibration with 6 points
15-
% - 'custom calibration' (cfg.eyeTracker.defaultCalibration = 'false') will run
16-
% a calibration with 6 points but the experimenter can choose their position
17-
% on the screen
18-
%
19-
% - StartRecording: to start eye movements recording
20-
% - Message: will add a tag (e.g. 'Block_n1') in the ET output file, the tag is a
21-
% string and it is input from `varargin`
22-
% - StopRecordings: to stop eye movements recornding
23-
% - Shutdown: to save the `.edf` file with BIDS compliant name, from
24-
% cpp-lln-lab/CPP_BIDS, in the output folder and shut the connection between the
25-
% stimulation computer and the EyeLink computer
26-
% :type input: string
27-
% :param cfg: structure that stores any info regarding the experiment
28-
% :type cfg: struct
29-
% :param message: optional argument to pass in when you want to tag the output in a specific
30-
% moment of the experiment (for example ``Experiment-start``)
31-
% :type message: string
32-
%
33-
% :returns: - :el: (struct) stores info related to the Eye Tracker
34-
% - :cfg: (struct)
4+
%
5+
% Wrapper function that deals with all the necessery actions to implement
6+
% Eye Tracker recording with eyelink.
7+
%
8+
% USAGE:
9+
%
10+
% function [el, cfg] = eyeTracker(input, cfg, [message])
11+
%
12+
% :param input: Defines what we want the function to do
13+
% :type input: string
14+
% :param cfg: structure that stores any info regarding the experiment
15+
% :type cfg: struct
16+
% :param message: optional argument to pass in when you want to tag the output in a specific
17+
% moment of the experiment (for example ``Experiment-start``)
18+
% :type message: string
19+
%
20+
% :returns: - :el: (struct) stores info related to the Eye Tracker
21+
% - :cfg: (struct)
22+
%
23+
% - ``Calibration`` to initialize EyeLink and run calibration
24+
% - ``default calibration`` (default) will run a calibration with 6 points
25+
% - ``custom calibration`` (``cfg.eyeTracker.defaultCalibration = 'false'``) will run
26+
% a calibration with 6 points but the experimenter can choose their position
27+
% on the screen
28+
% - ``StartRecording``: to start eye movements recording
29+
% - ``Message``: will add a tag (e.g. ``Block_n1``) in the ET output file, the tag is a
30+
% string and it is input from `varargin`
31+
% - ``StopRecordings``: to stop eye movements recording
32+
% - ``Shutdown``: to save the ``.edf`` file with BIDS compliant name, from
33+
% cpp-lln-lab/CPP_BIDS, in the output folder and shut the connection between the
34+
% stimulation computer and the EyeLink computer
3535

3636
if ~cfg.eyeTracker.do
3737

0 commit comments

Comments
 (0)