Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

TSA Average PSD VI

Owning Palette: Advanced PSD VIs

Installed With: Advanced Signal Processing Toolkit

Continuously averages the estimated power spectral density (PSD) of a univariate time series with different averaging methods.

Example

reset? specifies to restart the selected averaging process. The default is FALSE. When you run this VI for the first time, the averaging process restarts automatically.
PSD specifies information about the power spectral density.
f0 specifies the lower boundary of the frequency range.
df specifies the frequency increment.
S(f) specifies the magnitude of the power spectral density.
averaging parameters specifies options this VI uses to average the input power spectral density.
averaging mode specifies the averaging mode.
0No averaging
1RMS averaging (default)—Reduces signal fluctuations but not the noise level. This option does not reduce the noise level because root mean square (RMS) averaging only averages the energy, or power, of the signal.
2Peak hold—Reduces the signal fluctuations and retains the peak levels of the power spectral density. This option performs peak hold averaging at each frequency line separately.
weighting mode specifies the weighting mode for averaging. This option is available only when averaging mode is RMS averaging.
0Exponential (default)—Emphasizes more on new spectral data than on old spectral data by adding more weights to the new spectral data.
1Linear—Combines N spectral records with equal weighting.
number of averages specifies the number of averages to use for averaging. The default is 10.
error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
dB on? specifies to express PSD in decibels. The default is TRUE.
PSD averaged returns information about the averaged power spectral density.
f0 returns the lower boundary of the frequency range.
df returns the frequency increment.
S(f) returns the magnitude of the power spectral density.
averaging done returns TRUE when the number of completed averages equals or exceeds number of averages. Otherwise, averaging done returns FALSE. averaging done is always TRUE if the selected averaging mode is No averaging.
completed averages returns the number of averages that the VI has completed so far.
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Example

Refer to the Average PSD VI in the labview\examples\Time Series Analysis\TSAGettingStarted.llb for an example of using the TSA Average PSD VI.


Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit