Filters data placed in the delay line.
Syntax
IppStatus ippsFIRLMSMROne32s_16s(Ipp32s* pDstVal, IppsFIRLMSMRState32s_16s* pState);
IppStatus ippsFIRLMSMROne32sc_16sc(Ipp32sc* pDstVal, IppsFIRLMSMRState32sc_16sc* pState);
Parameters
pState |
Pointer to the filter state structure. |
pDstVal |
Pointer to the output signal value. |
Description
The function FIRLSMMROne is declared in the ipps.h file. This function filters the samples placed in the delay line using the filter coefficients stored in the filter state structure pState. The resulting value is placed in the pDstVal. The downsampling factor dlyStep defines the number of samples that are filtered. The filter coefficients are not updated.
The filtering procedure can be described as a FIR filter operation (here the input sample to be filtered is denoted x(n), the taps are denoted h(i), and the return value is y(n)):
Note that the function operates with values stored in the delay line that are copies of the input samples. Before calling the function ippsFIRLMSMROne, initialize the filter state by calling the function ippsFIRLMSMRInitAlloc.
Return Values
ippStsNoErr |
Indicates no error. |
ippStsNullPtrErr |
Indicates an error when one of the specified pointers is NULL. |
ippStsContextMatchErr |
Indicates an error when the state identifier is incorrect. |