Filtering Functions

The Intel IPP functions described in this section implement the following types of filters:

finite impulse response (FIR) filter
adaptive finite impulse response using least mean squares (LMS) filter
infinite impulse response (IIR) filter
median filter.

A special set of functions is designed to generate filter coefficients for different types of FIR filters.

The full list of filtering functions is given in the table below.

Intel IPP Filtering Functions
Function Base Name	Operation
SumWindow	Sums elements in the mask applied to each element of the vector.
FIR Filter Functions
FIRInitAlloc	Allocates memory and initializes a single-rate FIR filter state structure.
FIRStreamInitAlloc	Allocates memory and initializes a single-rate stream FIR filter state structure.
FIRMRInitAlloc	Allocates memory and initializes a multi-rate FIR filter state structure.
FIRMRStreamInitAlloc	Allocates memory and initializes a multi-rate stream FIR filter state structure.
FIRFree	Frees memory allocated for the FIR filter state structure.
FIRInit	Initializes a single-rate FIR filter state structure.
FIRStreamInit	Initializes a single-rate stream FIR filter state structure.
FIRMRInit	Initializes a multi-rate FIR filter state structure.
FIRMRStreamInit	Initializes a multi-rate stream FIR filter state structure.
FIRGetStateSize, FIRMRGetStateSize	Calculates the size of an external buffer for the FIR filter structure.
FIRStreamGetStateSize, FIRMRStreamGetStateSize	Calculates the size of an external buffer for the stream FIR filter structure.
FIRGetTaps	Retrieves the tap values from the FIR filter state structure.
FIRSetTaps	Sets the taps values in the FIR filter state structure.
FIRGetDlyLine	Retrieves the delay line contents from the FIR filter state structure.
FIRSetDlyLine	Sets the delay line contents in the FIR filter state structure.
FIROne	Filters a single sample through a FIR filter.
FIR	Filters a block of samples through a FIR filter.
Direct versions
FIROne_Direct	Directly filters a single sample through a FIR filter.
FIR_Direct	Directly filters a block of samples through a single-rate FIR filter.
FIRMR_Direct	Directly filters a block of samples through a multi-rate FIR filter.
Sparse FIR Filter
FIRSparseInit	Initializes a sparse FIR filter structure.
FIRSparseGetStateSize	Computes the size of the external buffer for the sparse FIR filter structure.
FIRSparse	Filters a block of samples through a sparse FIR filter.
FIR Filter Coefficient Generating Functions
FIRGenLowpass	Computes the lowpass FIR filter coefficients.
FIRGenHighpass	Computes the highpass FIR filter coefficients.
FIRGenBandpass	Computes the bandpass FIR filter coefficients.
FIRGenBandstop	Computes the bandstop FIR filter coefficients.
Single-Rate FIR LMS Filter Functions
FIRLMSInitAlloc	Allocates memory and initializes an adaptive FIR filter that uses the least mean squares (LMS) algorithm.
FIRLMSFree	Closes an adaptive FIR filter that uses the LMS algorithm.
FIRLMSGetTaps	Gets the taps of a FIR LMS filter.
FIRLMSGetDlyLine	Retrieves the delay line contents from the FIR LMS filter.
FIRLMSSetDlyLine	Sets the delay line contents in the FIR LMS filter.
FIRLMS	Filters an array through a FIR LMS filter.
Direct versions
FIRLMSOne_Direct	Filters a single sample through a FIR LMS filter.
Multi-Rate FIR LMS Filter Functions
FIRLMSMRInitAlloc	Allocates memory and initializes an adaptive multi-rate FIR filter that uses the least mean squares (LMS) algorithm.
FIRLMSMRFree	Closes an adaptive multi-rate FIR filter that uses the least mean squares algorithm.
FIRLMSMRSetMu	Sets the adaptation step.
FIRLMSMRUpdateTaps	Updates the filter coefficients using the adaptation error value.
FIRLMSMRGetTaps	Retrieves tap values in the multi-rate FIR LMS filter.
FIRLMSMRSetTaps	Sets tap values in the multi-rate FIR LMS filter.
FIRLMSMRGetTapsPointer	Returns the pointer to the filter coefficients.
FIRLMSMRGetDlyLine	Retrieves the delay line contents from the multi-rate FIR LMS filter state.
FIRLMSMRSetDlyLine	Sets the delay line contents in the multi-rate FIR LMS filter state.
FIRLMSMRGetDlyVal	Gets one delay line values from the specified position.
FIRLMSMRPutVal	Places the input value in the delay line.
FIRLMSMROne	Filters data placed in the delay line.
FIRLMSMROneVal	Filters one input value.
IIR Filter Functions
IIRGenLowpass, IIRGenHighpass	Computes lowpass and highpass IIR filter coefficients.
IIRInitAlloc	Allocates memory and initializes an arbitrary IIR filter state.
IIRInitAlloc_BiQuad	Allocates memory and initializes a biquad IIR filter state.
IIRFree	Closes an IIR filter state.
IIRInit	Initializes an arbitrary IIR filter state.
IIRInit_BiQuad	Initializes a biquad IIR filter state
IIRGetStateSize	Computes the length of the external buffer for the arbitrary IIR filter state structure.
IIRGetStateSize_BiQuad	Computes the length of the external buffer for the biquad IIR filter state structure.
IIRSetTaps	Sets the taps in an IIR filter state
IIRGetDlyLine	Retrieves the delay line values from the IIR filter state.
IIRSetDlyLine	Sets the delay line values in the IIR filter state.
IIROne	Filters a single sample through an IIR filter.
IIR	Filters a block of samples through an IIR filter.
Direct versions
IIROne_Direct	Directly filters a single sample through the arbitrary IIR filter.
IIROne_BiQuadDirect	Directly filters a single sample through the biquad IIR filter.
IIR_Direct	Directly filters a block of samples through the arbitrary IIR filter.
IIR_BiQuadDirect	Directly filters a block of samples through the biquad IIR filter
Sparse IIR Filter
IIRSparseInit	Initializes a sparse IIR filter structure.
IIRSparseGetStateSize	Computes the size of the external buffer for the sparse IIR filter structure.
IIRSparse	Filters a block of samples through a sparse IIR filter.
Median Filter Functions
FilterMedian	Computes median values for each source vector element.