Time Series Preprocessing Express VI

LabVIEW 2014 Advanced Signal Processing Toolkit Help

Edition Date: June 2014

Part Number: 372656C-01

»View Product Info
Download Help (Windows Only)

Owning Palette: Preprocessing VIs

Requires: Advanced Signal Processing Toolkit

Preprocesses univariate or multivariate (vector) time series by moving average, resampling, detrending, or exponential average.

Dialog Box Options
Block Diagram Inputs
Block Diagram Outputs

Dialog Box Options

ParameterDescription
Data SourceSpecifies whether this Express VI reads data from a block diagram input terminal or from a file. From terminal specifies that this Express VI reads data from a block diagram input terminal. From file specifies that this Express VI reads data from a file. This Express VI can read data from waveform, WAV, or TXT files. Waveform and TXT files can contain single-channel or multi-channel data. WAV files can contain only single-channel data.
File Path ConfigurationContains the following options:
  • File path—Specifies and displays the path to the file from which this Express VI reads data. This option is available only when you select From file in the Data Source section.
  • Prompt to choose a file each time this VI runs—Specifies whether this Express VI displays a dialog box that prompts you to select a file each time this Express VI runs. This option is available only when you select the From file option in the Data Source section.
System DimensionsSpecifies the dimensions of the input signal. Options include Single channel and Multiple channels. System Dimensions is available only when you select From terminal in Data Source. When you select From file in Data Source, this VI determines the dimensions of the time series automatically according to the file content.
Data TypeSpecifies the data type for the input signal or signals. Options include Array and Waveform. Data Type is available only when you select From terminal in Data Source. When you select From file in Data Source, this VI determines the data type of the time series automatically according to the file content.
ConfigurationContains the following options:
  • Method—Specifies the method to use in preprocessing a time series. Contains the following options:
    • Moving Average (default)
    • Resampling
    • Detrending
    • Exponential Average
  • Channel—Specifies the channel of the time series and the processed time series. This option is available only when you select Multiple channels in System Dimensions.
  • Sampling rate—Specifies the sampling rate of the time series. This option is available only when you select Array in Data Type.
Algorithm settingsSpecifies the settings for the preprocessing algorithm. Contains the following options:
  • Method of moving average—Specifies the filter type to use in filtering the time series. Options include Spencer (default) and Henderson. This option is available only when you select Moving Average from the Method list.
  • New sampling rate—Specifies the sampling rate for the resampled time series. This option is available only when you select Resampling from the Method list.
  • Method of detrend—Specifies the curve-fitting method to use in estimating the trend. Options include Linear (default), Quadratic, Cubic, N-polynomial, and Exponential. This option is available only when you select Detrending from the Method list.
  • Polynomial order—Specifies the polynomial order to use in the N-polynomial fit. The value of this parameter must be greater than or equal to 0. This option is available only when you select N-polynomial from the Method of detrend list.
  • View trend—Specifies whether to display the trend of the time series. The default is FALSE. This option is available only when you select Detrending from the Method list.
  • Exponential type—Specifies the type of the exponential function. This option is available only when you select Exponential Average from the Method list. Contains the following options:
    • Single (default)
    • Double
    • Triple
  • Season period—Specifies the length of the seasonal pattern in the time series. This option is available only when Exponential type is Triple.
  • Season type—Specifies the way in which this Express VI models the seasonality. This option is available only when Exponential type is Triple. Contains the following options:
    • Multiplicative (default)
    • Additive
  • Level—Specifies the weight for the level cumulant. The value must be a number between 0 and 1. This option is available only when you select Exponential Average from the Method list.
  • Trend—Specifies the weight for the trend cumulant. The value must be a number between 0 and 1. This option is available only when Exponential type is Double or Triple.
  • Season—Specifies the weight for the seasonal cumulant. The value must be a number between 0 and 1. This option is available only when Exponential type is Triple.
Original and Processed SignalContains the following options:
  • Signal—Displays the univariate or multivariate (vector) time series to preprocess.
  • Filtered signal—Displays the processed time series. This graph displays the filtered time series. This option is available only when you select Moving Average from the Method list.
  • Resampled signal—Displays the processed time series. This graph displays the resampled time series. This option is available only when you select Resampling from the Method list.
  • Detrended signal—Displays the processed time series. This graph displays the detrended time series. This option is available only when you select Detrending from the Method list.
  • Averaged signal—Displays the processed time series. This graph displays the averaged time series. This option is available only when you select Exponential Average from the Method list.

Block Diagram Inputs

ParameterDescription
error in (no error)Describes error conditions that occur before this node runs.
XtSpecifies the time series. Xt is available only when you select From terminal in Data Source.
File pathSpecifies the file path of the data you want to load. This input is available only when you select the From file option in the Data Source section.

Block Diagram Outputs

ParameterDescription
error outContains error information. This output provides standard error out functionality.
Xt filteredReturns the processed time series. This output returns the filtered time series. This output is available only when you select Moving Average from the Method list in the Time Series Preprocessing dialog box.
Xt resampledReturns the processed time series. This output returns the resampled time series. This output is available only when you select Resampling from the Method list in the Time Series Preprocessing dialog box.
Xt detrendedReturns the processed time series. This output returns the detrended time series. This output is available only when you select Detrending from the Method list in the Time Series Preprocessing dialog box.
TrendReturns the trend of the input time series. This output is available only when you select Detrending from the Method list.
Xt averagedReturns the processed time series. This output returns the averaged time series. This output is available only when you select Exponential Average from the Method list in the Time Series Preprocessing dialog box.

This Express VI operates similarly to the following VIs and functions:

TSA Detrend
TSA Exponential Average
TSA Moving Average
TSA Resampling

WAS THIS ARTICLE HELPFUL?

Not Helpful