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

TSA Real Cepstrum VI

Owning Palette: Correlation and Spectral Analysis VIs

Installed With: Advanced Signal Processing Toolkit

Computes the single-sided real cepstrum of an input univariate time series. You can use the resulting real cepstrum to detect the periodicities of the time series. The real cepstrum does not keep the phase information of the input time series, so you cannot reconstruct the original time series from the real cepstrum. 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 Real Cepstrum (waveform)

cepstrum bins specifies the number of time points. This VI computes the cepstrum for each time point. The default is –1, which specifies that the number of cepstrum bins equals the length of the input time series.
Xt specifies the input univariate time series.
method specifies whether this VI uses the FFT-based or the autoregressive (AR) model-based method to compute the real cepstrum. The default is FFT. Refer to the Details section for more information about each method.
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.
AR setting specifies the settings for the autoregressive (AR) model. This option is valid only when the method is AR Model.
AR method specifies the method this VI uses to estimate the autoregressive (AR) model.
0Forward-Backward (default)—Computes the AR coefficients by minimizing the least-square errors of the forward and backward predictions.
1Least-Squares—Computes the AR coefficients by minimizing the least-square errors of the forward predictions.
2Yule-Walker—Computes the AR coefficients by solving the Yule-Walker functions based on the forward predictions.
3Burg-Lattice—Computes the AR coefficients using the Levinson-Durbin recursion based on the forward and backward predictions. The Levinson-Durbin recursion uses the arithmetic average.
4Geometric-Lattice—Computes the AR coefficients using the Levinson-Durbin recursion based on the forward and backward predictions. The Levinson-Durbin recursion uses the geometric average.
AR order specifies the order of the autoregressive (AR) model. The value of AR order must be greater than 0. The default is 4.
cepstrum returns the cepstrum information about Xt.
t0 returns the lower boundary of the time range.
dt returns the time increment.
C(t) returns the resulting values of the complex cepstrum.
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 Real Cepstrum (array)

sampling rate specifies the sampling rate, in hertz, of the input univariate time series Xt. The default is 1.
cepstrum bins specifies the number of time points. This VI computes the cepstrum for each time point. The default is –1, which specifies that the number of cepstrum bins equals the length of the input time series.
Xt specifies the input univariate time series.
method specifies whether this VI uses the FFT-based or the autoregressive (AR) model-based method to compute the real cepstrum. The default is FFT. Refer to the Details section for more information about each method.
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.
AR setting specifies the settings for the autoregressive (AR) model. This option is valid only when the method is AR Model.
AR method specifies the method this VI uses to estimate the autoregressive (AR) model.
0Forward-Backward (default)—Computes the AR coefficients by minimizing the least-square errors of the forward and backward predictions.
1Least-Squares—Computes the AR coefficients by minimizing the least-square errors of the forward predictions.
2Yule-Walker—Computes the AR coefficients by solving the Yule-Walker functions based on the forward predictions.
3Burg-Lattice—Computes the AR coefficients using the Levinson-Durbin recursion based on the forward and backward predictions. The Levinson-Durbin recursion uses the arithmetic average.
4Geometric-Lattice—Computes the AR coefficients using the Levinson-Durbin recursion based on the forward and backward predictions. The Levinson-Durbin recursion uses the geometric average.
AR order specifies the order of the autoregressive (AR) model. The value of AR order must be greater than 0. The default is 4.
cepstrum returns the cepstrum information about Xt.
t0 returns the lower boundary of the time range.
dt returns the time increment.
C(t) returns the resulting values of the complex cepstrum.
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 Real Cepstrum Details

When method is FFT, this VI computes the real cepstrum of an input univariate time series according to the following equation:

Xt is the input univariate time series and is the real cepstrum of Xt.

When method is AR Model, this VI computes the real cepstrum of an input univariate time series according to the following equation:

s is the standard deviation of estimated noise series of AR model of Xt and a is the estimated coefficients of AR model. a = [1, a1, a2, …, ak].

Examples

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

  • Bearing Monitor VI: labview\examples\Time Series Analysis\TSAApplications.llb
  • Cepstrum Analysis 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