fers_signal::IirFilter Class Reference

Implements an Infinite Impulse Response (IIR) filter. More...

#include "dsp_filters.h"

Inheritance diagram for fers_signal::IirFilter:

Collaboration diagram for fers_signal::IirFilter:

Public Member Functions
	IirFilter (const RealType *denCoeffs, const RealType *numCoeffs, unsigned order) noexcept
	Constructs an IIR filter with given numerator and denominator coefficients and order.
	~IirFilter () override=default
RealType	filter (RealType sample) noexcept override
	Filters a single sample.
void	filter (std::span< RealType > samples) noexcept override
	Filters a block of samples.

Detailed Description

Implements an Infinite Impulse Response (IIR) filter.

Definition at line 80 of file dsp_filters.h.

Constructor & Destructor Documentation

IirFilter()

fers_signal::IirFilter::IirFilter ( const RealType *  denCoeffs, const RealType *  numCoeffs, unsigned  order  )

noexcept

Constructs an IIR filter with given numerator and denominator coefficients and order.

Parameters

denCoeffs	Pointer to the denominator coefficients array.
numCoeffs	Pointer to the numerator coefficients array.
order	The order of the filter.

Definition at line 122 of file dsp_filters.cpp.

                                                                                                            :
        _a(denCoeffs, denCoeffs + order), _b(numCoeffs, numCoeffs + order), _w(order, 0.0), _order(order)
    {
    }

~IirFilter()

fers_signal::IirFilter::~IirFilter ( )

overridedefault

Member Function Documentation

filter() [1/2]

RealType fers_signal::IirFilter::filter ( RealType  sample )

overridevirtualnoexcept

Filters a single sample.

Parameters

sample

The sample to be filtered.

Returns

The filtered sample.

Implements fers_signal::DspFilter.

Definition at line 127 of file dsp_filters.cpp.

    {
        std::ranges::rotate(_w, _w.end() - 1);
 
        _w[0] = sample;
 
        for (unsigned j = 1; j < _order; ++j)
        {
            _w[0] -= _a[j] * _w[j];
        }
 
        return std::inner_product(_b.begin(), _b.end(), _w.begin(), 0.0);
    }

filter() [2/2]

void fers_signal::IirFilter::filter ( std::span< RealType >  samples )

overridevirtualnoexcept

Filters a block of samples.

Parameters

samples

Span of samples to be filtered.

Implements fers_signal::DspFilter.

Definition at line 141 of file dsp_filters.cpp.

    {
        for (auto& sample : samples)
        {
            std::ranges::rotate(_w, _w.end() - 1);
 
            _w[0] = sample;
 
            for (unsigned j = 1; j < _order; ++j)
            {
                _w[0] -= _a[j] * _w[j];
            }
 
            sample = std::inner_product(_b.begin(), _b.end(), _w.begin(), 0.0);
        }
    }

---

The documentation for this class was generated from the following files:

• packages/libfers/src/signal/dsp_filters.h
• packages/libfers/src/signal/dsp_filters.cpp