|
1 | 1 | % (C) Copyright 2020 CPP_PTB developers |
2 | 2 |
|
3 | 3 | function [el, cfg] = eyeTracker(input, cfg, varargin) |
4 | | - % [el] = eyeTracker(input, cfg, varargin) |
5 | 4 | % |
6 | 5 | % Wrapper function that deals with all the necessery actions to implement |
7 | | - % Eye Tracker recording with eyelink. |
| 6 | + % Eye Tracker recording with eyelink. |
8 | 7 | % |
9 | | - % INPUT |
| 8 | + % USAGE: |
10 | 9 | % |
11 | | - % - action: Defines what we want the function to do |
12 | | - % - Calibration: to initialize EyeLink and run calibration |
13 | | - % -- 'default calibration' (default) will run a calibration with 6 points |
14 | | - % -- 'custom calibration' (cfg.eyeTracker.defaultCalibration = 'false') will run a |
15 | | - % calibration with 6 points but the experimenter can choose their position on the screen |
16 | | - % - StartRecording: to start eye movements recording |
17 | | - % - Message: will add a tag (e.g. 'Block_n1') in the ET output file, the tag is a string and it |
18 | | - % is input from `varargin` |
19 | | - % - StopRecordings: to stop eye movements recornding |
20 | | - % - Shutdown: to save the `.edf` file with BIDS compliant name, from cpp-lln-lab/CPP_BIDS, in |
21 | | - % the output folder and shut the connection between the stimulation computer and the EyeLink |
22 | | - % computer |
| 10 | + % function [el, cfg] = eyeTracker(input, cfg, [message]) |
23 | 11 | % |
24 | | - % OUTPUT |
| 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 |
25 | 18 | % |
26 | | - % `el` is a structure where are stored EyeLink setup variables |
| 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) |
27 | 35 |
|
28 | 36 | if ~cfg.eyeTracker.do |
29 | 37 |
|
|
0 commit comments