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

TSA Exponential Prediction VI

Owning Palette: Modeling and Prediction VIs

Installed With: Advanced Signal Processing Toolkit

Predicts the values of an input univariate time series based on exponential smoothing.

Wire data to the Xt input to determine the polymorphic instance to use or manually select the instance.

Details  Example

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

TSA Exponential Prediction (waveform)

number of points specifies the length of the predicted time series. The default is 1.
Xt specifies the input univariate time series.
exponential type specifies the type of exponential smoothing scheme to use in the prediction. Options include Single, Double, and Triple. The default is Single. Refer to the Details section for more information about each exponential type.
exponential factors specifies the weighting factors for exponential smoothing.
level specifies the weight for the level cumulant. The value of value must be a number between 0 and 1.
trend specifies the weight for the trend cumulant. The value of trend 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 of season must be a number between 0 and 1. This option is available only when exponential type is Triple.
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.
season period specifies the length of the seasonal pattern in the input time series. The default is 1. This option is available only when exponential type is Triple.
season type specifies the way in which this VI models the seasonality. This option is available only when exponential type is Triple. Refer to the Details section for information about each season type.
0Multiplicative (default)—Indicates that the time series has a seasonality with the amplitude increasing over time.
1Additive—Indicates that the time series has a constant amplitude change in seasonality.
predicted series returns the predicted univariate time series.
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 Exponential Prediction (array)

number of points specifies the length of the predicted time series. The default is 1.
Xt specifies the input univariate time series.
exponential type specifies the type of exponential smoothing scheme to use in the prediction. Options include Single, Double, and Triple. The default is Single. Refer to the Details section for more information about each exponential type.
exponential factors specifies the weighting factors for exponential smoothing.
level specifies the weight for the level cumulant. The value of value must be a number between 0 and 1.
trend specifies the weight for the trend cumulant. The value of trend 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 of season must be a number between 0 and 1. This option is available only when exponential type is Triple.
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.
season period specifies the length of the seasonal pattern in the input time series. The default is 1. This option is available only when exponential type is Triple.
season type specifies the way in which this VI models the seasonality. This option is available only when exponential type is Triple. Refer to the Details section for information about each season type.
0Multiplicative (default)—Indicates that the time series has a seasonality with the amplitude increasing over time.
1Additive—Indicates that the time series has a constant amplitude change in seasonality.
predicted series returns the predicted univariate time series.
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 Exponential Prediction Details

This VI computes the future values of a time series based on one of the following exponential smoothing schemes: single, double, and triple (Holt-Winters). You can specify the type of exponential smoothing scheme using the exponential type parameter. Each exponential smoothing scheme has a corresponding forecasting formula that uses the computed level cumulant, trend cumulant, and season cumulant vector.

Single

In the single exponential smoothing scheme, this VI obtains the level cumulant Xa. The corresponding k-step-ahead prediction at time t is defined according to the following equation:

Xt(N + k–1) = Xa(N–1)

where N is the number of original time series Xt.

Double

In the double exponential smoothing scheme, this VI obtains the level cumulant Xa and trend cumulant B. The corresponding k-step-ahead prediction at time t is defined according to the following equation:

Xt(N+k–1)=Xa(N–1)+kB(N–1)

Refer to the TSA Exponential Average VI for the descriptions of the level cumulant Xa and trend cumulant B.

Triple

In the triple exponential smoothing scheme, this VI obtains the level cumulant Xa, the trend cumulant B, and the season cumulant vector I=(I1, …, IL). L is seasonal period. If the season type is set as Multiplicative, the corresponding k-step-ahead prediction at time t is defined according to the following equation:

Xt(N+k–1)=(Xa(N–1)+kB(N–1))·It(N+k–1–L)

If the season type is set as Additive, the corresponding k-step-ahead prediction at time t is defined according to the following equation:

Xt(N+k–1)=Xa(N–1)+kB(N–1)+It(N+k–1–L)

Example

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


Resources


 

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