|
1 | 1 | % (C) Copyright 2020 CPP_PTB developers |
2 | 2 |
|
3 | 3 | 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: 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 |
| 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 |
35 | 35 |
|
36 | 36 | if ~cfg.eyeTracker.do |
37 | 37 |
|
|
0 commit comments