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

TSA Deviation and Variance VI

Owning Palette: Statistical Analysis VIs

Installed With: Advanced Signal Processing Toolkit

Computes the standard deviation, variance, and coefficients of variation values of an input univariate or multivariate (vector) time series. 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 Deviation and Variance (waveform)

Xt specifies the input univariate time series.
weighting specifies which type of standard deviation and variance values to calculate. Options include Sample and Population. The default is Sample. Refer to the Details section for information about how this parameter affects the deviation and variance values.
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.
standard deviation returns the standard deviation value of the input time series.
variance returns the variance value of the input time series.
coefficients of variation returns the coefficients of variation value of the input 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 Deviation and Variance (array)

Xt specifies the input univariate time series.
weighting specifies which type of standard deviation and variance values to calculate. Options include Sample and Population. The default is Sample. Refer to the Details section for information about how this parameter affects the deviation and variance values.
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.
standard deviation returns the standard deviation value of the input time series.
variance returns the variance value of the input time series.
coefficients of variation returns the coefficients of variation value of the input 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 Vector Deviation and Variance (waveform)

Xt specifies the input multivariate (vector) time series.
weighting specifies which type of standard deviation and variance values to calculate. Options include Sample and Population. The default is Sample. Refer to the Details section for information about how this parameter affects the deviation and variance values.
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.
standard deviation returns the vector standard deviation value of the input multivariate (vector) time series.
variance returns the vector variance value of the input multivariate (vector) time series.
coefficients of variation returns the vector coefficients of variation value of the input multivariate (vector) 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 Vector Deviation and Variance (array)

Xt specifies the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
weighting specifies which type of standard deviation and variance values to calculate. Options include Sample and Population. The default is Sample. Refer to the Details section for information about how this parameter affects the deviation and variance values.
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.
standard deviation returns the vector standard deviation value of the input multivariate (vector) time series.
variance returns the vector variance value of the input multivariate (vector) time series.
coefficients of variation returns the vector coefficients of variation value of the input multivariate (vector) 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 Deviation and Variance Details

This VI calculates the standard deviation and variance values according to the following equations:

where m is the arithmetic mean, s2 is variance, s is standard deviation, n is the number of time series Xt. w = n when weighting is set to Population and w = (n–1) when weighting is set to Sample.

This VI calculates the coefficients of variation according to the following equation:

Examples

Refer to the following VIs for examples of using the TSA Deviation and Variance VI:

  • Engine Knocking Monitor VI: labview\examples\Time Series Analysis\TSAApplications.llb
  • Power Line Monitor VI: labview\examples\Time Series Analysis\TSAApplications.llb
  • ARMA Prediction VI: labview\examples\Time Series Analysis\TSAGettingStarted.llb
  • Series Statistical 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