IIROne

Filters a single sample through an IIR filter.

Syntax

IppStatus ippsIIROne_32f(Ipp32f src, Ipp32f* pDstVal, IppsIIRState_32f* pState);

IppStatus ippsIIROne_64f(Ipp64f src, Ipp64f* pDstVal, IppsIIRState_64f* pState);

IppStatus ippsIIROne64f_32f(Ipp32f src, Ipp32f* pDstVal, IppsIIRState64f_32f* pState);

IppStatus ippsIIROne_32fc(Ipp32fc src, Ipp32fc* pDstVal, IppsIIRState_32fc* pState);

IppStatus ippsIIROne_64fc(Ipp64fc src, Ipp64fc* pDstVal, IppsIIRState_64fc* pState);

IppStatus ippsIIROne64fc_32fc(Ipp32fc src, Ipp32fc* pDstVal, IppsIIRState64fc_32fc* pState);

IppStatus ippsIIROne32s_16s_Sfs(Ipp16s src, Ipp16s* pDstVal, IppsIIRState32s_16s* pState, int scaleFactor);

IppStatus ippsIIROne32f_16s_Sfs(Ipp16s src, Ipp16s* pDstVal, IppsIIRState32f_16s* pState, int scaleFactor);

IppStatus ippsIIROne64f_16s_Sfs(Ipp16s src, Ipp16s* pDstVal, IppsIIRState64f_16s* pState, int scaleFactor);

IppStatus ippsIIROne64f_32s_Sfs(Ipp32s src, Ipp32s* pDstVal, IppsIIRState64f_32s* pState, int scaleFactor);

IppStatus ippsIIROne32sc_16sc_Sfs(Ipp16sc src, Ipp16sc* pDstVal, IppsIIRState32sc_16sc* pState, int scaleFactor);

IppStatus ippsIIROne32fc_16sc_Sfs(Ipp16sc src, Ipp16sc* pDstVal, IppsIIRState32fc_16sc* pState, int scaleFactor);

IppStatus ippsIIROne64fc_16sc_Sfs(Ipp16sc src, Ipp16sc* pDstVal, IppsIIRState64fc_16sc* pState, int scaleFactor);

IppStatus ippsIIROne64fc_32sc_Sfs(Ipp32sc src, Ipp32sc* pDstVal, IppsIIRState64fc_32sc* pState, int scaleFactor);

Parameters

pState	Pointer to the IIR filter state structure.
src	Input sample.
pDstVal	Pointer to the output filtered sample.
scaleFactor	Scale factor, refer to Integer Scaling.

Description

The function ippsIIROne is declared in the ipps.h file. This function filters a single sample src through an IIR filter with real taps, and stores the result in pDstVal. The filter parameters are specified in pState. The output of the integer sample is scaled according to scaleFactor and can be saturated.

Do not modify the scaleFactor value unless the state structure is changed.

The filter state must be initialized before calling the function ippsFIROne function. Specify the number of taps tapsLen, the tap values in pTaps, the delay line values in pDlyLine, and the order or numBq value beforehand.

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.