get expDesign from Marco's Branch

Remi-Gau · Remi-Gau · commit 1142def534bb · 2020-08-02T21:50:46.000+02:00
diff --git a/subfun/expDesign.m b/subfun/expDesign.m
@@ -1,20 +1,24 @@
 function [cfg] = expDesign(cfg, displayFigs)
     % Creates the sequence of blocks and the events in them
     %
-    % The conditions are consecutive static and motion blocks
-    % Gives better results than randomised.
-    %
-    % It can be run as a stand alone without inputs to display a visual example of possible design.
+    % The conditions are consecutive static and motion blocks (Gives better results than randomised).
     %
     % EVENTS
     %  The numEventsPerBlock should be a multiple of the number of "base"
     %  listed in the motionDirections and staticDirections (4 at the moment).
+    %  Pseudorandomization rules:
+    %  (1) Directions are all present in random orders in `numEventsPerBlock/nDirections`
+    %      consecutive chunks. This evenly distribute the directions across the
+    %      block.
+    %  (2) No same consecutive direction (TO IMPLEMENT)
     %
-    %
-    % TARGETS:
-    %  If there are 2 targets per block we make sure that they are at least 2
-    %   events apart.
-    %  Targets cannot be on the first or last event of a block
+    % TARGETS
+    %  Pseudorandomization rules:
+    %  (1) If there are 2 targets per block we make sure that they are at least 2
+    %      events apart.
+    %  (2) Targets cannot be on the first or last event of a block.
+    %  (3) Targets can not be present more than 2 times in the same event
+    %      position across blocks.
     %
     % Input:
     %   - ExpParameters: parameters returned by SetParameters
@@ -30,19 +34,19 @@
     %       - 0 90 180 270 indicate the angle
     %       - -1 indicates static
     %
-    %   - ExpParameters.designSpeeds          = array (nr_blocks, numEventsPerBlock) * speedEvent
+    %   - ExpParameters.designSpeeds          = array (nr_blocks, numEventsPerBlock) * speedEvent;
     %
     %   - ExpParameters.designFixationTargets = array (nr_blocks, numEventsPerBlock)
     %   showing for each event if it should be accompanied by a target
     %
 
     % Set directions for static and motion condition
     motionDirections = [0 90 180 270];
-%     staticDirections = [0 90 180 270];
-        staticDirections = [-1 -1 -1 -1];
-
+    staticDirections = [-1 -1 -1 -1];
+    
+    
     %% Check inputs
-
+    
     % Set variables here for a dummy test of this function
     if nargin < 1 || isempty(cfg)
         cfg.names             = {'static', 'motion'};
@@ -67,101 +71,232 @@
     if mod(numEventsPerBlock, length(motionDirections)) ~= 0
         warning('Number of events/block not a multiple of number of motion/static direction');
     end
-
+    
+    
     %% Adapt some variables according to input
-
-    % Set directions for static and motion condition
-    motionDirections = repmat(motionDirections, 1, numEventsPerBlock / length(motionDirections));
-    staticDirections = repmat(staticDirections, 1, numEventsPerBlock / length(staticDirections));
-
+    
     % Assign the conditions
     condition = repmat(names, 1, numRepetitions);
     nrBlocks = length(condition);
+    
+    % Assigne design parameters to be exported
+    cfg.designBlockNames      = cell(nrBlocks, 1);
+    cfg.designDirections      = zeros(nrBlocks, numEventsPerBlock);
+    cfg.designSpeeds          = ones(nrBlocks, numEventsPerBlock) * speedEvent;
+    cfg.designFixationTargets = zeros(nrBlocks, numEventsPerBlock);
+    
+    % Create a vector for the static condition
+    staticDirections = repmat(staticDirections, 1, numEventsPerBlock/length(staticDirections));
+    
     % Get the index of each condition
-    staticIndex = find(strcmp(condition, 'static'));
-    motionIndex = find(strcmp(condition, 'motion'));
-
+    staticIndex = find( strcmp(condition, 'static') );
+    motionIndex = find( strcmp(condition, 'motion') );
+    
+    for iMotionBlock = 1:numRepetitions
+        
+        % Shuffle and set motion direction order
+        cfg.designDirections(motionIndex(iMotionBlock),:) = ...
+            [ Shuffle(motionDirections), Shuffle(motionDirections), Shuffle(motionDirections)];
+        
+        % Set static condition
+        cfg.designDirections(staticIndex(iMotionBlock),:) = staticDirections;
+        
+    end
+    
     % Assign the targets for each condition
     rangeTargets = [1 maxNumFixTargPerBlock];
+    
+    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+    
+    % % % IT COULD BE A PROBLEM IF WE SET THE N OF TARGETS RANDOMLY (TOO CHOOSE
+    % % % RANDOMLY B/W 1 AND 2 FOR N TIMES) BECAUSE AT THE END EACH PARTICIPANT
+    % % % HAS A DIFFERENET NUMBER OF TARKETS TO GET, LMK
+    
     % Get random number of targets for one condition
     targetPerCondition = randi(rangeTargets, 1, numRepetitions);
     % Assign the number of targets for each condition after shuffling
     numTargets = zeros(1, nrBlocks);
     numTargets(staticIndex) = Shuffle(targetPerCondition);
     numTargets(motionIndex) = Shuffle(targetPerCondition);
-
-    %% Give the blocks the names with condition
-
-    cfg.design.blockNames      = cell(nrBlocks, 1);
-    cfg.design.directions      = zeros(nrBlocks, numEventsPerBlock);
-    cfg.design.speeds          = ones(nrBlocks, numEventsPerBlock) * dotsSpeed;
-    cfg.design.fixationTargets = zeros(nrBlocks, numEventsPerBlock);
-
-    for iMotionBlock = 1:numRepetitions
-
-        cfg.design.directions(motionIndex(iMotionBlock), :) = Shuffle(motionDirections);
-        cfg.design.directions(staticIndex(iMotionBlock), :) = Shuffle(staticDirections);
-
-    end
-
-    for iBlock = 1:nrBlocks
-
-        % Set block name
-        switch condition{iBlock}
-            case 'static'
-                thisBlockName = {'static'};
-            case 'motion'
-                thisBlockName = {'motion'};
+    
+    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+    
+    %% Give the blocks the names with condition and design the task in each event
+    
+    while 1
+        
+        for iBlock = 1:nrBlocks
+            
+            
+            % Set block name
+            switch condition{iBlock}
+                case 'static'
+                    thisBlockName = {'static'};
+                case 'motion'
+                    thisBlockName = {'motion'};
+            end
+            
+            cfg.designBlockNames(iBlock) = thisBlockName;
+            
+            % Set target
+            %  - if there are 2 targets per block we make sure that they are at least
+            %  2 events apart
+            %  - targets cannot be on the first or last event of a block
+            %  - no more than 2 target in the same event order
+            
+            chosenTarget = [];
+            
+            tmpTarget = numTargets(iBlock);
+            
+            switch tmpTarget
+                
+                case 1
+                    
+                    chosenTarget = randsample(2:numEventsPerBlock-1, tmpTarget, false);
+                    
+                case 2
+                    
+                    targetDifference = 0;
+                    
+                    
+                    while targetDifference <= 2
+                        chosenTarget = randsample(2:numEventsPerBlock-1, tmpTarget, false);
+                        targetDifference = (max(chosenTarget) - min(chosenTarget));
+                    end
+                    
+            end
+            
+            cfg.designFixationTargets(iBlock, chosenTarget) = 1;
+            
         end
-        cfg.design.blockNames(iBlock) = thisBlockName;
-
-        % set target
-        % if there are 2 targets per block we make sure that they are at least
-        % 2 events apart
-        % targets cannot be on the first or last event of a block
-
-        chosenTarget = [];
-
-        tmpTarget = numTargets(iBlock);
-
-        switch tmpTarget
-
-            case 1
-
-                chosenTarget = randsample(2:numEventsPerBlock - 1, tmpTarget, false);
-
-            case 2
-
-                targetDifference = 0;
-
-                while targetDifference <= 2
-                    chosenTarget = randsample(2:numEventsPerBlock - 1, tmpTarget, false);
-                    targetDifference = (max(chosenTarget) - min(chosenTarget));
-                end
-
+        
+        % Check rule 3
+        if max(sum(cfg.designFixationTargets)) < 3
+            break
+        else
+            cfg.designBlockNames      = cell(nrBlocks, 1);
+            cfg.designFixationTargets = zeros(nrBlocks, numEventsPerBlock);
         end
-
-        cfg.design.fixationTargets(iBlock, chosenTarget) = 1;
-
+        
     end
-
+    
+    
+    designSpeeds = cfg.designSpeeds';
+    designDirections = cfg.designDirections';
+    designFixationTargets = cfg.designFixationTargets';
+    
+    cfg.trialList = [designDirections(:) designSpeeds(:) designFixationTargets(:)];
+    
+    
+    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+    
     %% Visualize the design matrix
     if displayFigs
-
-        uniqueNames = unique(cfg.design.blockNames) ;
-
-        Ind = zeros(length(cfg.design.blockNames), length(uniqueNames)) ;
-
-        for i = 1:length(uniqueNames)
-            CondInd(:, i) = find( ...
-                strcmp(cfg.design.blockNames, uniqueNames{i})) ; %#ok<*AGROW>
-            Ind(CondInd(:, i), i) = 1 ;
+        
+        figure(1);
+        
+        
+        % Shows blocks (static and motion) and events (motion direction) order
+        subplot(3,3,1)
+        
+        designDirection = cfg.designDirections;
+        designDirection(designDirection==-1) = -90;
+        
+        imagesc(designDirection)
+        
+        labelAxesBlock()
+        
+        caxis([-90-37, 270+37])
+        myColorMap = lines(5);
+        colormap(myColorMap);
+        
+        title('Block (static and motion) & Events (motion direction)')
+        
+        
+        % Shows the direction position distribution in the motion blocks
+        %  across the experiment
+        subplot(3,3,2)
+        
+        leftPosition = [];
+        for i=1:nrBlocks
+            leftPosition = [ leftPosition find(cfg.designDirections(i,:)==0) ];
         end
-
-        imagesc(Ind);
-
-        set(gca, ...
-            'XTick', 1:length(uniqueNames), ...
-            'XTickLabel', uniqueNames);
-
+        hist(leftPosition)
+        scaleAxes()
+        labelAxesFreq()
+        title('0')
+        
+        subplot(3,3,3)
+        
+        rightPosition = [];
+        for i=1:nrBlocks
+            rightPosition = [ rightPosition find(cfg.designDirections(i,:)==90) ];
+        end
+        hist(rightPosition)
+        scaleAxes()
+        labelAxesFreq()
+        title('90')
+        
+        subplot(3,3,5)
+        
+        upPosition = [];
+        for i=1:nrBlocks
+            upPosition = [ upPosition find(cfg.designDirections(i,:)==180) ];
+        end
+        hist(upPosition)
+        scaleAxes()
+        labelAxesFreq()
+        title('180')
+        
+        subplot(3,3,6)
+        
+        downPosition = [];
+        for i=1:nrBlocks
+            downPosition = [ downPosition find(cfg.designDirections(i,:)==270) ];
+        end
+        hist(downPosition)
+        scaleAxes()
+        labelAxesFreq()
+        title('270')
+        
+        
+        % Shows the fixation targets design in each event (1 or 0)
+        subplot(3,3,7)
+        
+        imagesc(cfg.designFixationTargets)
+        labelAxesBlock()
+        title('Fixation Targets design')
+        
+        
+        % Shows the fixation targets position distribution in the block across
+        %  the experimet
+        subplot(3,3,8)
+        
+        itargetPosition = [];
+        for i=1:nrBlocks
+            itargetPosition = [ itargetPosition find(cfg.designFixationTargets(i,:)==1) ];
+        end
+        hist(itargetPosition)
+        labelAxesFreq()
+        title('Fixation Targets position distribution')
+        
     end
+    
+end
+
+function labelAxesBlock()
+    % an old viking saying because they really cared about their axes
+    ylabel('Block seq.', 'Fontsize', 8);
+    xlabel('Events', 'Fontsize', 8);
+end
+
+function labelAxesFreq()
+    % an old viking saying because they really cared about their axes
+    ylabel('freq.', 'Fontsize', 8);
+    xlabel('Events', 'Fontsize', 8);
+end
+
+function scaleAxes()
+    xlim([1 12])
+    ylim([0 5])
+end
