SidesSection.m

% [x, y] = SidesSection(obj, action, x, y)
% 
% Section that takes care of choosing the next correct side and keeping
% track of a plot of sides and hit/miss history.
%
% PARAMETERS:
% -----------
%
% obj      Default object argument.
%
% action   One of:
%            'init'      To initialise the section and set up the GUI
%                        for it; also calls 'choose_next_side' and
%                        'update_plot' (see below)
%
%            'reinit'    Delete all of this section's GUIs and data,
%                        and reinit, at the same position on the same
%                        figure as the original section GUI was placed.
%
%            'choose_next_side'  Picks what will be the next correct
%                        side. 
%
%            'get_next_side'  Returns either 'l' for left or 'r' for right.
%
%            'update_plot'    Update plot that reports on sides and hit
%                        history
%
% x, y     Relevant to action = 'init'; they indicate the initial
%          position to place the GUI at, in the current figure window
%
% RETURNS:
% --------
%
% [x, y]   When action == 'init', returns x and y, pixel positions on
%          the current figure, updated after placing of this section's GUI. 
%
% x        When action = 'get_next_side', x will be either 'l' for
%          left or 'r' for right.
%

function [x, y] = SidesSection(obj, action, x, y)
   
   GetSoloFunctionArgs;
   
   switch action

    case 'init',   % ------------ CASE INIT ----------------
      % Save the figure and the position in the figure where we are
      % going to start adding GUI elements:
      SoloParamHandle(obj, 'my_gui_info', 'value', [x y gcf]);

      % List of intended correct sides
      SoloParamHandle(obj, 'previous_sides', 'value', []);
      % List of trial types 
      SoloParamHandle(obj, 'previous_trial_types', 'value', []);
      % Give read-only access to AnalysisSection.m and MotorsSection.m:
      SoloFunctionAddVars('AnalysisSection', 'ro_args', 'previous_sides');
      SoloFunctionAddVars('MotorsSection', 'ro_args', 'previous_sides');
      
      % Give read-only access to AnalysisSection.m and MotorsSection.m:
      SoloFunctionAddVars('AnalysisSection', 'ro_args', 'previous_trial_types');
      SoloFunctionAddVars('MotorsSection', 'ro_args', 'previous_trial_types');
        % ........................

      %max nogoprobability used for autotrainer slide   
        NumeditParam(obj, 'Auto_train_max_prob', 0.7, x, y, 'label', ...
          'ATFA_MaxNoGOProb');     
       next_row(y);
      %min nogoprobability used for autotrainer slide   
        NumeditParam(obj, 'Auto_train_min_prob', 0.5, x, y, 'label', ...
          'ATFA_MinNoGOProb'); 
      
      next_row(y);
      %sliding window for nogoprob set by false alarm rate
      NumeditParam(obj, 'Auto_train_slide', 30, x, y, 'label', ...
          'AutoTrainWinSize'); 
      next_row(y);
      
      % Autotrainer mode
      MenuParam(obj, 'AutoTrainMode', {'Off','FA_PercSetProb' }, 'Off', x, y,...
          'TooltipString','false alarm rate = no go prob, for below win. min prob set below by min prob.');
      next_row(y);
      
      % 'Auto trainer' max # of FAs
      NumeditParam(obj, 'autotrain_max_fas', 0, x, y, 'label', ...
          'AutoTrain max FAs'); 
      next_row(y);
      
      NumeditParam(obj, 'autotrain_min_crs', 3, x, y, 'label', ...
          'AutoTrain min CRs'); 
      next_row(y);
      
      
      
      % For trackin # of CRs and FAs in row ...
      SoloParamHandle(obj, 'num_consecutive_fas', 'value', 0);
      SoloParamHandle(obj, 'num_consecutive_crs', 'value', 0);
      SoloParamHandle(obj, 'autotraining', 'value', 0); % 1 if in autotran

            
      % Max number of times same side can appear
      MenuParam(obj, 'MaxSame', {'1' '2' '3' '4' '5' '6' '7' '8' 'Inf'}, ...
                '3', x, y);
      next_row(y);
      % Prob of choosing left as correct side
      NumeditParam(obj, 'NoGoProb', 0.5, x, y); 
      next_row(y, 1);
      
      SubheaderParam(obj, 'sidestitle', 'Go trial probability', x, y);
      next_row(y);
      
      
      
      
      
      
      NumeditParam(obj, 'radialProb', 0.5, x, y,'label',...
          'set radial (vs arc) probability'); 
      next_row(y);
      
      NumeditParam(obj, 'posSampPerAxis', 10, x, y,'label',...
          'set how many each space should be evenly sampled'); 
      next_row(y);
      
      NumeditParam(obj, 'sampBiasThreshold', 1.2, x, y,'label',...
          'threshold for forcing sampling in alternitive space'); 
      next_row(y);
      
      %give read only access
      SoloFunctionAddVars('MotorsSection', 'ro_args', 'radialProb');
      SoloFunctionAddVars('MotorsSection', 'ro_args', 'posSampPerAxis');
      SoloFunctionAddVars('MotorsSection', 'ro_args', 'sampBiasThreshold');
      
      SubheaderParam(obj, 'sidestitle', 'Arc/Radial Sampling', x, y); 
      
      

      pos = get(gcf, 'Position');
      SoloParamHandle(obj, 'myaxes', 'saveable', 0, 'value', axes);
      set(value(myaxes), 'Units', 'pixels');
      set(value(myaxes), 'Position', [90 pos(4)-140 pos(3)-130 100]);
      set(value(myaxes), 'YTick', [1 2], 'YLim', [0.5 2.5], 'YTickLabel', ...
                        {'Go', 'No-go'});
      NumeditParam(obj, 'ntrials', 100, x, y, ...
                   'position', [5 pos(4)-100 40 40], 'labelpos', 'top', ...
                   'TooltipString', 'How many trials to show in plot');
      set_callback(ntrials, {mfilename, 'update_plot'});      
      xlabel('trial number');
      SoloParamHandle(obj, 'previous_plot', 'saveable', 0);
      
      SidesSection(obj, 'choose_next_side');
      SidesSection(obj, 'update_plot');
      
  case 'choose_next_side', % --------- CASE CHOOSE_NEXT_SIDE -----
      % 108/l : nogo ; 114/r: go
        %%%%%%%%%%%%%%%%-PSM edit below 
      switch lower(value(AutoTrainMode))
            % -- NO AUTOTRAINER -- just use maxSame and leftPortProb
            case 'off'
                pickAtRandom = 1;

                % -- Alternate: simple autotrainer where, after
                % AutoTrainMinCorrect licks are made, the autotrainer switches to
                %  the other side ; default is right
                
            case 'fa_percsetprob'
                
                %only implements after a certain amount of trials
                %using a sliding window setting set the no go probability
                %tofalse alarm  %do i want the trigger to be the number of trials or the
                %number of no-go trials??????
                
                %autotrainer sliding window
                %Auto_train_slide(:) = 5; %set this to a value on GUI
                
                %insert a param for max and min prob to switch to
                numTrials=numel(previous_sides(:));
                if numTrials>Auto_train_slide(:) %enough total trials
                    
                    noGoInd=find(previous_sides(:)==108); 
                    numNoGoTrials = numel(noGoInd);
                if  numNoGoTrials>Auto_train_slide(:) %enough nogotrials?
                    %last numel(Auto_train_slide(:)) nogo trial indices
                    noGoWinInd = noGoInd(numNoGoTrials-Auto_train_slide(:)+1:numNoGoTrials);
                    %all NoGo hit history within the window 
                    noGoWinHH=hit_history(noGoWinInd);
                    %percent correct for window for NoGos
                    noGoPercCorr= sum(noGoWinHH)/(Auto_train_slide(:));
                    
                    falseAlarmRate=1-noGoPercCorr;
                    
                     if falseAlarmRate >= Auto_train_min_prob(:) && falseAlarmRate <= Auto_train_max_prob(:)
                        NoGoProb.value=falseAlarmRate;
                        display(' ')
                        display(' ')
                        display('NO GO PROB SET BY AUTOTRAINER')
                        display('MIN NO PROB SET USING GUI')
                        display('CURRENT NOGO PROB SET TO...')
                        display(num2str(NoGoProb(:)))
                    elseif falseAlarmRate < Auto_train_min_prob(:);
                        NoGoProb.value=Auto_train_min_prob(:);
                        display(' ')
                        display(' ')
                        display('NO GO PROB SET BY GUI')
                        display('FALSE ALARM RATE < NOGOPROB IN GUI')
                        display('CURRENT NOGO PROB SET TO...')
                        display(num2str(NoGoProb(:)))
                    elseif falseAlarmRate > Auto_train_max_prob(:);
                        NoGoProb.value=Auto_train_max_prob(:);
                        display(' ')
                        display(' ')
                        display('NO GO PROB SET BY GUI')
                        display('FALSE ALARM RATE > NOGOPROB IN GUI')
                        display('CURRENT NOGO PROB SET TO...')
                        display(num2str(NoGoProb(:)))
                    end
                
 
                end   
                end
      end
      %%%%%%%%%%%%%%%%-PSM edit above 
      
      
      
      %need to set this correctly so that the suto trainer works with the
      %drop down for both scenerios-psm
      
      
      
        
      % Is autotrainer on? if so, that means only nogo allowed
      if (value(autotraining) == 1) 
          next_side = 'l';
          disp('AUTOTRAINER ON -- only nogos.');
      else
          % If MaxSame doesn't apply yet, choose at random
          if strcmp(value(MaxSame), 'Inf') | MaxSame > n_started_trials,
             if rand(1)<=NoGoProb, next_side = 'l'; else next_side = 'r'; end;
          else 
             % MaxSame applies, check for its rules:
             % If there's been a string of MaxSame guys all the same, force change:
             if all(previous_sides(n_started_trials-MaxSame+1:n_started_trials) == ...
                    previous_sides(n_started_trials))
                if previous_sides(n_started_trials)=='l', next_side = 'r';
                else                                      next_side = 'l';
                end;
             else
                % Haven't reached MaxSame limits yet, choose at random:
                if rand(1)<=NoGoProb, next_side = 'l'; else next_side = 'r'; end;
             end;
          end;
      end
      

    %  session_type = SessionTypeSection(obj,'get_session_type'); 
      switch SessionType
          
          case {'Licking','Pole-conditioning'}
            next_side = 'r'; % Make it always the go-trial position, so mouse doesn't have to unlearn anything.
      end
      
      %%%%%%%next trial type%%%%%%

      if   ~exist('position_mode') && numel(previous_sides) ==1
          next_trial_type = 'n'; %for normal for the first trial.
      elseif strcmp(value(position_mode), 'normal')
          next_trial_type = 'n'; %for normal 
      elseif strcmp(value(position_mode), 'arc')
          next_trial_type = 'a'; %for arc
      elseif strcmp(value(position_mode), 'on_axes') %|| strcmp(value(position_mode), 'grid_off_axes')
          %these have to be 'r' or 'a' for radial and arc respectively
          %can implement switch based auto trianer here later if
          %needed######
          if radialProb > rand()
          next_trial_type = 'r'
          else
          next_trial_type = 'a'
          end
   
      else
          error('something went wrong with choosing next trial type')
      end

      previous_sides(n_started_trials+1) = next_side;
      previous_trial_types(n_started_trials+1) = next_trial_type;
      
      %previous_angles(n_started_trials+1) = next_angle;
      %previous_radial_distances(n_started_trials+1) = next_radial_distance;

      
    case 'get_next_side',   % --------- CASE GET_NEXT_SIDE ------
      if isempty(previous_sides),
         error('Don''t have next side chosen! Did you run choose_next_side?');
      end;
      x = previous_sides(length(previous_sides));
      return;
      
      
    case 'get_next_trial',   % --------- CASE GET_NEXT_TRIAL ------
      if isempty(previous_trial_types),
         error('Don''t have next trial type chosen! Did you run choose_next_side?');
      end;
      x = previous_trial_types(length(previous_trial_types));
      return;
      
      
    case 'update_plot',     % --------- UPDATE_PLOT ------
      if ~isempty(value(previous_plot)), delete(previous_plot(:)); end;
      if isempty(previous_sides), return; end;

      ps = value(previous_sides);
      if ps(end)=='l', 
         hb = line(length(previous_sides), 2, 'Parent', value(myaxes));
      else                         
         hb = line(length(previous_sides), 1, 'Parent', value(myaxes));
      end;
      set(hb, 'Color', 'b', 'Marker', '.', 'LineStyle', 'none');
      
      xgreen = find(hit_history);
      lefts  = find(previous_sides(xgreen) == 'l');
      rghts  = find(previous_sides(xgreen) == 'r');
      ygreen = zeros(size(xgreen)); ygreen(lefts) = 2; ygreen(rghts) = 1;
      hg = line(xgreen, ygreen, 'Parent', value(myaxes));
      set(hg, 'Color', 'g', 'Marker', '.', 'LineStyle', 'none'); 

      xred  = find(~hit_history);
      lefts = find(previous_sides(xred) == 'l');
      rghts = find(previous_sides(xred) == 'r');
      yred = zeros(size(xred)); yred(lefts) = 2; yred(rghts) = 1;
      hr = line(xred, yred, 'Parent', value(myaxes));
      set(hr, 'Color', 'r', 'Marker', '.', 'LineStyle', 'none'); 

      previous_plot.value = [hb ; hr; hg];

      minx = n_done_trials - ntrials; if minx < 0, minx = 0; end;
      maxx = n_done_trials + 2; if maxx <= ntrials, maxx = ntrials+2; end;
      set(value(myaxes), 'Xlim', [minx, maxx]);
      drawnow;
      
      % Auto-trainer ----
      
      % increment counters
      psides = value(previous_sides);
    
      if (length(psides) >1 & length(hit_history) > 0)
          if(psides(end-1) == 'l') % CR or FA
            if (hit_history(end) == 1) % CR

                if (value(num_consecutive_fas) > 0)
                    num_consecutive_fas.value = 0;
                end
                num_consecutive_crs.value = value(num_consecutive_crs)+1;
            else % FA
                if (value(num_consecutive_crs) > 0)
                    num_consecutive_crs.value = 0;
                end
                num_consecutive_fas.value = value(num_consecutive_fas)+1;
            end
          end
      end
      
      disp(['consecutive FA: ' num2str(value(num_consecutive_fas)) ' CR: '  num2str(value(num_consecutive_crs))]);

      % implement punisher?
      if(value(autotraining) == 0 & value(autotrain_max_fas) > 0 && ...
         value(autotrain_max_fas) <= value(num_consecutive_fas))    
        autotraining.value = 1;
        num_consecutive_crs.value = 0;
        disp('STARTING AUTOTRAINER');
      end
      
      % disable autotrainer?
      if (value(autotraining) == 1)
          if (value(num_consecutive_crs) >= value(autotrain_min_crs))
              autotraining.value = 0;
              num_consecutive_fas.value = 0;
              disp('STOPPING AUTOTRAINER');
          end
      end
      
      % ---- end autotrainer
      
    case 'reinit',   % ------- CASE REINIT -------------
      currfig = gcf; 

      % Get the original GUI position and figure:
      x = my_gui_info(1); y = my_gui_info(2); figure(my_gui_info(3));

      delete(value(myaxes));
      
      % Delete all SoloParamHandles who belong to this object and whose
      % fullname starts with the name of this mfile:
      delete_sphandle('owner', ['^@' class(obj) '$'], ...
                      'fullname', ['^' mfilename]);

      % Reinitialise at the original GUI position and figure:
      [x, y] = feval(mfilename, obj, 'init', x, y);

      % Restore the current figure:
      figure(currfig);      
   end;