Admin Production ni-theme
Current Publication

NameWinProperties

LabWindows/CVI

NameWinProperties

Advanced Analysis Library Only

AnalysisLibErrType NameWinProperties (ssize_t windowSize, int windowType, double windowParameter, WindowConst *windowConstants);

Purpose

Computes the coherent gain and equivalent noise bandwidth of a window by window type. The coherent gain and equivalent noise bandwidth of a given window are defined as follows:

noloc_eq_winprop1.gif
noloc_eq_winprop2.gif

where wi are the window coefficients and n is the number of coefficients.

Parameters

Input
Name Type Description
windowSize ssize_t The window size.
windowType int The type of window to calculate. windowType must be one of the following values:

Window Type Constant Value
Rectangle RECTANGLE 0
Hanning HANNING 1
Hamming HAMMING 2
Blackman-Harris BLKHARRIS 3
Exact Blackman EXBLKMAN 4
Blackman BLKMAN 5
Flat Top FLATTOP 6
4-Term Blackman-Harris BH4TERM 7
7-Term Blackman-Harris BH7TERM 8
Lowside LB LOWSIDELB 9
Blackman-Nuttall BLKMANNUTTAL 11
Triangle TRIANGLE 30
Barthann BARTHANN 31
Bohman BOHMAN 32
Parzen PARZEN 33
Welch WELCH 34
Kaiser KAISER 60
Dolph-Chebyshev DOLCHEBYSHEV 61
Gaussian GAUSSIAN 62
windowParameter double The window parameter. This parameter is referenced only if windowType is one of the following values:
  • KAISER: windowParameter specifies the beta parameter for a Kaiser window.
  • GAUSSIAN: windowParameter specifies the standard deviation for a Gaussian window. If windowParameter < 0, the function uses 0.2 for windowParameter instead.
  • DOLCHEBYSHEV: windowParameter specifies the ratio of the mainlobe to the sidelobe, in dB, for a Dolph-Chebyshev window. If windowParameter < 0, the function uses 60dB for windowParameter instead.
Output
Name Type Description
windowConstants WindowConst The equivalent noise bandwidth (ENBW) and coherent gain of the window defined by windowType.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.

Additional Information

Library: Advanced Analysis Library

Include file: analysis.h

LabWindows/CVI compatibility: LabWindows/CVI 2012 and later