Skip to content

Commit

Permalink
Clarify method options and their differences
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasEmrich committed Nov 27, 2024
1 parent e250b53 commit 271ba01
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions neurokit2/ecg/ecg_delineate.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,12 @@ def ecg_delineate(
sampling_rate : int
The sampling frequency of ``ecg_signal`` (in Hz, i.e., samples/second). Defaults to 1000.
method : str
Can be one of ``"peak"`` for a peak-based method, ``"prominence"`` for a peak-prominence-based
method (Emrich et al., 2024), ...
``"cwt"`` for continuous wavelet transform or ``"dwt"`` (default) for discrete wavelet transform.
Can be one of ``"peak"`` for a peak-based method, ``"prominence"`` for a peak-prominence-based
method (Emrich et al., 2024), ``"cwt"`` for continuous wavelet transform or ``"dwt"`` (default)
for discrete wavelet transform.
The ``"prominence"`` method might be useful to detect the waves, allowing to set individual physiological
limits (see kwargs), while the ``"dwt"`` method might be more precise for detecting the onsets and offsets
of the waves (but might exhibit lower accuracy when there is significant variation in wave morphology).
show : bool
If ``True``, will return a plot to visualizing the delineated waves information.
show_type: str
Expand Down

0 comments on commit 271ba01

Please sign in to comment.