FIRGetDlyLine

Retrieves the delay line contents from the FIR filter state structure.

Syntax

IppStatus ippsFIRGetDlyLine_16s(const IppsFIRState_16s* pState, Ipp16s* pDlyLine);

IppStatus ippsFIRGetDlyLine_32f(const IppsFIRState_32f* pState, Ipp32f* pDlyLine);

IppStatus ippsFIRGetDlyLine_64f(const IppsFIRState_64f* pState, Ipp64f* pDlyLine);

IppStatus ippsFIRGetDlyLine32s_16s(const IppsFIRState32s_16s* pState, Ipp16s* pDlyLine);

IppStatus ippsFIRGetDlyLine32f_16s(const IppsFIRState32f_16s* pState, Ipp16s* pDlyLine);

IppStatus ippsFIRGetDlyLine64f_16s(const IppsFIRState64f_16s* pState, Ipp16s* pDlyLine);

IppStatus ippsFIRGetDlyLine64f_32s(const IppsFIRState64f_32s* pState, Ipp32s* pDlyLine);

IppStatus ippsFIRGetDlyLine64f_32f(const IppsFIRState64f_32f* pState, Ipp32f* pDlyLine);

IppStatus ippsFIRGetDlyLine_32fc(const IppsFIRState_32fc* pState, Ipp32fc* pDlyLine);

IppStatus ippsFIRGetDlyLine_64fc(const IppsFIRState_64fc* pState, Ipp64fc* pDlyLine);

IppStatus ippsFIRGetDlyLine32sc_16sc(const IppsFIRState32sc_16sc* pState, Ipp16sc* pDlyLine);

IppStatus ippsFIRGetDlyLine32fc_16sc(const IppsFIRState32fc_16sc* pState, Ipp16sc* pDlyLine);

IppStatus ippsFIRGetDlyLine64fc_16sc(const IppsFIRState64fc_16sc* pState, Ipp16sc* pDlyLine);

IppStatus ippsFIRGetDlyLine64fc_32sc(const IppsFIRState64fc_32sc* pState, Ipp32sc* pDlyLine);

IppStatus ippsFIRGetDlyLine64fc_32fc(const IppsFIRState64fc_32fc* pState, Ipp32fc* pDlyLine);

Parameters

pState	Pointer to the FIR filter state structure.
pDlyLine	Pointer to the array holding the delay line values.

Description

The function ippsFIRGetDlyLine is declared in the ipps.h file. This function copies the delay line values from the state structure pState and stores them into pDlyLine. The destination array pDlyLinecontains samples in the reverse order as compared to the order of samples in the source vector.

Before calling ippsFIRGetDlyLine, the corresponding filter state structure must be initialized, for example by calling the functions ippsFIRInitAlloc or ippsFIRMRInitAlloc.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when the pState pointer is NULL.
ippStsContextMatchErr	Indicates an error when the state identifier is incorrect.