Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] window size calculation for locreg detrending #734

Closed
wants to merge 6 commits into from
Closed

[Docs] window size calculation for locreg detrending #734

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d58acc9
window size calculation for locreg detrending
vasileermicioi Oct 18, 2022
0687958
Merge branch 'dev' into master
vasileermicioi Oct 18, 2022
9e8b8f6
Apply suggestions from code review
danibene Oct 19, 2022
c0b3826
Update neurokit2/signal/signal_detrend.py
vasileermicioi Oct 19, 2022
a53936d
Update studies/ecg_benchmark/make_data.py
vasileermicioi Oct 19, 2022
92058c0
Update studies/ecg_benchmark/make_data.py
vasileermicioi Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions neurokit2/signal/signal_detrend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ def signal_detrend(
Only used if ``method`` is "loess". The parameter which controls the degree of smoothing.
window : float
Only used if ``method`` is "locreg". The detrending ``window`` should correspond to the
desired low frequency band to remove (for instance, ``1.5`` will remove frequencies below
1.5Hz).
sample rate divided by the desired low frequency band to remove (window=sample_rate / frequency) .
For instance, to remove frequencies below 0.67Hz for a signal sampled at 1000Hz, a window
of the size round(1000 / 0.67) = ``1.5*1000`` should be used.
danibene marked this conversation as resolved.
Show resolved Hide resolved
vasileermicioi marked this conversation as resolved.
Show resolved Hide resolved
vasileermicioi marked this conversation as resolved.
Show resolved Hide resolved
stepsize : float
Only used if ``method`` is ``"locreg"``.
components : list
Expand Down
Loading