Differences

This shows you the differences between two versions of the page.

Link to this comparison view

reference:ft_realtime_signalrecorder [2018/08/23 14:43] (current)
Line 1: Line 1:
 +=====  FT_REALTIME_SIGNALRECORDER =====
 +
 +Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help ft_realtime_signalrecorder"​.
 +
 +<​html><​pre>​
 +  <a href=/​reference/​ft_realtime_signalrecorder><​font color=green>​FT_REALTIME_SIGNALRECORDER</​font></​a>​ is an example realtime application for recording of data
 +  that is streaming to the buffer in real-time. It should work both for EEG and MEG.
 + 
 +  Use as
 +    ft_realtime_signalrecorder(cfg)
 +  with the following configuration options
 +    cfg.blocksize ​ = number, size of the blocks/​chuncks that are processed (default = 1 second)
 +    cfg.channel ​   = cell-array, see <a href=/​reference/​ft_channelselection><​font color=green>​FT_CHANNELSELECTION</​font></​a>​ (default = '​all'​)
 +    cfg.bufferdata = whether to start on the 'first or '​last'​ data that is available (default = '​last'​)
 +    cfg.jumptoeof ​ = whether to skip to the end of the stream/file at startup (default = '​yes'​)
 + 
 +  The source of the data, i.e. where it comes from, is configured as
 +    cfg.dataset ​      = string
 +  or alternatively to obtain more low-level control as
 +    cfg.datafile ​     = string
 +    cfg.headerfile ​   = string
 +    cfg.eventfile ​    = string
 +    cfg.dataformat ​   = string, default is determined automatic
 +    cfg.headerformat ​ = string, default is determined automatic
 +    cfg.eventformat ​  = string, default is determined automatic
 + 
 +  The target for the data, i.e. where it goes to, is configured as
 +    cfg.export.dataset ​   = string with the output file name
 +    cfg.export.dataformat = string describing the output file format, see <a href=/​reference/​ft_write_data><​font color=green>​FT_WRITE_DATA</​font></​a>​
 + 
 +  Some notes about skipping data and catching up with the data stream:
 + 
 +  cfg.jumptoeof='​yes'​ causes the realtime function to jump to the end
 +  when the function _starts_. It causes all data acquired prior to
 +  starting the realtime function to be skipped.
 + 
 +  cfg.bufferdata='​last'​ causes the realtime function to jump to the last
 +  available data while _running_. If the realtime loop is not fast enough,
 +  it causes some data to be dropped.
 + 
 +  If you want to skip all data that was acquired before you start the
 +  RT function, but don't want to miss any data that was acquired while
 +  the realtime function is started, then you should use jumptoeof=yes and
 +  bufferdata='​first'​. If you want to analyse data from a file, then you
 +  should use cfg.jumptoeof='​no'​ and cfg.bufferdata='​first'​.
 + 
 +  To stop this realtime function, you will have have to press Ctrl-C.
 +</​pre></​html>​