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

#include <Butterworth.h>

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

Public Member Functions

void setup (double sampleRate, double cutoffFrequency, double gainDb)
 
void setup (int reqOrder, double sampleRate, double cutoffFrequency, double gainDb)
 
void setupN (double cutoffFrequency, double gainDb)
 
void setupN (int reqOrder, double cutoffFrequency, 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::LowShelf< FilterOrder, StateType >

Butterworth low shelf filter: below the cutoff it has a specified gain and above the cutoff the gain is 0 dB.

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::LowShelf< FilterOrder, StateType >::setup ( double sampleRate,
double cutoffFrequency,
double gainDb )
inline

Calculates the coefficients with the filter order provided by the instantiation

Parameters
sampleRateSampling rate
cutoffFrequencyCutoff
gainDbGain in dB of the filter in the passband

◆ setup() [2/2]

template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::LowShelf< FilterOrder, StateType >::setup ( int reqOrder,
double sampleRate,
double cutoffFrequency,
double gainDb )
inline

Calculates the coefficients

Parameters
reqOrderThe actual order which can be less than the instantiated one
sampleRateSampling rate
cutoffFrequencyCutoff
gainDbGain in dB of the filter in the passband

◆ setupN() [1/2]

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

Calculates the coefficients with the filter order provided by the instantiation

Parameters
cutoffFrequencyNormalised cutoff frequency (0..1/2)
gainDbGain in dB of the filter in the passband

◆ setupN() [2/2]

template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::LowShelf< FilterOrder, StateType >::setupN ( int reqOrder,
double cutoffFrequency,
double gainDb )
inline

Calculates the coefficients

Parameters
reqOrderThe actual order which can be less than the instantiated one
cutoffFrequencyNormalised cutoff frequency (0..1/2)
gainDbGain in dB of the filter in the passband

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