SI Remove Trend VI

System Identification VIs

previous page next page
SI Remove Trend VI

Owning Palette: Data Preprocessing VIs

Installed With: System Identification Toolkit

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

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

 Place on the block diagram  Find on the Functions palette

SI Remove Trend (SISO Waveform)

stimulus signal in is the input waveform of the stimulus signal.
response signal in is 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 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.
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. 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.
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 is the input array of the stimulus signal.
response signal in is the input array 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 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.
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. 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.
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 is the input waveform array of the stimulus signals. Each element of the waveform array is the waveform of one stimulus signal.
response signal in is 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 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.
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. 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.
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 is the input array of the stimulus signals. Each row in the array is one stimulus signal.
response signal in is the input array 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 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.
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. 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.
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 is the input waveform array of the stimulus signals. Each element of the waveform array is the waveform of one stimulus signal.
response signals in is 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 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.
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. 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.
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 is the input array of the stimulus signals. Each row in the array is one stimulus signal.
response signals in is the input array of 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 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.
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. 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.
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.

 Open example  Browse related examples

previous page start next page