Merge pull request #29 from Remi-Gau/remi-save_stim_files

add save stim option

Author: Remi-Gau

saveEventsFile.m

@@ -3,6 +3,24 @@
 %
 % INPUTS
 %
+% logFile:
+%   When you want to save your data logFile contains the data you want to save.
+% The logFile variable that contains the n events you want to % save must be a nx1 structure.
+% Each field will be saved in a separate column.
+%
+% example:
+% logFile(1,1).onset = 2;
+% logFile(1,1).trial_type = 'motion_up';
+% logFile(1,1).duration = 1;
+% logFile(1,1).speed = 2;
+% logFile(1,1).is_fixation = true;
+%
+% logFile(2,1).onset = 3;
+% logFile(2,1).trial_type = 'static';
+% logFile(2,1).duration = 4;
+% logFile(2,1).is_fixation = 3;
+%
+%
 % action:
 %  - 'open': will create the file ID and return it in logFile.eventLogFile using the information in
 % the expParameters structure. This file ID is then reused when calling that function to save data
@@ -28,81 +46,110 @@
 end
 
 switch action
-
+    
     case 'open'
-
+        
         logFile = struct();
-
+        
         % Initialize txt logfiles and empty fields for the standard BIDS
         %  event file
         logFile.eventLogFile = fopen(...
-            fullfile(expParameters.outputDir, expParameters.modality, expParameters.fileName.events), ...
+            fullfile(...
+            expParameters.outputDir, ...
+            expParameters.modality, ...
+            expParameters.fileName.events), ...
             'w');
-
-        % print the basic BIDS columns
-        fprintf(logFile.eventLogFile, '%s\t%s\t%s\t', 'onset', 'trial_type', 'duration');
-
-        % print any extra column specified by the user
-        %  also prepare an empty field in the structure to collect data
-        %  for those
-        for iExtraColumn = 1:numel(varargin)
-            fprintf(logFile.eventLogFile,'%s\t', lower(varargin{iExtraColumn}));
-        end
-
-        % next line so we start printing at the right place
-        fprintf(logFile.eventLogFile, '\n');
-
-
+        
+        initializeHeader(logFile, varargin);
+        
+        
+    case 'open_stim'
+        logFile = struct();
+        
+        % Initialize txt logfiles and empty fields for the standard BIDS
+        %  event file
+        logFile.eventLogFile = fopen(...
+            fullfile(...
+            expParameters.outputDir, ...
+            expParameters.modality, ...
+            expParameters.fileName.stim), ...
+            'w');
+        
+        initializeHeader(logFile, varargin);
+        
     case 'save'
-
+        
+        if ~isstruct(logFile) || size(logFile, 2)>1
+            error('The logFile variable that contains the n events you want to save must be a nx1 structure.')
+        end
+        
         % appends to the logfile all the data stored in the structure
         % first with the standard BIDS data and then any extra things
         for iEvent = 1:size(logFile,1)
-
+            
             fprintf(logFile(1).eventLogFile,'%f\t%s\t%f\t',...
                 logFile(iEvent).onset, ...
                 logFile(iEvent).trial_type, ...
                 logFile(iEvent).duration);
-
+            
             for iExtraColumn = 1:numel(varargin)
-
+                
                 % if the field we are looking for does not exist or is empty in the
                 % action logFile structure we will write a NaN otherwise we
                 % write its content
-
+                
                 if ~isfield(logFile, varargin{iExtraColumn})
                     data = [];
                 else
                     data = getfield(logFile(iEvent), varargin{iExtraColumn});
                 end
-
+                
                 if isempty(data)
                     data = NaN;
                 end
-
+                
                 if ischar(data)
                     fprintf(logFile(1).eventLogFile, '%s\t', data);
                 else
                     fprintf(logFile(1).eventLogFile, '%f\t', data);
                 end
-
+                
             end
-
+            
             fprintf(logFile(1).eventLogFile, '\n');
         end
-
+        
     case 'close'
-
+        
         % close txt log file
         fclose(logFile(1).eventLogFile);
-
+        
         if expParameters.verbose
             fprintf(1,'\nData were saved in this file:\n\n%s\n\n', ...
                 fullfile(...
                 expParameters.outputDir, ...
                 expParameters.modality, ...
                 expParameters.fileName.events));
-
+            
         end
+        
+end
 
 end
+
+function initializeHeader(logFile, varargin)
+
+% print the basic BIDS columns
+fprintf(logFile.eventLogFile, '%s\t%s\t%s\t', 'onset', 'trial_type', 'duration');
+
+% print any extra column specified by the user
+%  also prepare an empty field in the structure to collect data
+%  for those
+for iExtraColumn = 1:numel(varargin{1})
+    fprintf(logFile.eventLogFile,'%s\t', lower(varargin{1}{iExtraColumn}));
+end
+
+% next line so we start printing at the right place
+fprintf(logFile.eventLogFile, '\n');
+
+end

saveEventsFile.m~

@@ -2,7 +2,7 @@ function test_createFilename()
 
 % test for filename creation and their directories
 
-%% check directory and filename creation (PC and eyetracker)
+%% check directory and filename creation (PC)
 
 expParameters.subjectGrp = '';
 expParameters.subjectNb = 1;
@@ -34,9 +34,11 @@ function test_createFilename()
 assert(strcmp(...
               expParameters.fileName.events, ...
               ['sub-001_ses-001_task-testtask_run-001_events_date-' expParameters.date '.tsv']));
-
+assert(strcmp(...
+              expParameters.fileName.stim, ...
+              ['sub-001_ses-001_task-testtask_run-001_stim_date-' expParameters.date '.tsv']));
 
-%% check directory and filename creation (fMRI)
+%% check directory and filename creation (fMRI and eye tracker)
 
 clear
 

tests/test_createFilename.m

@@ -18,18 +18,20 @@ function test_saveEventsFile()
 
 
 
-%% create the file
+%% create the events and stim files
 
 logFile = saveEventsFile('open', expParameters, [], 'Speed', 'is_Fixation');
 
+stimFile = saveEventsFile('open_stim', expParameters, []);
 
 % ---- test section
 
 fileName = fullfile(expParameters.outputDir, expParameters.modality, expParameters.fileName.events);
+stimFileName = fullfile(expParameters.outputDir, expParameters.modality, expParameters.fileName.stim);
 
 % check that the file has the right path and name
 assert(exist(fileName, 'file')==2)
-
+assert(exist(stimFileName, 'file')==2)
 
 
 %%  write things in it