Intel® Integrated Performance Primitives Developer Reference

Developer Reference

  • 2021
  • 01/15/2021
  • Public Content
Contents

FIRGenBandstop

Computes bandstop FIR filter coefficients.

Syntax

IppStatus ippsFIRGenBandstop_64f(Ipp64f
rLowFreq
, Ipp64f
rHighFreq
, Ipp64f*
pTaps
, int
tapsLen
, IppWinType
winType
, IppBool
doNormal
, Ipp8u*
pBuffer
);
Include Files
ipps.h
Domain Dependencies
Headers:
ippcore.h
,
ippvm.h
Libraries:
ippcore.lib
,
ippvm.lib
Parameters
rLowFreq
Normalized low cutoff frequency, must be in the range (0, 0.5) and less than
rHighFreq
.
rHighFreq
Normalized high cutoff frequency, must be in the range (0, 0.5) and greater than
rLowFreq
.
pTaps
Pointer to the array where computed tap values are stored. The number of elements in the array is
tapsLen
.
tapsLen
Number of elements in the array containing the tap values, must be equal or greater than 5.
winType
Specifies what type of window is used in computations. The
winType
 must have one of the following values:
ippWinBartlett
 Bartlett window;
ippWinBlackman
 Blackman window;
ippWinHamming
 Hamming window;
ippWinHann
 Hann window.
doNormal
Specifies normalized or non-normalized sequence of the filter coefficients is computed. The
doNormal
 must have one of the following values:
ippTrue
 The function computes normalized sequence of coefficients.
ippFalse
 The function computes non-normalized sequence of coefficients.
pBuffer
Pointer to the buffer for internal calculations. To get the size of the buffer, use the
ippsFIRGenGetBufferSize
 function.
Description
This function computes
tapsLen
 coefficients for bandstop FIR filter with the cutoff frequencies
rLowFreq
 and
rHighFreq
 by windowing the ideal infinite filter coefficients. The parameter
winType
 specifies the type of the window. For more information on window types used by the function, see Windowing Functions. The computed coefficients are stored in the array
pTaps
.
Return Values
ippStsNoErr
Indicates no error.
ippStsNullPtrErr
Indicates an error when the
pTaps
 pointer is
NULL
.
ippStsSizeErr
Indicates an error when the
tapsLen
 is less than 5, or
rLowFreq
 is greater than or equal to
rHighFreq
, or one of the frequency parameters
rLowFreq
 and
rHighFreq
 is out of the range.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.