FirLMS Class Reference

#include <FirLMS.h>

Inheritance diagram for FirLMS:

Collaboration diagram for FirLMS:

Public Member Functions
	FirLMS (int nrTaps, double lrate)
double	Filter (double dirtySample, double noiseSample) override
void	RegisterRemoverCallback (SampleCallback *_removerCallBack)
Public Member Functions inherited from NoiseFilter
void	RunFilter ()
std::thread *	Start ()
void	Stop ()
void	NextSignalSample (double sample)
void	NextNoiseSample (double noise)
void	SetOn (bool state)
bool	GetOn ()
Public Member Functions inherited from SampleLink
void	RegisterCallback (SampleCallback *scb)
void	NextSample (double next)

Additional Inherited Members
Protected Attributes inherited from NoiseFilter
BlockingQueue< double >	signalSamples
BlockingQueue< double >	noiseSamples
std::thread	worker
bool	isOn = true
Protected Attributes inherited from SampleLink
SampleCallback *	sampleCallback = nullptr

Constructor & Destructor Documentation

FirLMS()

FirLMS::FirLMS	(	int	nrTaps,
		double	lrate
	)

Initialise the LMS FIR Filter, requires nrTaps and learning rate

Parameters

nrTaps
lrate

Member Function Documentation

Filter()

double FirLMS::Filter ( double  dirtySample, double  noiseSample  )

overridevirtual

Takes a dirty signal sample and a noise sample, returns filtered sample

Parameters

dirtySample
noiseSample

Returns

Implements NoiseFilter.

RegisterRemoverCallback()

void FirLMS::RegisterRemoverCallback

(

SampleCallback *

_removerCallBack

)

---

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

• src/FirLMS.h
• src/FirLMS.cpp