Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/billwilliams1952/arduino-cascadable-low-pass-filter
Cascadable Low Pass Filter
https://github.com/billwilliams1952/arduino-cascadable-low-pass-filter
arduino arduino-library arduino-platform c c-plus-plus cascade-lpf filter lowpass-filter lpf sampling-theory
Last synced: about 1 month ago
JSON representation
Cascadable Low Pass Filter
- Host: GitHub
- URL: https://github.com/billwilliams1952/arduino-cascadable-low-pass-filter
- Owner: Billwilliams1952
- Created: 2016-12-02T23:06:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-13T00:35:53.000Z (over 5 years ago)
- Last Synced: 2023-10-25T15:45:50.151Z (about 1 year ago)
- Topics: arduino, arduino-library, arduino-platform, c, c-plus-plus, cascade-lpf, filter, lowpass-filter, lpf, sampling-theory
- Language: C++
- Homepage:
- Size: 26.4 KB
- Stars: 14
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Low-Pass-Filter
Simple low pass filter (LPF) based on sampling theory.
This library allows the user to specify the filter bandwidth in hertz (Hz) of the LPF. The LPF will then calculate the response based on the sample time between calls. Multiple LPFs may be cascaded together using the optional *cascades* parameter, increasing the rolloff at the output.
If sample time is not an issue, then the LPF can be created using a simple alpha value which ranges from 0.0 to 1.0. A value of 1.0 is no filtering (follow the input), 0.0 is max filtering (the output stays at the initial value).
## Synopsis
Return RC low-pass filter output samples, given input samples, time interval dt, and time constant RC. From sampling theory:
RC = 1 / (2 * π * BW)
α = dt / (RC + dt)
y[0] := x[0]
for i from 1 to n
y[i] = α * x[i] + (1-α) * y[i-1]
Refactoring
for i from 1 to n
y[i] = y[i-1] + α * (x[i] - y[i-1])
Rewriting
NextValue = LastValue + α * (CurrentValue - LastValue)
LastValue = NextValue
For a single LPF, the new output will approach the input in ~ 5 RCTime constants.
For example: With a specified bandwidth of 10 Hz, and a step input applied, the output will settle to the step input value in ~0.08 seconds. 10 Hz is the 3dB point of the filter, where input changes at a rate greater than this frequency begins to roll off at 20 dB per decade (10 Hz, 100Hz, 1000Hz,...) or 6dB per octave (10Hz, 20Hz, 40Hz, 80Hz...)
Thanks https://en.wikipedia.org/wiki/Roll-off
When you cascade the LPF, the rolloff basically doubles for each added stage. Using the previous example, a two cascade LPF will be 6dB down at 10Hz, and 40 dB down at 100 Hz -- a three cascade LPF will be 9dB down at 10Hz, and 60 dB down at 100 Hz.
## API
```C++
// Specify a LPF based off bandWidth, or as fixed alpha.
LPF ( double bandWidthInHzOrAlpha, bool isInBandwidth, uint8_t cascades = 1 );
// Reset filter output to initialValue
void Reset ( float initialValue = 0.0 );
// Return last value from the filter.
float GetLastValue ( void );
// Get next value from the filter based on the input (current) value
float NextValue ( float currentValue );
// Return the gain of the filter at the requested frequency using the formula
```
```C++
double GetFilterGainInDB ( double frequencyInHz );
// Return the required signal frequency that develops the requested output gain using the formula
```
```C++
double GetFrequencyForGain ( double gainInDB );
```
## Tests
The example sketch uses the Serial Plotter functionality to display two examples. The first example plots the response of a single LPF and a three cascade LPF to a pulse input. This demonstrates the impulse response (risetime/falltime) of the LPF based on the *bandWidthInHzOrAlpha* parameter. Note that risetime or falltime is ~ 0.35 / *bandWidthInHzOrAlpha* for a single cascade LPF.
The second example plots the response of a single LPF and a three cascade LPF to an input containing multiple sine wave signals and 'noise'. The actual test suite now resets the three cascade LPF output to 1.0 every five seconds as a demonstration of the **Reset** function.
## License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.