Basic Audio Signal Processing Library

Dependents:   unzen_sample_nucleo_f746 skeleton_unzen_nucleo_f746 ifmag_noise_canceller synthesizer_f746

Embed: (wiki syntax)

« Back to documentation index

FIRDecimator Class Reference

FIRDecimator Class Reference

Wrapper class of the arm_fir_decimate_f32() and the arm_fir_decimate_init_f32(). More...

#include <firdecimator.h>

Inherits amakusa::AbstractFilter.

Public Member Functions

 FIRDecimator (uint16_t taps, float32_t *pCoeff, uint32_t block_size, uint8_t m)
 Constructor.
virtual ~FIRDecimator ()
 Destructor.
virtual void run (float32_t *pSrc, float32_t *pDst)
 Run the filter.

Detailed Description

Wrapper class of the arm_fir_decimate_f32() and the arm_fir_decimate_init_f32().

To use this class, include amakusa.h

Definition at line 12 of file firdecimator.h.


Constructor & Destructor Documentation

FIRDecimator ( uint16_t  taps,
float32_t *  pCoeff,
uint32_t  block_size,
uint8_t  m 
)

Constructor.

Parameters:
[in]tapsNumber of the elements in the coeffisients array. Or length of the impuls response.
[in]pCoeffPonter to the coefficients array ( Impuls response ).
[in]blockSizeMaximum number of the input samples to be given to run() method at onece. Must be integer multiple of parameter M.
[in]MDown sampling ratio

Definition at line 3 of file firdecimator.cpp.

~FIRDecimator (  ) [virtual]

Destructor.

Definition at line 15 of file firdecimator.cpp.


Member Function Documentation

void run ( float32_t *  pSrc,
float32_t *  pDst 
) [virtual]

Run the filter.

Parameters:
[in]pSrcPointer to the source buffer to be filtered.
[out]pDstPointer to the destination buffer to store the filtered signal.

Definition at line 19 of file firdecimator.cpp.