iir1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Iir::Butterworth::BandShelf< FilterOrder, StateType > Struct Template Reference

#include <Butterworth.h>

Inheritance diagram for Iir::Butterworth::BandShelf< FilterOrder, StateType >:
Iir::PoleFilter< BaseClass, StateType, MaxAnalogPoles, MaxDigitalPoles > Iir::CascadeStages< MaxStages, StateType >

Public Member Functions

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)
 
- Public Member Functions inherited from Iir::CascadeStages< MaxStages, StateType >
void reset ()
 
void setup (const double(&sosCoefficients)[MaxStages][6])
 
template<typename Sample >
Sample filter (const Sample in)
 
const Cascade::Storage getCascadeStorage ()
 

Detailed Description

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
FilterOrderReserves memory for a filter of the order FilterOrder
StateTypeThe filter topology: DirectFormI, DirectFormII, ...

Member Function Documentation

◆ 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
sampleRateSampling rate
centerFrequencyCentre frequency of the passband
widthFrequencyWidth of the passband
gainDbThe 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
reqOrderThe actual order which can be less than the instantiated one
sampleRateSampling rate
centerFrequencyCentre frequency of the passband
widthFrequencyWidth of the passband
gainDbThe gain in the passband

◆ setupN() [1/2]

template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::BandShelf< FilterOrder, StateType >::setupN ( double centerFrequency,
double widthFrequency,
double gainDb )
inline

Calculates the coefficients with the filter order provided by the instantiation

Parameters
centerFrequencyNormalised centre frequency (0..1/2) of the passband
widthFrequencyWidth of the passband
gainDbThe 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
reqOrderThe actual order which can be less than the instantiated one
centerFrequencyNormalised centre frequency (0..1/2) of the passband
widthFrequencyWidth of the passband
gainDbThe gain in the passband

The documentation for this struct was generated from the following file: