#include <Butterworth.h>
|
void | setup (double sampleRate, double centerFrequency, double widthFrequency, double gainDb) |
|
void | setup (int reqOrder, double sampleRate, double centerFrequency, double widthFrequency, double gainDb) |
|
void | setupN (double centerFrequency, double widthFrequency, double gainDb) |
|
void | setupN (int reqOrder, double centerFrequency, double widthFrequency, double gainDb) |
|
void | reset () |
|
void | setup (const double(&sosCoefficients)[MaxStages][6]) |
|
Sample | filter (const Sample in) |
|
const Cascade::Storage | getCascadeStorage () |
|
template<int FilterOrder = 4, class StateType = DirectFormII>
struct Iir::Butterworth::BandShelf< FilterOrder, StateType >
Butterworth Bandshelf filter: it is a bandpass filter which amplifies at a specified gain in dB the frequencies in the passband.
- Parameters
-
FilterOrder | Reserves memory for a filter of the order FilterOrder |
StateType | The filter topology: DirectFormI, DirectFormII, ... |
◆ setup() [1/2]
template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::BandShelf< FilterOrder, StateType >::setup |
( |
double |
sampleRate, |
|
|
double |
centerFrequency, |
|
|
double |
widthFrequency, |
|
|
double |
gainDb |
|
) |
| |
|
inline |
Calculates the coefficients with the filter order provided by the instantiation
- Parameters
-
sampleRate | Sampling rate |
centerFrequency | Centre frequency of the passband |
widthFrequency | Width of the passband |
gainDb | The gain in the passband |
◆ setup() [2/2]
template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::BandShelf< FilterOrder, StateType >::setup |
( |
int |
reqOrder, |
|
|
double |
sampleRate, |
|
|
double |
centerFrequency, |
|
|
double |
widthFrequency, |
|
|
double |
gainDb |
|
) |
| |
|
inline |
Calculates the coefficients
- Parameters
-
reqOrder | The actual order which can be less than the instantiated one |
sampleRate | Sampling rate |
centerFrequency | Centre frequency of the passband |
widthFrequency | Width of the passband |
gainDb | The gain in the passband |
◆ setupN() [1/2]
template<int FilterOrder = 4, class StateType = DirectFormII>
Calculates the coefficients with the filter order provided by the instantiation
- Parameters
-
centerFrequency | Normalised centre frequency (0..1/2) of the passband |
widthFrequency | Width of the passband |
gainDb | The gain in the passband |
◆ setupN() [2/2]
template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::BandShelf< FilterOrder, StateType >::setupN |
( |
int |
reqOrder, |
|
|
double |
centerFrequency, |
|
|
double |
widthFrequency, |
|
|
double |
gainDb |
|
) |
| |
|
inline |
Calculates the coefficients
- Parameters
-
reqOrder | The actual order which can be less than the instantiated one |
centerFrequency | Normalised centre frequency (0..1/2) of the passband |
widthFrequency | Width of the passband |
gainDb | The gain in the passband |
The documentation for this struct was generated from the following file: