Class Fir

ClassList > Fir

a class to implement the Finite Impulse Response filter behaviour More...

• #include <fir.h>

Public Functions

Type	Name
	Fir ()
	Fir (const uint8_t nc, const float32_t * coeffs)
uint8_t	init (uint8_t nc, const float32_t * coeffs) method to initialize the Fir with its coefficients
void	reset ()
void	setCoeff (uint8_t n, float32_t value)
float32_t	update (float32_t new_data)
	~Fir ()

Detailed Description

Date:

2024

Author:

Régis Ruelland [email protected]

Parameters:

• nc number of coefficients
• *coeffs pointer to array of coefficients

Public Functions Documentation

function Fir [1/2]

Fir::Fir () 

---

function Fir [2/2]

Fir::Fir (
    const uint8_t nc,
    const float32_t * coeffs
) 

---

function init

method to initialize the Fir with its coefficients

uint8_t Fir::init (
    uint8_t nc,
    const float32_t * coeffs
) 

Parameters:

• nc number of coefficients
• coeffs pointer to array of coefficients

Returns:

---

function reset

void Fir::reset () 

---

function setCoeff

void Fir::setCoeff (
    uint8_t n,
    float32_t value
) 

---

function update

float32_t Fir::update (
    float32_t new_data
) 

---

function ~Fir

Fir::~Fir () 

---

---

The documentation for this class was generated from the following file docs/controlLibrary/src/fir.h