apply some linting

Author: Remi-Gau

CPP_getResponseDemo.m

@@ -0,0 +1,118 @@
+%% Demo showing how to use the getResponse function
+
+% This small script shows how to use the getReponse function
+%  (a wrapper around the KbQueue function from PTB)
+
+% start with a clean slate
+clear; clc;
+if IsOctave
+    more off % for a better display experience
+end
+
+%% set parameters
+
+% cfg.responseBox would be the device number of the device used by the participant to give his/her
+% response: like the button box in the scanner or a separate keyboard for a behavioral experiment
+%
+% cfg.keyboard would be the device number of the keyboard on which the experimenter will type or
+% press the keys necessary to start or abort the experiment.
+
+%  cfg.responseBox and cfg.keyboard can be different or the same.
+
+% If you want to know the device number of all the keyboards and responses
+% boxes connected to the computer you can use the following code.
+% [cfg.keyboardNumbers, cfg.keyboardNames] = GetKeyboardIndices
+
+% Using empty vectors should work for linux when to select the "main"
+%  keyboard. You might have to try some other values for Windows. To
+%  assigne a specific keyboard input the kb assigned value (see README)
+cfg.keyboard = [];
+cfg.responseBox = [];
+
+% We set which keys are "valid", any keys other than those will be ignored
+expParameters.responseKey = {};
+
+
+%% init
+
+% Keyboard
+%  Make sure keyboard mapping is the same on all supported operating systems
+%  Apple MacOS/X, MS-Windows and GNU/Linux:
+KbName('UnifyKeyNames');
+
+
+% we ask PTB to tell us which keyboard devices are connected to the computer
+[cfg.keyboardNumbers, cfg.keyboardNames] = GetKeyboardIndices;
+
+cfg.keyboardNumbers
+cfg.keyboardNames
+
+
+% Test that the keyboards are correctly configured
+testKeyboards(cfg);
+
+% Give the time to the test key to be released and not listened
+WaitSecs(1);
+
+
+fprintf('\nDuring the next 5 seconds we will collect responses on the following keys: \n\n');
+if isempty(expParameters.responseKey)
+    fprintf('\nALL KEYS\n\n');
+else
+    for iKey=1:numel(expParameters.responseKey)
+        fprintf('\n%s', expParameters.responseKey{iKey});
+    end
+    fprintf('\n\n');
+end
+
+
+
+%% Run demo
+
+% Create the keyboard queue to collect responses.
+getResponse('init', cfg, expParameters, 1);
+
+% Start collecting responses for 5 seconds
+%  Each new key press is added to the queue of events recorded by KbQueue
+startSecs = GetSecs();
+getResponse('start', cfg, expParameters, 1);
+
+
+
+% Here we wait for 5 seconds but are still collecting responses.
+%  So you could still be doing something else (presenting audio and visual stim) and
+%  still collect responses.
+WaitSecs(5);
+
+
+
+% Check what keys were pressed (all of them)
+responseEvents = getResponse('check', cfg, expParameters, 0);
+
+% The following line would only return key presses and not releases
+% responseEvents = getResponse('check', cfg, expParameters, 1);
+
+% This can be used to flush the queue: empty all events that are still present in the queue
+getResponse('flush', cfg, expParameters, 1);
+
+% If you wan to stop listening to key presses.
+getResponse('stop', cfg, expParameters, 1);
+
+
+
+
+%% Now we look what keys were pressed and when
+for iEvent = 1:size(responseEvents, 1)
+
+    if responseEvents(iEvent).pressed
+        eventType = 'pressed';
+    else
+        eventType = 'released';
+    end
+
+    fprintf('%s was %s at time %.3f seconds\n', ...
+        responseEvents(iEvent).key_name, ...
+        eventType, ...
+        responseEvents(iEvent).onset - startSecs);
+
+end

README.md

@@ -27,8 +27,11 @@ The exact version required for this to work but it is known to work with:
 ## Code guidestyle
 
 We use the `camelCase` to more easily differentiates our functions from the ones from PTB that use a `PascalCase`.
+We use the following regular expression for function names: `[a-z]+(([A-Z]|[0-9]){1}[a-z]+)*`.
 
-We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/matlab_checkcode) below 15.
+We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/check_my_code) below 15.
+
+We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
 
 ## How to install
 

deg2Pix.m

@@ -0,0 +1,11 @@
+function structure = degToPix(fieldName, structure, cfg)
+    % For a given field value in degrees of visual angle in the structure,
+    % this computes its value in pixel using the pixel per degree value of the cfg structure
+    % and returns a structure with an additional field with Pix suffix holding that new value.
+
+    deg = getfield(structure, fieldName); %#ok<GFLD>
+
+    structure = setfield(structure, [fieldName 'Pix'], ...
+        floor(cfg.ppd * deg)) ; %#ok<SFLD>
+
+end

degToPix.m

@@ -1,17 +1,11 @@
-% set up
-cfg.testingDevice = 'scanner';
-cfg.numTriggers = 4; 
-cfg.triggerKey = 't';
+cd ..
+
+cfg.device = 'Scanner';
 
-% this field is not required but can be mentioned
-cfg.MRI.repetitionTime = 3; 
+cfg.numTriggers = 4; 
 
-% add parent directory to the path (to make sure we can access the CPP_PTB
-% functions)
-addpath(fullfile(pwd, '..')) 
+cfg.triggerKey = 'space';
 
-% beginning of demo
 KbName('UnifyKeyNames');
 
-% press the key "t" to simulate triggers
 wait4Trigger(cfg)

demos/CPP_wait4TriggerDemo.m

@@ -0,0 +1,11 @@
+cd ..;
+
+cfg.device = 'Scanner';
+
+cfg.numTriggers = 4;
+
+cfg.triggerKey = 'space';
+
+KbName('UnifyKeyNames');
+
+waitForTrigger(cfg);

demos/CPP_waitForTriggerDemo.m

@@ -1,11 +1,11 @@
 function drawFixationCross(cfg, expParameters, color)
-% Define the parameters of the fixation cross in `cfg` and `expParameters` and this does the rest.
+    % Define the parameters of the fixation cross in `cfg` and `expParameters` and this does the rest.
 
-Screen('DrawLines', ...
-    cfg.win, ...
-    cfg.allCoords, ...
-    expParameters.lineWidthPix, ...
-    color , ...
-    [cfg.center(1) cfg.center(2)], 1);
+    Screen('DrawLines', ...
+        cfg.win, ...
+        cfg.allCoords, ...
+        expParameters.lineWidthPix, ...
+        color, ...
+        [cfg.center(1) cfg.center(2)], 1);
 
 end