Merge pull request #2 from marcobarilari/marco_exp-structure

put together the functions as experiment base

Author: marcobarilari

audioLocTranslational.m

@@ -0,0 +1,211 @@
+%% Auditory hMT localizer using translational motion in four directions
+%  (up- down- left and right-ward)
+
+% Original Script Written by Sam Weiller to localize MT+/V5
+% adapted by M.Rezk to localize MT/MST (Huk,2002)
+% re-adapted by MarcoB and RemiG 2020
+
+%%
+
+% Clear all the previous stuff
+% clc; clear;
+if ~ismac
+  close all;
+  clear Screen;
+end
+
+% make sure we got access to all the required functions and inputs
+addpath(genpath(fullfile(pwd, 'subfun')))
+
+[expParameters, cfg] = setParameters;
+
+% set and load all the parameters to run the experiment
+expParameters = userInputs(cfg, expParameters);
+
+expParameters = createFilename(cfg, expParameters);
+
+expParameters %#ok<NOPTS>
+
+%%  Experiment
+
+% Safety loop: close the screen if code crashes
+try
+    
+    %% Init the experiment
+    [cfg] = initPTB(cfg);
+    
+    % % Convert some values from degrees to pixels
+    % cfg = deg2Pix('diameterAperture', cfg, cfg);
+    % expParameters = deg2Pix('dotSize', expParameters, cfg);
+    
+    
+    [el] = eyeTracker('Calibration', cfg, expParameters);
+    
+    % % % REFACTOR THIS FUNCTION
+    [expParameters] = expDesign(expParameters);
+    % % %
+    
+    % Prepare for the output logfiles with all
+    logFile = saveEventsFile('open', expParameters, [], ...
+        'direction', 'speed', 'target', 'event', 'block');
+    
+    logFile
+    
+    % % % REFACTOR THIS FUNCTION
+    [expParameters] = loadAudioFiles(cfg, expParameters);
+    phandle = PsychPortAudio('Open',[],[],1,expParameters.freq,2);
+    % % %
+    
+    % Prepare for fixation Cross
+    if expParameters.Task1
+        
+        cfg.xCoords = [-expParameters.fixCrossDimPix expParameters.fixCrossDimPix 0 0] ...
+            + expParameters.xDisplacementFixCross;
+        
+        cfg.yCoords = [0 0 -expParameters.fixCrossDimPix expParameters.fixCrossDimPix] ...
+            + expParameters.yDisplacementFixCross;
+        
+        cfg.allCoords = [cfg.xCoords; cfg.yCoords];
+        
+    end
+    
+    % Wait for space key to be pressed
+    pressSpace4me
+    
+    % prepare the KbQueue to collect responses
+    getResponse('init', cfg, expParameters, 1);
+    getResponse('start', cfg, expParameters, 1);
+    
+    % Show instructions
+    if expParameters.Task1
+        DrawFormattedText(cfg.win,expParameters.TaskInstruction,...
+            'center', 'center', cfg.textColor);
+        Screen('Flip', cfg.win);
+    end
+    
+    % Wait for Trigger from Scanner
+    wait4Trigger(cfg)
+    
+    % Show the fixation cross
+    if expParameters.Task1
+        drawFixationCross(cfg, expParameters, expParameters.fixationCrossColor)
+        Screen('Flip',cfg.win);
+    end
+    
+    %% Experiment Start
+    cfg.experimentStart = GetSecs;
+    
+    WaitSecs(expParameters.onsetDelay);
+    
+    %% For Each Block
+    
+    stopEverything = 0;
+    
+    for iBlock = 1:expParameters.numBlocks
+        
+        if stopEverything
+            break;
+        end
+        
+        fprintf('\n - Running Block %.0f \n',iBlock)
+        
+        eyeTracker('StartRecording', cfg, expParameters);
+        
+        % For each event in the block
+        for iEvent = 1:expParameters.numEventsPerBlock
+            
+            
+            % Check for experiment abortion from operator
+            [keyIsDown, ~, keyCode] = KbCheck(cfg.keyboard);
+            if keyIsDown && keyCode(KbName(cfg.escapeKey))
+                stopEverything = 1;
+                warning('OK let us get out of here')
+                break;
+            end
+            
+            
+            % set direction, speed of that event and if it is a target
+            thisEvent.trial_type = 'dummy';
+            thisEvent.direction = expParameters.designDirections(iBlock,iEvent);
+            thisEvent.speed = expParameters.designSpeeds(iBlock,iEvent);
+            thisEvent.target = expParameters.designFixationTargets(iBlock,iEvent);
+            
+            % play the sounds and collect onset and duration of the event
+            [onset, duration] = doAudMot(cfg, expParameters, thisEvent, phandle);
+            
+            thisEvent.event = iEvent;
+            thisEvent.block = iBlock;
+            thisEvent.duration = duration;
+            thisEvent.onset = onset - cfg.experimentStart;
+            
+            % Save the events txt logfile
+            % we save event by event so we clear this variable every loop
+            thisEvent.fileID = logFile.fileID;
+            
+            saveEventsFile('save', expParameters, thisEvent, ...
+                'direction', 'speed', 'target', 'event', 'block');
+            
+            clear thisEvent
+            
+            
+            % collect the responses and appends to the event structure for
+            % saving in the tsv file
+            responseEvents = getResponse('check', cfg, expParameters);
+            
+            if ~isempty(responseEvents(1).onset)
+                
+                responseEvents.fileID = logFile.fileID;
+                
+                for iResp = 1:size(responseEvents, 1)
+                    responseEvents(iResp).onset = ...
+                        responseEvents(iResp).onset - cfg.experimentStart;
+                    responseEvents(iResp).target = expParameters.designFixationTargets(iBlock,iEvent);
+                    responseEvents(iResp).event = iEvent;
+                    responseEvents(iResp).block = iBlock;
+                end
+                
+                saveEventsFile('save', expParameters, responseEvents, ...
+                    'direction', 'speed', 'target', 'event', 'block');
+            end
+            
+            % wait for the inter-stimulus interval
+            WaitSecs(expParameters.ISI);
+            
+            getResponse('flush', cfg, expParameters);
+            
+        end
+        
+        eyeTracker('StopRecordings', cfg, expParameters);
+        
+        WaitSecs(expParameters.IBI);
+        
+    end
+    
+    % End of the run for the BOLD to go down
+    WaitSecs(expParameters.endDelay);
+    
+    % Close the logfiles
+    saveEventsFile('close', expParameters, logFile);
+    
+    getResponse('stop', cfg, expParameters, 1);
+    
+    totalExperimentTime = GetSecs-cfg.experimentStart;
+    
+    eyeTracker('Shutdown', cfg, expParameters);
+    
+    % save the whole workspace
+    matFile = fullfile(expParameters.outputDir, strrep(expParameters.fileName.events,'tsv', 'mat'));
+    if IsOctave
+        save(matFile, '-mat7-binary');
+    else
+        save(matFile, '-v7.3');
+    end
+    
+    cleanUp()
+    
+catch
+    
+    cleanUp()
+    psychrethrow(psychlasterror);
+    
+end

getDependencies.m

@@ -0,0 +1,17 @@
+function getDependencies(action)
+
+if nargin<1
+    action = '';
+end
+
+switch action
+    case 'update'
+        % install dependencies
+        mpm install -i mpm-requirements.txt -f -c audio_motion_localizer
+end
+
+% adds them to the path
+mpm_folder = fileparts(which('mpm'));
+addpath(genpath(fullfile(mpm_folder, 'mpm-packages', 'mpm-collections', 'audio_motion_localizer')));
+
+end