Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

FIRSRInit

Initializes the FIR constant structure for single-rate FIR filtering.

Syntax

IppStatus ippsFIRSRInit_32f(const Ipp32f* pTaps, int tapsLen, IppAlgType algType, IppsFIRSpec_32f* pSpec);

IppStatus ippsFIRSRInit_64f(const Ipp64f* pTaps, int tapsLen, IppAlgType algType, IppsFIRSpec_64f* pSpec);

IppStatus ippsFIRSRInit_32fc(const Ipp32fc* pTaps, int tapsLen, IppAlgType algType, IppsFIRSpec_32fc* pSpec);

IppStatus ippsFIRSRInit_64fc(const Ipp64fc* pTaps, int tapsLen, IppAlgType algType, IppsFIRSpec_64fc* pSpec);

IppStatus ippsFIRSRInit32f_32fc(const Ipp32f* pTaps, int tapsLen, IppAlgType algType, IppsFIRSpec32f_32fc* pSpec);

Include Files

ipps.h

Domain Dependencies

Headers: ippcore.h, ippvm.h

Libraries: ippcore.lib, ippvm.lib

Parameters

pTaps

Pointer to the filter coefficients.

tapsLen

Length of the FIR filter.

algType

Bit-field mask for the algorithm type definition. Possible values are: ippAlgAuto, ippAlgDirect, or ippAlgFFT.

pSpec

Pointer to the internal constant FIR specification structure.

Description

Before using this function, you need to compute the size of the specification structure using the ippsFIRSRGetSize function. This function initializes the constant specification structure for single-rate FIR filtering.

Return Values

ippStsNoErr

Indicates no error.

ippStsNullPtrErr

Indicates an error when one of the specified pointers is NULL.

ippStsSizeErr

Indicates an error when the tapsLen value is less than, or equal to zero.

ippStsAlgTypeErr

Indicates an error when the specified algorithm type is not supported.

See Also