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

Owning Palette: Preprocessing VIs

Installed With: Advanced Signal Processing Toolkit

Removes the trend from an input univariate or multivariate (vector) time series. This VI estimates the trend with curve-fitting methods. Wire data to the Xt input to determine the polymorphic instance to use or manually select the instance.

Example

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

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

TSA Detrend (waveform)

	polynomial order specifies the polynomial order to use in the N-polynomial fit. This option is available only when method is N-polynomial. The value must be greater than or equal to 0. The default is 2.
	Xt specifies the input univariate time series.
	method specifies the curve-fitting method to use in estimating the trend of Xt. 0 Linear (default) 1 Quadratic 2 Cubic 3 N-polynomial 4 Exponential
	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.
	Xt detrended returns the detrended univariate time series.
	trend returns the trend component of the input 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 Detrend (array)

	polynomial order specifies the polynomial order to use in the N-polynomial fit. This option is available only when method is N-polynomial. The value must be greater than or equal to 0. The default is 2.
	Xt specifies the input univariate time series.
	method specifies the curve-fitting method to use in estimating the trend of Xt. 0 Linear (default) 1 Quadratic 2 Cubic 3 N-polynomial 4 Exponential
	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.
	Xt detrended returns the detrended univariate time series.
	trend returns the trend component of the input 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 Vector Detrend (waveform)

	polynomial order specifies the polynomial order to use in the N-polynomial fit. This option is available only when method is N-polynomial. The value must be greater than or equal to 0. The default is 2.
	Xt specifies the input multivariate (vector) time series.
	method specifies the curve-fitting method to use in estimating the trend of Xt. Each element of the array is one selection for one channel.
	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.
	Xt detrended returns the detrended multivariate (vector) time series.
	trend returns the trend component 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 Detrend (array)

	polynomial order specifies the polynomial order to use in the N-polynomial fit. This option is available only when method is N-polynomial. The value must be greater than or equal to 0. The default is 2.
	Xt specifies the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	method specifies the curve-fitting method to use in estimating the trend of Xt. Each element of the array is one selection for one channel.
	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.
	Xt detrended returns the detrended multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	trend returns the trend component of the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	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.

Example

Refer to the Trend Estimation (Curve Fitting) VI in the labview\examples\Time Series Analysis\TSAGettingStarted.llb for an example of using the TSA Detrend VI.