ScaledWindow
Advanced Analysis Library Only
AnalysisLibErrType ScaledWindow (double xArray[], ssize_t numberOfElements, int windowType, WindowConst *windowConstants);
Purpose
![]() |
Note This function has been superseded by ScaledWindowEx. |
Applies a scaled window to the time-domain signal and returns window constants for further analysis.
The windowed time-domain signal is scaled so that when ScaledWindow calculates the power or amplitude spectrum of the windowed waveform, all windows provide the same level within the accuracy constraints of the window. ScaledWindow also returns important window constants for the window you select. These constants are useful when you use functions that perform computations on the power spectrum, such as PowerFrequencyEstimate.
ScaledWindow can perform this operation in place; that is, the input and output arrays can be the same.
Parameters
Input | ||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||
numberOfElements | ssize_t | Number of elements in xArray. | ||||||||||||||||||||||
windowType | int | Type of the window function to apply to the input signal. windowType has the values shown in the following table.
|
||||||||||||||||||||||
Output | ||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||
xArray | double [] | On input, the input signal. On output, this parameter returns the input signal with a scaled window applied. |
||||||||||||||||||||||
windowConstants | WindowConst | Pointer to a structure that contains the following useful constants for the selected window:
typedef struct { double enbw; double coherentgain; } WindowConst; |
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 3.1 and later