Enhance documentation with theme migration, new features, and updates

biosppy/features/time.py

@@ -22,29 +22,29 @@
 def time(signal=None, sampling_rate=1000., include_diff=True):
     """Compute various time metrics describing the signal.
 
-        Parameters
-        ----------
-        signal : array
-            Input signal.
-        sampling_rate : int, float, optional
-            Sampling Rate (Hz).
-        include_diff : bool, optional
-            Whether to include the features of the signal's differences (first, second and absolute).
-
-        Returns
-        -------
-        feats : ReturnTuple object
-            Time features of the signal.
-
-        Notes
-        -----
-        Besides the features directly extracted in this function, it also calls:
-        - biosppy.signals.tools.signal_stats
-        - biosppy.stats.quartiles
-        - biosppy.stats.histogram
-        - biosppy.features.time.hjorth_features
-
-        """
+    Parameters
+    ----------
+    signal : array
+        Input signal.
+    sampling_rate : int, float, optional
+        Sampling Rate (Hz).
+    include_diff : bool, optional
+        Whether to include the features of the signal's differences (first, second and absolute).
+
+    Returns
+    -------
+    feats : ReturnTuple object
+        Time features of the signal.
+
+    Notes
+    -----
+    Besides the features directly extracted in this function, it also calls:
+    - biosppy.signals.tools.signal_stats
+    - biosppy.stats.quartiles
+    - biosppy.stats.histogram
+    - biosppy.features.time.hjorth_features
+
+    """
 
     # check inputs
     if signal is None:

biosppy/quality.py

@@ -24,24 +24,24 @@
 def quality_eda(x=None, methods=['bottcher'], sampling_rate=None, verbose=1):
     """Compute the quality index for one EDA segment.
 
-        Parameters
-        ----------
-        x : array
-            Input signal to test.
-        methods : list
-            Method to assess quality. One or more of the following: 'bottcher'.
-        sampling_rate : int
-            Sampling frequency (Hz).
-        verbose : int
-            If 1, a commentary is printed regarding the quality of the signal and details of the function. Default is 1.
-
-        Returns
-        -------
-        args : tuple
-            Tuple containing the quality index for each method.
-        names : tuple
-            Tuple containing the name of each method.
-        """
+    Parameters
+    ----------
+    x : array
+        Input signal to test.
+    methods : list
+        Method to assess quality. One or more of the following: 'bottcher'.
+    sampling_rate : int
+        Sampling frequency (Hz).
+    verbose : int
+        If 1, a commentary is printed regarding the quality of the signal and details of the function. Default is 1.
+
+    Returns
+    -------
+    args : tuple
+        Tuple containing the quality index for each method.
+    names : tuple
+        Tuple containing the name of each method.
+    """
     # check inputs
     if x is None:
         raise TypeError("Please specify the input signal.")
@@ -71,7 +71,6 @@ def quality_ecg(segment, methods=['Level3'], sampling_rate=None,
                 fisher=True, f_thr=0.01, threshold=0.9, bit=0, 
                 nseg=1024, num_spectrum=[5, 20], dem_spectrum=None, 
                 mode_fsqi='simple', verbose=1):
-
     """Compute the quality index for one ECG segment.
 
     Parameters
@@ -130,10 +129,8 @@ def quality_ecg(segment, methods=['Level3'], sampling_rate=None,
 
 
 def ecg_sqi_level3(segment, sampling_rate, threshold, bit):
-
     """Compute the quality index for one ECG segment. The segment should have 10 seconds.
 
-
     Parameters
     ----------
     segment : array
@@ -223,24 +220,27 @@ def eda_sqi_bottcher(x=None, sampling_rate=None, verbose=1):  # -> Timeline
 
 
 def cSQI(rpeaks=None, verbose=1):
-    """For the ECG signal
-    Calculate the Coefficient of Variation of RR Intervals (cSQI).
+    """For the ECG signal, calculate the Coefficient of Variation of RR Intervals (cSQI).
+
     Parameters
     ----------
     rpeaks : array-like
         Array containing R-peak locations. Should be filtered? How many seconds are adequate?
     verbose : int
         If 1, a commentary is printed regarding the quality of the signal and details of the function. Default is 1.
+
     Returns
     -------
     cSQI : float
         Coefficient of Variation of RR Intervals. cSQI - best near 0
+
     References
     ----------
     ..  [Zhao18] Zhao, Z., & Zhang, Y. (2018).
     SQI quality evaluation mechanism of single-lead ECG signal based on simple heuristic fusion and fuzzy comprehensive evaluation.
     Frontiers in Physiology, 9, 727.
     """
+
     if rpeaks is None:
         raise TypeError("Please specify the R-peak locations.")
 
@@ -269,6 +269,7 @@ def cSQI(rpeaks=None, verbose=1):
 def hosSQI(signal=None, quantitative=False, verbose=1):
     """For the ECG signal.
     Calculate the Higher-order-statistics-SQI (hosSQI).
+
     Parameters
     ----------
     signal : array-like

biosppy/signals/bvp.py

@@ -31,6 +31,7 @@
 def bvp(signal=None, sampling_rate=1000., path=None, show=True):
     """Process a raw BVP signal and extract relevant signal features using
     default parameters.
+
     Parameters
     ----------
     signal : array
@@ -41,6 +42,7 @@ def bvp(signal=None, sampling_rate=1000., path=None, show=True):
         If provided, the plot will be saved to the specified file.
     show : bool, optional
         If True, show a summary plot.
+
     Returns
     -------
     ts : array