FIRGetTaps

Retrieves the tap values from the FIR filter state structure.

Syntax

IppStatus ippsFIRGetTaps_16s(const IppsFIRState_16s* pState, Ipp16s* pTaps, int tapsFactor);

IppStatus ippsFIRGetTaps_32s(const IppsFIRState_32s* pState, Ipp32f* pTaps);

IppStatus ippsFIRGetTaps_32f(const IppsFIRState_32f* pState, Ipp32f* pTaps);

IppStatus ippsFIRGetTaps_64f(const IppsFIRState_64f* pState, Ipp64f* pTaps);

IppStatus ippsFIRGetTaps32f_16s(const IppsFIRState32f_16s* pState, Ipp32f* pTaps);

IppStatus ippsFIRGetTaps64f_16s(const IppsFIRState64f_16s* pState, Ipp64f* pTaps);

IppStatus ippsFIRGetTaps64f_32s(const IppsFIRState64f_32s* pState, Ipp64f* pTaps);

IppStatus ippsFIRGetTaps64f_32f(const IppsFIRState64f_32f* pState, Ipp64f* pTaps);

IppStatus ippsFIRGetTaps_32fc(const IppsFIRState_32fc* pState, Ipp32fc* pTaps);

IppStatus ippsFIRGetTaps_64fc(const IppsFIRState_64fc* pState, Ipp64fc* pTaps);

IppStatus ippsFIRGetTaps32fc_16sc(const IppsFIRState32fc_16sc* pState, Ipp32fc* pTaps);

IppStatus ippsFIRGetTaps64fc_16sc(const IppsFIRState64fc_16sc* pState, Ipp64fc* pTaps);

IppStatus ippsFIRGetTaps64fc_32sc(const IppsFIRState64fc_32sc* pState, Ipp64fc* pTaps);

IppStatus ippsFIRGetTaps64fc_32fc(const IppsFIRState64fc_32fc* pState, Ipp64fc* pTaps);

IppStatus ippsFIRGetTaps32s_16s32f(const IppsFIRState32s_16s* pState, Ipp32f* pTaps);

IppStatus ippsFIRGetTaps32sc_16sc32fc(const IppsFIRState32sc_16sc* pState, Ipp32fc* pTaps);

IppStatus ippsFIRGetTaps32s_16s(const IppsFIRState32s_16s* pState, Ipp32s* pTaps, int* pTapsFactor);

IppStatus ippsFIRGetTaps32sc_16sc(const IppsFIRState32sc_16sc* pState, Ipp32sc* pTaps, int* pTapsFactor);

Parameters

pState	Pointer to the FIR filter state structure.
pTaps	Pointer to the array containing the tap values.
pTapsFactor	Pointer to the scale factor for the taps.

Description

The function ippsFIRGetTaps is declared in the ipps.h file. This function copies the tap values from the initialized FIR state structure pState to the tapsLen-length array pTaps. To scale integer taps, use the pTapsFactor value.

Before calling ippsFIRGetTaps function, 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 one of the specified pointers is NULL.
ippStsContextMatchErr	Indicates an error when the state identifier is incorrect.