iir1
Public Member Functions | List of all members
Iir::Butterworth::BandStop< FilterOrder, StateType > Struct Template Reference

#include <Butterworth.h>

Inheritance diagram for Iir::Butterworth::BandStop< FilterOrder, StateType >:
Iir::PoleFilter< BandStopBase, DirectFormII, 4, 4 *2 > Iir::CascadeStages<(MaxDigitalPoles+1)/2, DirectFormII >

Public Member Functions

void setup (double sampleRate, double centerFrequency, double widthFrequency)
 
void setupN (int reqOrder, double sampleRate, double centerFrequency, double widthFrequency)
 
void setupN (double centerFrequency, double widthFrequency)
 
void setupN (int reqOrder, double centerFrequency, double widthFrequency)
 
- Public Member Functions inherited from Iir::CascadeStages<(MaxDigitalPoles+1)/2, DirectFormII >
void reset ()
 
void setup (const double(&sosCoefficients)[MaxStages][6])
 
Sample filter (const Sample in)
 
const Cascade::Storage getCascadeStorage ()
 

Detailed Description

template<int FilterOrder = 4, class StateType = DirectFormII>
struct Iir::Butterworth::BandStop< FilterOrder, StateType >

Butterworth Bandstop filter.

Parameters
FilterOrderReserves memory for a filter of the order FilterOrder
StateTypeThe filter topology: DirectFormI, DirectFormII, ...

Member Function Documentation

◆ setup()

template<int FilterOrder = 4, class StateType = DirectFormII>
void Iir::Butterworth::BandStop< FilterOrder, StateType >::setup ( double  sampleRate,
double  centerFrequency,
double  widthFrequency 
)
inline

Calculates the coefficients with the filter order provided by the instantiation

Parameters
sampleRateSampling rate
centerFrequencyCentre frequency of the bandstop
widthFrequencyWidth of the bandstop

◆ setupN() [1/3]

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

Calculates the coefficients with the filter order provided by the instantiation

Parameters
centerFrequencyNormalised centre frequency (0..1/2) of the bandstop
widthFrequencyNormalised width of the bandstop

◆ setupN() [2/3]

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

Calculates the coefficients

Parameters
reqOrderThe actual order which can be less than the instantiated one
centerFrequencyNormalised centre frequency (0..1/2) of the bandstop
widthFrequencyNormalised width of the bandstop

◆ setupN() [3/3]

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

Calculates the coefficients

Parameters
reqOrderThe actual order which can be less than the instantiated one
sampleRateSampling rate
centerFrequencyCentre frequency of the bandstop
widthFrequencyWidth of the bandstop

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