Bug fixes

Corrects the default filter parameters for EDA signals; fixes the use of
the 'size' keyword in 'signals.tools.get_heart_rate'; various
documentation fixes.

Author: capcarr

biosppy/signals/eda.py

@@ -61,7 +61,7 @@ def eda(signal=None, sampling_rate=1000., show=True):
                                  ftype='butter',
                                  band='lowpass',
                                  order=4,
-                                 frequency=20,
+                                 frequency=5,
                                  sampling_rate=sampling_rate)
 
     # smooth
@@ -101,6 +101,8 @@ def basic_scr(signal=None, sampling_rate=1000.):
     """Basic method to extract Skin Conductivity Responses (SCR) from an
     EDA signal.
 
+    Follows the approach in [Gamb08]_.
+
     Parameters
     ----------
     signal : array
@@ -117,6 +119,11 @@ def basic_scr(signal=None, sampling_rate=1000.):
     amplitudes : array
         SCR pulse amplitudes.
 
+    References
+    ----------
+    .. [Gamb08] Hugo Gamboa, "Multi-modal Behavioral Biometrics Based on HCI
+       and Electrophysiology", PhD thesis, Instituto Superior T{\'e}cnico, 2008
+
     """
 
     # check inputs

biosppy/signals/tools.py

@@ -1122,7 +1122,7 @@ def get_heart_rate(beats=None, sampling_rate=1000., smooth=False, size=3):
 
     Notes
     -----
-    * Assumes normal human heart rate to be between 40 and 190 bpm.
+    * Assumes normal human heart rate to be between 40 and 200 bpm.
 
     """
 
@@ -1144,7 +1144,6 @@ def get_heart_rate(beats=None, sampling_rate=1000., smooth=False, size=3):
 
     # smooth with moving average
     if smooth:
-        size = 5
         hr, _ = smoother(signal=hr, kernel='boxcar', size=size, mirror=True)
 
     return utils.ReturnTuple((ts, hr), ('index', 'heart_rate'))