Finite Impulse Response Filter (firfilt)

Finite impulse response (FIR) filters are implemented in liquid with the firfilt family of objects.

Interface

Listed below is the full interface to the firfilt family of objects.

create()

Create a finite impulse response filter (firfilt) object by directly specifying the filter coefficients in an array.

firfilt_rrrf firfilt_rrrf_create(float * _h, unsigned int _n);

  • float * _h: filter coefficients, shape: (_n, 1)

  • unsigned int _n: number of coefficients, \(0 < n\)

  • returns new firfilt_rrrf object

firfilt_crcf firfilt_crcf_create(float * _h, unsigned int _n);

  • float * _h: filter coefficients, shape: (_n, 1)

  • unsigned int _n: number of coefficients, \(0 < n\)

  • returns new firfilt_crcf object

firfilt_cccf firfilt_cccf_create(float complex * _h, unsigned int _n);

  • float complex * _h: filter coefficients, shape: (_n, 1)

  • unsigned int _n: number of coefficients, \(0 < n\)

  • returns new firfilt_cccf object

destroy()

Destroys a firfilt object, freeing all internally-allocated memory.

int firfilt_rrrf_destroy(firfilt_rrrf _q);

  • firfilt_rrrf _q: filter object

  • returns common error code

int firfilt_crcf_destroy(firfilt_crcf _q);

  • firfilt_crcf _q: filter object

  • returns common error code

int firfilt_cccf_destroy(firfilt_cccf _q);

  • firfilt_cccf _q: filter object

  • returns common error code