fers_signal::FirFilter Class Reference

Implements a Finite Impulse Response (FIR) filter. More...

#include "dsp_filters.h"

Inheritance diagram for fers_signal::FirFilter:

Collaboration diagram for fers_signal::FirFilter:

Public Member Functions
	FirFilter (std::span< const RealType > coeffs)
	Constructs an FIR filter with the given coefficients.
	~FirFilter () override=default
RealType	filter (RealType) override
	Filters a single sample.
void	filter (std::span< RealType >) noexcept override
	Filters a block of samples.
void	filter (std::vector< ComplexType > &samples) const
	Filters a block of complex samples.

Detailed Description

Implements a Finite Impulse Response (FIR) filter.

Definition at line 121 of file dsp_filters.h.

Constructor & Destructor Documentation

FirFilter()

fers_signal::FirFilter::FirFilter ( std::span< const RealType >  coeffs )

explicit

Constructs an FIR filter with the given coefficients.

Parameters

coeffs

Span of filter coefficients.

Definition at line 129 of file dsp_filters.h.

                                                           :
            _filter(coeffs.begin(), coeffs.end()), _w(coeffs.size()), _order(coeffs.size())
        {
        }

~FirFilter()

fers_signal::FirFilter::~FirFilter ( )

overridedefault

Member Function Documentation

filter() [1/3]

RealType fers_signal::FirFilter::filter ( RealType  sample )

overridevirtual

Filters a single sample.

Parameters

sample

A single real-valued sample to be filtered.

Returns

The filtered sample.

Implements fers_signal::DspFilter.

Definition at line 136 of file dsp_filters.h.

{ return 0; }

Referenced by fers_signal::downsample(), and fers_signal::upsample().

Here is the caller graph for this function:

filter() [2/3]

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

overridevirtualnoexcept

Filters a block of samples.

Parameters

samples

Span of real-valued samples to be filtered.

Implements fers_signal::DspFilter.

Definition at line 138 of file dsp_filters.h.

{}

filter() [3/3]

void fers_signal::FirFilter::filter

(

std::vector< ComplexType > &

samples

)

const

Filters a block of complex samples.

Parameters

samples

Span of complex samples to be filtered.

Definition at line 159 of file dsp_filters.cpp.

    {
        std::vector line(_order, ComplexType{0.0, 0.0});
 
        for (auto& sample : samples)
        {
            line[0] = sample;
            ComplexType result{0.0, 0.0};
 
            result = std::transform_reduce(line.begin(), line.end(), _filter.begin(), ComplexType{0.0, 0.0},
                                           std::plus<ComplexType>{},
                                           [](const ComplexType& x, const RealType coeff) { return x * coeff; });
 
            sample = result;
 
            std::ranges::rotate(std::views::reverse(line), line.rbegin() + 1);
        }
    }

---

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