Differences

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

Link to this comparison view

reference:ft_heartrate [2018/08/23 14:43] (current)
Line 1: Line 1:
 +=====  FT_HEARTRATE =====
 +
 +Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help ft_heartrate"​.
 +
 +<​html><​pre>​
 +  <a href=/​reference/​ft_heartrate><​font color=green>​FT_HEARTRATE</​font></​a>​ estimates the heart rate from a continuous PPG or ECG channel. It
 +  returns a new data structure with a continuous representation of the heartrate in
 +  beats per minute.
 + 
 +  Use as
 +    dataout = ft_heartrate(cfg,​ data)
 +  where the input data is a structure as obtained from <a href=/​reference/​ft_preprocessing><​font color=green>​FT_PREPROCESSING</​font></​a>​.
 + 
 +  The configuration structure has the following options
 +    cfg.channel ​         = selected channel for processing, see <a href=/​reference/​ft_channelselection><​font color=green>​FT_CHANNELSELECTION</​font></​a>​
 +    cfg.envelopewindow ​  = scalar, time in seconds
 +    cfg.peakseparation ​  = scalar, time in seconds
 +    cfg.threshold ​       = scalar, between 0 and 1 (default = 0.4)
 +    cfg.feedback ​        = '​yes'​ or '​no'​
 +  The input data can be preprocessed on the fly using
 +    cfg.preproc.bpfilter = '​yes'​ or '​no'​
 +    cfg.preproc.bpfreq ​  = [low high], filter frequency in Hz
 + 
 +  See also <a href=/​reference/​ft_electrodermalactivity><​font color=green>​FT_ELECTRODERMALACTIVITY</​font></​a>,​ <a href=/​reference/​ft_headmovement><​font color=green>​FT_HEADMOVEMENT</​font></​a>,​ <a href=/​reference/​ft_regressconfound><​font color=green>​FT_REGRESSCONFOUND</​font></​a>​
 +</​pre></​html>​