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

TSA Periodogram VI

Owning Palette: Correlation and Spectral Analysis VIs

Installed With: Advanced Signal Processing Toolkit

Computes the single-sided power spectral density (PSD) of an input univariate time series using the periodogram method. The periodogram method is a fast Fourier transform (FFT) based method that estimates the PSD. Wire data to the Xt input to determine the polymorphic instance to use or manually select the instance.

Details  Examples

Use the pull-down menu to select an instance of this VI.

TSA Periodogram (waveform)

frequency bins specifies the number of frequency bins for which this VI computes the single-sided power spectral density PSD. The length of the single-sided PSD is (frequency bins/2+1). The default is 1024.
Xt specifies the input univariate time series.
window specifies the time-domain window applied to the time series. Options include None (default), Hanning, Hamming, Blackman-Harris, Exact Blackman, Blackman, Flat Top, 4 Term B-Harris, 7 Term B-Harris, and Low Sidelobe.
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 whether this VI returns the PSD in decibels or in a linear scale. If dB on? is TRUE, this VI returns the PSD in decibels. If dB on? is FALSE, this VI returns the PSD in a linear scale. The default is TRUE.
PSD returns information about the single-sided power spectral density (PSD).
f0 returns the lower boundary, in hertz, of the frequency range.
df returns the frequency increment, in hertz.
S(f) returns the magnitude of the PSD at each frequency. The value of dB on? determines the unit of measurement for this parameter.
unit returns the engineering unit of the PSD. You can specify an engineering unit for a time series by using the TSA Scale to EU VI.
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.

TSA Periodogram (array)

sampling rate specifies the sampling rate, in hertz, of the input univariate time series Xt. The default is 1.
frequency bins specifies the number of frequency bins for which this VI computes the single-sided power spectral density PSD. The length of the single-sided PSD is (frequency bins/2+1). The default is 1024.
Xt specifies the input univariate time series.
window specifies the time-domain window applied to the time series. Options include None (default), Hanning, Hamming, Blackman-Harris, Exact Blackman, Blackman, Flat Top, 4 Term B-Harris, 7 Term B-Harris, and Low Sidelobe.
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 whether this VI returns the PSD in decibels or in a linear scale. If dB on? is TRUE, this VI returns the PSD in decibels. If dB on? is FALSE, this VI returns the PSD in a linear scale. The default is TRUE.
PSD returns information about the single-sided power spectral density (PSD).
f0 returns the lower boundary, in hertz, of the frequency range.
df returns the frequency increment, in hertz.
S(f) returns the magnitude of the PSD at each frequency. The value of dB on? determines the unit of measurement for this parameter.
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.

TSA Periodogram Details

This VI computes the PSD of a time series using the periodogram method according to the following equation:

where S(f) is the PSD of the time series. df is the frequency interval, which is computed as fs/N. NBW is the noise power bandwidth of the window. N is the number of frequency bins. fs is the sampling rate. Before computing the PSD, this VI wraps the original time series Xt to an N-point series Xt'.

Examples

Refer to the following VIs for examples of using the TSA Periodogram VI:

  • Average PSD VI: labview\examples\Time Series Analysis\TSAGettingStarted.llb
  • Beam Crack Detection VI: labview\examples\Time Series Analysis\TSAApplications.llb
  • Power Spectral Density Estimation VI: labview\examples\Time Series Analysis\TSAGettingStarted.llb

Resources
 

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