SOURCE
ssibiosig.dll

SUMMARY
RSPFeaturesTime RSPFeaturesTime
RSPFeaturesSpectral RSPFeaturesSpectral
QRSPulseEventListener QRSPulseEventListener
QRSPreProcess QRSPreProcess
QRSHrvEventListener QRSHrvEventListener
QRSHeartRateMean QRSHeartRateMean
QRSHeartRate QRSHeartRate
QRSHRVtime QRSHRVtime
QRSHRVspectral QRSHRVspectral
QRSDetection QRSDetection
QRSDetect QRSDetect
GSRResponseEventSender GSRResponseEventSender
GSRRemoveBaseline GSRRemoveBaseline
GSRFeatures GSRFeatures
GSREventSender GSREventSender
GSREventListener GSREventListener
GSRBaselineMean GSRBaselineMean
GSRArtifactFilter GSRArtifactFilter
GSRArousalEstimation GSRArousalEstimation
EMGRemoveBaseline EMGRemoveBaseline
EMGRectify EMGRectify
EMGFeaturesTime EMGFeaturesTime
EMGFeaturesSpectral EMGFeaturesSpectral
EMGDetermineNoise EMGDetermineNoise
BVPEventStatisticalListener BVPEventStatisticalListener
BVPEventSender BVPEventSender
BVPEventRawListener BVPEventRawListener
BVPEventRMSSDListener BVPEventRMSSDListener
ArousalCombination ArousalCombination

DETAILS
RSPFeaturesTime
  RSPFeaturesTime  FEATURE
 
           calculates respiratory features
 
             +  print_info   BOOL   1   'false'   LOCK   print info about feature calculation 
             +  print_features   BOOL   1   'false'   LOCK   print feature name and number 
             +  sr   FLOAT   1   '256.00000'   LOCK   sample rate pf the sensor 
 
RSPFeaturesSpectral
  RSPFeaturesSpectral  FEATURE
 
           calculates spectral features from RSP spectogram.
 
             +  print   BOOL   1   'false'   LOCK   print features to console 
 
QRSPulseEventListener
  QRSPulseEventListener  OBJECT
 
           Listens to events from QRS-Detection and calculates pulse.
 
             +  sname   CHAR   1024   'qrs'   LOCK   name of sender 
             +  ename   CHAR   1024   'pulse'   LOCK   name of event 
             +  span   INT   1   '60000'   LOCK   Time span for pulse calculation in ms (NOTE: must be equal to span set in register function). 
             +  update_ms   INT   1   '5000'   LOCK   Time interval the updated pulse is sent via event. 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
 
QRSPreProcess
  QRSPreProcess  FILTER
 
           Applies pre-processing steps to an ecg signal for qrs complex detection.
 
             +  N   UINT   1   '10'   LOCK   window length 
 
QRSHrvEventListener
  QRSHrvEventListener  OBJECT
 
           Listens to events from QRS-Detection and calculates heart rate variability.
 
             +  sname   CHAR   1024   'qrshrvlistener'   LOCK   name of sender 
             +  ename   CHAR   1024   'hrv'   LOCK   name of event 
             +  span   INT   1   '60000'   LOCK   Time span for hrv calculation in ms. 
             +  update_ms   INT   1   '5000'   LOCK   Time interval the updated fusion vector is sent via event. 
             +  amplifier   FLOAT   1   '1.00000'   LOCK   multiply value of change with amplifier. 
 
QRSHeartRateMean
  QRSHeartRateMean  CONSUMER
 
           sends hr-mean events to the board
 
             +  winsize   FLOAT   1   '0.00000'   LOCK   size in seconds of mean window 
             +  cap   BOOL   1   'true'   LOCK   cap change value [-1.0 .. 1.0] 
             +  amplifier   FLOAT   1   '1.00000'   LOCK   multiply value of change with amplifier 
 
QRSHeartRate
  QRSHeartRate  FEATURE
 
           converts QRS signal to heart rate
 
             +  defhr   FLOAT   1   '75.00000'   LOCK   inital heart rate value (bpm) 
             +  smooth   BOOL   1   'false'   LOCK   applying smoothing between successive heart rate values 
 
QRSHRVtime
  QRSHRVtime  FEATURE
 
           ...
 
             +  print   BOOL   1   'false'   LOCK   print features to console 
 
QRSHRVspectral
  QRSHRVspectral  FEATURE
 
           calculates spectral features from HR spectogram.
 
             +  print   BOOL   1   'false'   LOCK   print features to console 
 
QRSDetection
  QRSDetection  FILTER
 
           ...
 
             +  sname   CHAR   1024   'qrs'   LOCK   name of sender 
             +  ename   CHAR   1024   'rspike'   LOCK   name of event 
             +  depthRR   INT   1   '8'   LOCK   Depth of RR-interval consideration. 
             +  lowerLimitRR   FLOAT   1   '0.50000'   LOCK   % of demanded RR-interval length for next R-spike (avoids recognition of T-waves). 
             +  upperLimitRR   FLOAT   1   '1.25000'   LOCK   % of demanded RR-interval length for expecting next R-spike (temporarily lowers threshold for R-spike detection). 
             +  sendEvent   BOOL   1   'false'   LOCK   send an event to the board whenever a R-spike is detected 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
 
QRSDetect
  QRSDetect  FILTER
 
           Applies qrs complex detection to an ecg signal. Frames with value 1 mark an R-spike
 
             +  sname   CHAR   1024   'qrs'   LOCK   name of sender 
             +  ename   CHAR   1024   'rspike'   LOCK   name of event 
             +  depthRR   INT   1   '8'   LOCK   Depth of RR-interval consideration. 
             +  lowerLimitRR   FLOAT   1   '0.50000'   LOCK   % of demanded RR-interval length for next R-spike (avoids recognition of T-waves). 
             +  upperLimitRR   FLOAT   1   '1.25000'   LOCK   % of demanded RR-interval length for expecting next R-spike (temporarily lowers threshold for R-spike detection). 
             +  sendEvent   BOOL   1   'false'   LOCK   send an event to the board whenever a R-spike is detected 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
 
GSRResponseEventSender
  GSRResponseEventSender  CONSUMER
 
           gsr response event sender
 
             +  sname   CHAR   1024   'gsr'   LOCK   name of sender 
             +  ename   CHAR   1024   'response'   LOCK   name of event 
             +  print   BOOL   1   'false'   LOCK   print response information to console 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
             +  minAmplitude   FLOAT   1   '0.00000'   LOCK   minimum amplitude for a response to be detected 
             +  minRisingTime   DOUBLE   1   '0.00000'   LOCK   minimum rising time for a response to be detected (seconds) 
             +  minAllowedRegression   FLOAT   1   '0.00000'   LOCK   minimum allowed regression after a peak to continue the response's peak search 
 
GSRRemoveBaseline
  GSRRemoveBaseline  FILTER
 
           Removes baseline of GSR signal
 
             +  winsize   FLOAT   1   '0.00000'   LOCK   size in seconds of detrend window 
 
GSRFeatures
  GSRFeatures  FEATURE
 
           calculates gsr features
 
             +  print_info   BOOL   1   'false'   LOCK   print info about feature calculation 
             +  print_features   BOOL   1   'false'   LOCK   print feature name and number 
             +  winsize   FLOAT   1   '0.00000'   LOCK   size in seconds of detrend window 
             +  peakmind   FLOAT   1   '1.00000'   LOCK   peak minimum duration in seconds 
             +  peakmaxd   FLOAT   1   '4.00000'   LOCK   peak maximum duration in seconds 
             +  peaknstd   FLOAT   1   '0.25000'   LOCK   peak threshold = n * standard deviation 
             +  slopemind   FLOAT   1   '0.50000'   LOCK   slope minimum duration in seconds 
             +  slopemaxd   FLOAT   1   '4.00000'   LOCK   slope maximum duration in seconds 
             +  slopenstd   DOUBLE   1   '0.00003'   LOCK   slope threshold = n * standard deviation 
             +  f_number   BOOL   1   'true'   LOCK   compute number of peaks/slopes/drops/combo 
             +  f_type_peaks   BOOL   1   'true'   LOCK   compute peaks 
             +  f_type_slopes   BOOL   1   'true'   LOCK   compute slopes 
             +  f_type_drops   BOOL   1   'true'   LOCK   compute drops 
             +  f_type_combo   BOOL   1   'true'   LOCK   compute combination of peaks, slopes and drops 
             +  f_att_duration   BOOL   1   'true'   LOCK   compute duration attribute of peaks/slopes/drops/combo 
             +  f_att_amplitude   BOOL   1   'true'   LOCK   compute amplitude attribute of peaks/slopes/drops/combo 
             +  f_att_area   BOOL   1   'true'   LOCK   compute area attribute of peaks/slopes/drops/combo 
             +  f_stat_min   BOOL   1   'true'   LOCK   compute minimum of selected attributes 
             +  f_stat_max   BOOL   1   'true'   LOCK   compute maximum of selected attributes 
             +  f_stat_avg   BOOL   1   'true'   LOCK   compute average of selected attributes 
             +  f_stat_var   BOOL   1   'true'   LOCK   compute variance of selected attributes 
             +  f_stat_std   BOOL   1   'true'   LOCK   compute standard deviation of selected attributes 
             +  new_features   BOOL   1   'false'   LOCK   include the top 13 features from s. gruss 
 
GSREventSender
  GSREventSender  CONSUMER
 
           sends gsr events
 
             +  sname   CHAR   1024   'gsr'   LOCK   name of sender 
             +  epeakname   CHAR   1024   'peak'   LOCK   name of peak event 
             +  eslopename   CHAR   1024   'slope'   LOCK   name of slope event 
             +  edropname   CHAR   1024   'drop'   LOCK   name of drop event 
             +  winsize   FLOAT   1   '0.00000'   LOCK   size in seconds of detrend window 
             +  peakmind   FLOAT   1   '1.50000'   LOCK   peak minimum duration in seconds 
             +  peakmaxd   FLOAT   1   '4.00000'   LOCK   peak maximum duration in seconds 
             +  peaknstd   FLOAT   1   '0.25000'   LOCK   peak threshold = n * standard deviation 
             +  slopemind   FLOAT   1   '0.50000'   LOCK   slope minimum duration in seconds 
             +  slopemaxd   FLOAT   1   '3.00000'   LOCK   slope maximum duration in seconds 
             +  slopenstd   DOUBLE   1   '0.00003'   LOCK   slope threshold = n * standard deviation 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
 
GSREventListener
  GSREventListener  SENSOR
 
           provides statistical evaluations over a given window on gsr response events
 
             +  sr   DOUBLE   1   '1.00000'   LOCK   sampling rates (hz) 
             +  window   INT   1   '0'   LOCK   Time span for hrv calculation in ms. 0 means no window (all prior events are used). This option competes with listener span. 
             +  statisticalFunction   INT   1   '0'   LOCK   0-Sum, 1-Mean, 2-Variance, 3-StdDev 
 
           Available channels:
 
             +  number of responses   Provides statistical evaluation (sum only) for number of responses of a gsr signal 
             +  amplitude   Provides statistical evaluation for response amplitudes of a gsr signal 
             +  rising time   Provides statistical evaluation for response rising times of a gsr signal 
             +  energy   Provides statistical evaluation for response energy of a gsr signal 
             +  power   Provides statistical evaluation for response power of a gsr signal 
 
GSRBaselineMean
  GSRBaselineMean  CONSUMER
 
           sends gsr-mean events to the board
 
             +  winsize   FLOAT   1   '0.00000'   LOCK   size in seconds of mean window 
             +  cap   BOOL   1   'true'   LOCK   cap change value [-1.0 .. 1.0] 
 
GSRArtifactFilter
  GSRArtifactFilter  FILTER
 
           Filters artifacts from GSR signal.
 
             +  winsize   FLOAT   1   '-0.00000'   LOCK   ... 
             +  replacement   FLOAT   1   '-0.00000'   LOCK   ... 
             +  lower_range   FLOAT   1   '0.00000'   LOCK   ... 
             +  upper_range   FLOAT   1   '1.00000'   LOCK   ... 
             +  thres   FLOAT   1   '4.00000'   LOCK   ... 
 
GSRArousalEstimation
  GSRArousalEstimation  FILTER
 
           Estimates arousal value [0..1] from gsr signal
 
             +  winsize_shortterm   FLOAT   1   '0.00000'   LOCK   size in seconds of shorttime window 
             +  winsize_longterm   FLOAT   1   '0.00000'   LOCK   size in seconds of longtime window 
 
EMGRemoveBaseline
  EMGRemoveBaseline  TRANSFORMER
 
           Removes baseline from EMG signal
 
             +  winsize   DOUBLE   1   '15.00000'   LOCK   window size 
 
EMGRectify
  EMGRectify  TRANSFORMER
 
           Rectifies EMG signal
 
             +  print_info   BOOL   1   'false'   LOCK   print info 
 
EMGFeaturesTime
  EMGFeaturesTime  FEATURE
 
           calculates emg features in the time domain
 
             +  print_info   BOOL   1   'false'   LOCK   print info about feature calculation 
             +  print_features   BOOL   1   'false'   LOCK   print feature name and number 
             +  hemg_segments   UINT   1   '5'   LOCK   number of histogram segments 
             +  new_features   BOOL   1   'false'   LOCK   include the top 13 features from s. gruss 
             +  n_me   UINT   1   '8'   LOCK   number of segments for me feature 
 
EMGFeaturesSpectral
  EMGFeaturesSpectral  FEATURE
 
           calculates emg features in the spectral domain
 
             +  print_info   BOOL   1   'false'   LOCK   print info about feature calculation 
             +  print_features   BOOL   1   'false'   LOCK   print feature name and number 
             +  n_ar_coeffs   UINT   1   '4'   LOCK   number of auto-regressive coefficients 
             +  ar_method   UINT   1   '0'   LOCK   auto-regressive coefficient calculation method (maxentropy = 0, leastsquares = 1) 
             +  fr_threshold   FLOAT   1   '0.66667'   LOCK   threshold for frequency ratio [0..1] 
 
EMGDetermineNoise
  EMGDetermineNoise  TRANSFORMER
 
           Determines noise level in am EMG signal
 
             +  winsize   DOUBLE   1   '120.00000'   LOCK   window size 
 
BVPEventStatisticalListener
  BVPEventStatisticalListener  SENSOR
 
           Listens to the events of the BVPEventSender and provides statistical evaluations over a given window.
 
             +  sr   DOUBLE   1   '1.00000'   LOCK   sampling rate of the output signal (Hz) 
             +  window   INT   1   '0'   LOCK   Time span for hrv calculation in ms. 0 means no window (all prior events are used). This option competes with listener span. 
             +  statisticalFunction   INT   1   '0'   LOCK   0-Sum, 1-Mean, 2-Variance, 3-StdDev 
 
           Available channels:
 
             +  amplitude   statistical evaluations of the amplitude of the beats in a bvp signal in the given window 
             +  heart rate   statistical evaluations of the heart rate of the bvp signal in the given window 
             +  interbeat interval   statistical evaluations of the interbeat interval of the bvp signal in the given window 
 
BVPEventSender
  BVPEventSender  CONSUMER
 
           sends bvp beat events
 
             +  sname   CHAR   1024   'bvp'   LOCK   name of sender 
             +  ename   CHAR   1024   'beats'   LOCK   name of event 
             +  mean_window   INT   1   '3'   LOCK   mean window (in seconds) to get a baseline for beat detection 
             +  print   BOOL   1   'false'   LOCK   print response information to console 
             +  tuple   BOOL   1   'false'   LOCK   send tuple events instead of array 
             +  beep   BOOL   1   'false'   LOCK   beep on heart beat received 
 
BVPEventRawListener
  BVPEventRawListener  SENSOR
 
           Listens to the events of the BVPEventSender and provides bvp beat event features
 
             +  sr   DOUBLE   1   '1.00000'   LOCK   sampling rate of the output signal (Hz) 
 
           Available channels:
 
             +  amplitude   amplitude of the last beat of the bvp signal 
             +  heart rate   heart rate measured from the last two beats of the bvp signal 
             +  interbeat interval   interbeat interval measured from the last two beats of the bvp signal 
 
BVPEventRMSSDListener
  BVPEventRMSSDListener  SENSOR
 
           Listens to the events of the BVPEventSender and calculates the RMSSD. RMSSD is the square root of the mean squared differences of successive interbeat intervals.
 
             +  sr   DOUBLE   1   '1.00000'   LOCK   sampling rate of the output signal (Hz) 
             +  window   INT   1   '0'   LOCK   Time span for RMSSD calculation in ms. 0 means no window (all prior events are used). This option competes with listener span. 
 
           Available channels:
 
             +  RMSSD   RMSSD is the square root of the mean squared differences of successive NN intervals. 
 
ArousalCombination
  ArousalCombination  FILTER
 
           Estimates arousal value [0..1] from gsr signal
 
 


Built with Social Signal Interpretation (SSI) [v1.0.5]
(c) University of Augsburg
http://openssi.net