Skip to content

removed line for calc_fft as optional argument #97

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

removed line for calc_fft as optional argument #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c449b93
removed line for calc_fft as optional argument
Jul 2, 2022
5cbd461
added filter_signal for Butterworth filter code block
Jul 2, 2022
745d7e1
changed code example for butterworth filter to use filter_signal inst…
Jul 2, 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
2 changes: 1 addition & 1 deletion docs/algorithmfunctioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ A Butterworth filter implementation is available to remove high frequency noise.

import heartpy as hp

filtered = hp.butter_lowpass_filter(data, cutoff=5, sample_rate=100.0, order=3)
filtered = hp.filter_signal(data, cutoff=5, sample_rate=100.0, order=3, filtertype='lowpass')

.. image:: images/butterworth.jpeg

Expand Down
1 change: 0 additions & 1 deletion docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ Several optional arguments are available:

* **windowsize:** _optional_ `windowsize` is the window size used for the calculation of the moving average. The windowsize is defined as `windowsize * samplerate`. Default windowsize=0.75.
* **report_time:** _optional_ whether to report total processing time of process() loop.
* **calc_fft:** _optional_ whether to calculate frequency domain measures. Default = false Note: can cause slowdowns in some cases.
* **calc_freq:** _optional_ whether to calculate frequency domain measures. Default = false Note: can cause slowdowns in some cases.
* **freq_method:** _optional_ method used to extract the frequency spectrum. Available: 'fft' (Fourier Analysis), 'periodogram', and 'welch' (Welch's method), Default = 'welch'
* **interp_clipping:** if True, clipping parts of the signal are identified and the implied peak shape is interpolated. Default=False
Expand Down