FIRLMSGetTaps

Retrieves the tap values from the FIR LMS filter.

Syntax

IppStatus ippsFIRLMSGetTaps_32f(const IppsFIRLMSState_32f* pState, Ipp32f* pOutTaps);

IppStatus ippsFIRLMSGetTaps32f_16s(const IppsFIRLMSState32f_16s* pState, Ipp32f* pOutTaps);

Parameters

pState	Pointer to the FIR LMS filter state structure.
pOutTaps	Pointer to the array holding copies of the taps.

Description

The function ippsFIRLMSGetTaps is declared in the ipps.h file. This function copies the taps from the state structure pState to the tapsLen-length array pOutTaps. To set new taps in the state structure, create a new state using the function ippsFIRLMSInitAlloc.

Before calling the function ippsFIRLMSGetTaps the filter state structure must be initialized by the function ippsFIRLMSInitAlloc.

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.