pb_vRunExp.m

function pb_vRunExp(handles)
% PB_VRUNEXP
%
% PB_VRUNEXP(handles) forms the core body of experimental paradigms run in 
% the VC, and will loop over the blocks and trials provided by the exp-file.
% Note that PB_VRUNEXP is called from the vPrime GUI, from which it
% receives its experimental handles.
%
% See also PB_VPRIME, PB_VPRIMEGUI.

% PBToolbox (2018): JJH: j.heckman@donders.ru.nl

   %% INITIALIZE
   %  load & read experiment
   
   %  set debug mode
   debug = true;
   
   %  set handles
   pb_setupShow(handles);
   handles	= pb_gethandles(handles);
   handles 	= pb_getblock(handles);
   handles 	= pb_createdir(handles);
   handles	= pb_vInitialize(handles, true);
   
   %  set block information
   block          = handles.block;  
   nblocks        = handles.cfg.Blocks;
   Dat(nblocks)   = struct('VS',[],'EV',[],'PL_Gaze',[],'PL_Python',[],'PL_Primitive',[],'OT_Rigid',[],'BlockInfo',[]);
   
   %  initialize recordings
   rc             = pb_runPupil; 
   [ses,streams]  = pb_runLSL;
   experimentTime = tic;
   
   %% START BLOCK 
   %  iterate experimental blocks 
   
   for iBlck = 1:nblocks
      %  Runs blocks of trials with a vestibular condition
      
      %  set block information
      nTrials  	= length(block(iBlck).trial);
      handles  	= updateCount(handles,'trial','reset');
      
      %  store signal data
      [sig,profile,dur]       = pb_vSignalVC(handles);                     % reads, checks, creates & plots vestibular signals
      Dat(iBlck).VS           = sig;
      
      %  start recording
      pb_startLSL(ses);
      pb_startPupil(rc);
      
      %  start vestibular chair
      if ~ismac && ~debug      
         vs = pb_sendServo(profile);
         pb_startServo(vs);
         pause(6);   blockTime   = tic;                                    % allow vestibular chair to get in sync with input signal
      end

      %% RUN TRIALS
      %  iterate over trials per block
      
      for iTrl = 1:nTrials
         % Runs all trials within one block
         
         % setup trial
         updateTrial(handles);
         stim                 = handles.block(iBlck).trial(iTrl).stim;
         handles.cfg          = pb_vClearTrial(stim, handles.cfg); 
         [stim, handles.cfg]  = pb_vSetupTrial(stim, handles.cfg);
         trialTime            = tic;
         
         pb_vRunTrial(handles.cfg.zBus, handles.cfg.trialdur);
         pb_vTraces(handles);       
         
         handles        = pb_vStoreData(handles, sig);
         handles.cfg    = updateCount(handles.cfg,'trial','count');
         toc(trialTime)
      end
      
      %% END BLOCK
      %  stop chair, pupil labs, optitrack and LSL, save data
      
      %  stop vestibular chair
      if ~ismac && ~debug  
         elapsedTime = toc(blockTime);                
         if elapsedTime < dur; pause(dur-floor(elapsedTime)); end          % wait untill chair is finished running before disabling.
         pb_stopServo(vs);
         Dat = pb_readServo(vs);
      end

      %  stop recording
      pb_stopPupil(rc);
      pb_stopLSL(ses); 
      
      %  store data
      Dat(iBlck).EV           = streams(1).read;
      Dat(iBlck).PL_Python    = streams(2).read;
      Dat(iBlck).PL_Gaze      = streams(3).read;
      Dat(iBlck).PL_Primitive = streams(4).read;
      Dat(iBlck).OT_Rigid     = streams(5).read;
      Dat(iBlck).BlockInfo    = handles.block(iBlck);

      %  update block information
      handles.cfg = updateCount(handles.cfg,'block','count');
   end 
   
   %% CHECK OUT
   %  finalizes experiment, and resets handles.
   
   %  check out experiment
   pb_vEndExp;
   pb_vStoreBlockDat(handles.cfg, Dat);
   pb_vInitialize(handles, false);
   toc(experimentTime)
end

%-- Feedback functions --%
function updateTrial(handles)
   %  Updates the trial information to the GUI
   
   tn = handles.cfg.trialnumber;
   handles.figure1.Name = ['vPrime - ' num2str(tn(2)) '/' num2str(handles.cfg.Trials) ' Trials'];        % counting title

   str = num2str(tn(1),'%03d');                                                                          % blocktrial
   set(handles.Tn,'string',str);
end

function cfg = updateCount(cfg,varargin)
   %  Updates the count of trialnumber and block number during experiment
   
   %  initializes update information
   trial = pb_keyval('trial',varargin);
   block = pb_keyval('block',varargin);
   
   %  sets trials
   if ~isempty(trial)
      switch trial
         case 'count'
            cfg.trialnumber      = cfg.trialnumber+1;
         case 'reset'
            cfg.trialnumber(1)   = 1;
      end
   end
   
   %  sets block
   if ~isempty(block)
      switch block
         case 'count'
            cfg.blocknumber      = cfg.blocknumber+1;
      end
   end
end


% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % 
%                                                           %
%       Part of Programmeer Beer Toolbox (PBToolbox)        %
%       Written by: Jesse J. Heckman (2018)                 %
%                                                           %
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %