LabVIEW Advanced Signal Processing Toolkit API Reference

SI Remove Trend VI

  • Updated2023-02-21
  • 16 minute(s) read

SI Remove Trend VI

Owning Palette: Data Preprocessing VIs

Requires: Advanced Signal Processing Toolkit or Control Design and Simulation Module

Removes mean and linear steady-state trends from stimulus and response signals. Wire data to the stimulus signal in and response signal in inputs to determine the polymorphic instance to use or manually select the instance.

Example

SI Remove Trend (SISO Waveform)

stimulus signal in specifies the input waveform of the stimulus signal.
response signal in specifies the input waveform of the response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signal out returns the detrended waveform of the stimulus signal.
response signal out returns the detrended waveform of the response signal.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signal.
response returns the mean of each piece of the response signal.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal.
stimulus intercept returns the intercept of each piece of the stimulus signal.
response slope returns the slope of each piece of the response signal.
response intercept returns the intercept of each piece of the response signal.

SI Remove Trend (SISO Array)

stimulus signal in specifies an array that represents the stimulus signal.
response signal in specifies an array that represents the response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signal out returns the detrended array of the stimulus signal.
response signal out returns the detrended array of the response signal.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signal.
response returns the mean of each piece of the response signal.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal.
stimulus intercept returns the intercept of each piece of the stimulus signal.
response slope returns the slope of each piece of the response signal.
response intercept returns the intercept of each piece of the response signal.

SI Remove Trend (MISO Waveform)

stimulus signals in specifies the input waveform array of the stimulus signals. Each element of the waveform array is the waveform of one stimulus signal.
response signal in specifies the input waveform of the response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signals out returns the detrended waveform array of the stimulus signals.
response signal out returns the detrended waveform of the response signal.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signals. The value in the ith row, jth column of this output is the mean of the ith stimulus signal at the jth piece.
response returns the mean of each piece of the response signal.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal. The value in the ith row, jth column of this output is the slope of the ith stimulus signal at the jth piece.
stimulus intercept returns the intercept of each piece of the stimulus signal. The value in the ith row, jth column of this output is the intercept of the ith stimulus signal at the jth piece.
response slope returns the slope of each piece of the response signal.
response intercept returns the intercept of each piece of the response signal.

SI Remove Trend (MISO Array)

stimulus signals in specifies an array that represents the stimulus signals. Each row in the array is one stimulus signal.
response signal in specifies an array that represents the response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signals out returns the detrended array of the stimulus signals.
response signal out returns the detrended array of the response signal.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signals. The value in the ith row, jth column of this output is the mean of the ith stimulus signal at the jth piece.
response returns the mean of each piece of the response signal.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal. The value in the ith row, jth column of this output is the slope of the ith stimulus signal at the jth piece.
stimulus intercept returns the intercept of each piece of the stimulus signal. The value in the ith row, jth column of this output is the intercept of the ith stimulus signal at the jth piece.
response slope returns the slope of each piece of the response signal.
response intercept returns the intercept of each piece of the response signal.

SI Remove Trend (MIMO Waveform)

stimulus signals in specifies the input waveform array of the stimulus signals. Each element of the waveform array is the waveform of one stimulus signal.
response signals in specifies the input waveform array of the response signals. Each element of the waveform array is the waveform of one response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signals out returns the detrended waveform array of the stimulus signals.
response signals out returns the detrended waveform array of the response signals.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signals. The value in the ith row, jth column of this output is the mean of the ith stimulus signal at the jth piece.
response returns the mean of each piece of the response signals. The value in the ith row, jth column of this output is the mean of the ith response signal at the jth piece.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal. The value in the ith row, jth column of this output is the slope of the ith stimulus signal at the jth piece.
stimulus intercept returns the intercept of each piece of the stimulus signal. The value in the ith row, jth column of this output is the intercept of the ith stimulus signal at the jth piece.
response slope returns the slope of each piece of the response signal. The value in the ith row, jth column of this output is the slope of the ith response signal at the jth piece.
response intercept returns the intercept of each piece of the response signal. The value in the ith row, jth column of this output is the intercept of the ith response signal at the jth piece.

SI Remove Trend (MIMO Array)

stimulus signals in specifies an array that represents the stimulus signals. Each row in the array is one stimulus signal.
response signals in specifies an array that represents the response signals. Each row in the array is one response signal.
trend type specifies the method to use to remove steady-state trends from the stimulus and response signals.

0mean (default)—Removes the mean from the signals. If piecewise points contains breakpoints at sample numbers, this VI removes the mean from each piece of data. Otherwise, this VI removes the mean from the entire set of data samples.
1linear—Removes first-order linear trends from the signals after a least squares fit. If piecewise points contains breakpoints at sample numbers, this VI removes continuous, piecewise, linear trends. Otherwise, this VI removes a single linear trend from the entire set of data samples.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
piecewise points specifies breakpoints at sample numbers in the stimulus and response signals.
stimulus signals out returns the detrended array of the stimulus signals.
response signals out returns the detrended array of the response signals.
mean returns the mean of the signals before removing trend. This option is available only when you use mean as the trend type.
stimulus returns the mean of each piece of the stimulus signals. The value in the ith row, jth column of this output is the mean of the ith stimulus signal at the jth piece.
response returns the mean of each piece of the response signals. The value in the ith row, jth column of this output is the mean of the ith response signal at the jth piece.
error out contains error information. This output provides standard error out functionality.
linear trend returns the linear trend of the signals before removing trend. This option is available only when you use linear as the trend type.
stimulus slope returns the slope of each piece of the stimulus signal. The value in the ith row, jth column of this output is the slope of the ith stimulus signal at the jth piece.
stimulus intercept returns the intercept of each piece of the stimulus signal. The value in the ith row, jth column of this output is the intercept of the ith stimulus signal at the jth piece.
response slope returns the slope of each piece of the response signal. The value in the ith row, jth column of this output is the slope of the ith response signal at the jth piece.
response intercept returns the intercept of each piece of the response signal. The value in the ith row, jth column of this output is the intercept of the ith response signal at the jth piece.

Example

Refer to the Remove Trend VI in the labview\examples\System Identification\Getting Started\General.llb for an example of using the SI Remove Trend VI.

Log in to get a better experience