You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.6 Advanced Signal Processing Toolkit Help

Owning Palette: Statistical Analysis VIs

Installed With: Advanced Signal Processing Toolkit

Computes the mean 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  

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

Select an instance TSA Mean (waveform)TSA Mean (array)TSA Vector Mean (waveform)TSA Vector Mean (array)

TSA Mean (waveform)

	trimmed percent specifies a percentage at which to discard the lowest and highest values in the time series. This option is available only when method is Trimmed.
	Xt specifies the input univariate time series.
	method specifies the method to use in computing the mean value of the input time series. Refer to the Details section for more information about each method. 0 Arithmetic (default) 1 Geometric 2 Trimmed 3 Median
	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.
	mean returns the mean 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 Mean (array)

	trimmed percent specifies a percentage at which to discard the lowest and highest values in the time series. This option is available only when method is Trimmed.
	Xt specifies the input univariate time series.
	method specifies the method to use in computing the mean value of the input time series. Refer to the Details section for more information about each method. 0 Arithmetic (default) 1 Geometric 2 Trimmed 3 Median
	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.
	mean returns the mean 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 Mean (waveform)

	trimmed percent specifies a percentage at which to discard the lowest and highest values in the time series. This option is available only when method is Trimmed.
	Xt specifies the input multivariate (vector) time series.
	method specifies the method to use in computing the mean value of the input time series. Refer to the Details section for more information about each method. 0 Arithmetic (default) 1 Geometric 2 Trimmed 3 Median
	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.
	vector mean returns the vector mean values 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 Mean (array)

	trimmed percent specifies a percentage at which to discard the lowest and highest values in the time series. This option is available only when method is Trimmed.
	Xt specifies the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	method specifies the method to use in computing the mean value of the input time series. Refer to the Details section for more information about each method. 0 Arithmetic (default) 1 Geometric 2 Trimmed 3 Median
	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.
	vector mean returns the vector mean values 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 Mean Details

This VI calculates the mean values of an input time series with the method you specify for the method parameter.

Arithmetic mean

This VI calculates the arithmetic mean value according to the following equation:

where m is the arithmetic mean value, and n is the number of samples of the time series X_t.

Geometric mean

This VI calculates the geometric mean value according to the following equation:

where m is the geometric mean value, and n is the number of samples of the time series X_t.

Trimmed mean

This VI calculates the trimmed mean value by eliminating a percentage of the smallest and largest values from the time series and then calculating the arithmetic average of the remaining values. This method is useful for a time series with extreme values.

Median mean

This VI calculates the median mean value by sorting the values and then selecting the value in the middle. If the number of values in the sample is even, then the median is the average of the two middle values. This method generates a rough mean value but is useful in cases when a time series has large outliers.