SaveEvents

SaveEvents - Write events to file.

  USAGE

    SaveEvents(filename,events,options)

    filename       event file name
    events         event data
    <options>      optional list of property-value pairs (see table below)

    =========================================================================
     Properties    Values
    -------------------------------------------------------------------------
     'overwrite'   overwrite file if it exists (default = 'off')
    =========================================================================

  SEE

    See also NewEvents, LoadEvents, SaveRippleEvents.

0001 function SaveEvents(filename,events,varargin)
0002 
0003 %SaveEvents - Write events to file.
0004 %
0005 %  USAGE
0006 %
0007 %    SaveEvents(filename,events,options)
0008 %
0009 %    filename       event file name
0010 %    events         event data
0011 %    <options>      optional list of property-value pairs (see table below)
0012 %
0013 %    =========================================================================
0014 %     Properties    Values
0015 %    -------------------------------------------------------------------------
0016 %     'overwrite'   overwrite file if it exists (default = 'off')
0017 %    =========================================================================
0018 %
0019 %  SEE
0020 %
0021 %    See also NewEvents, LoadEvents, SaveRippleEvents.
0022 
0023 % Copyright (C) 2004-2015 by Michaël Zugaro
0024 %
0025 % This program is free software; you can redistribute it and/or modify
0026 % it under the terms of the GNU General Public License as published by
0027 % the Free Software Foundation; either version 3 of the License, or
0028 % (at your option) any later version.
0029 
0030 % Default values
0031 overwrite = 'off';
0032 
0033 if nargin < 2,
0034   error('Incorrect number of parameters (type ''help <a href="matlab:help SaveEvents">SaveEvents</a>'' for details).');
0035 end
0036 
0037 for i = 1:2:length(varargin),
0038     if ~ischar(varargin{i}),
0039         error(['Parameter ' num2str(i+2) ' is not a property (type ''help <a href="matlab:help SaveEvents">SaveEvents</a>'' for details).']);
0040     end
0041     switch(lower(varargin{i})),
0042         case 'overwrite',
0043             overwrite = varargin{i+1};
0044             if ~isastring(overwrite,'on','off'),
0045                 error('Incorrect value for property ''overwrite'' (type ''help <a href="matlab:help SaveEvents">SaveEvents</a>'' for details).');
0046             end
0047         otherwise,
0048             error(['Unknown property ''' num2str(varargin{i}) ''' (type ''help <a href="matlab:help SaveEvents">SaveEvents</a>'' for details).']);
0049     end
0050 end
0051 
0052 if strcmp('overwrite','off') && exist(filename),
0053     error('File already exists. Aborting.');
0054 end
0055 
0056 file = fopen(filename,'w');
0057 if file == -1,
0058     error(['Cannot write to ' filename]);
0059 end
0060 
0061 
0062 for i = 1:length(events.time),
0063     fprintf(file,'%f\t%s\n',events.time(i)*1000,events.description{i}); % Convert to milliseconds
0064 end
0065 
0066 fclose(file);