SI Bandpass Filter VI

System Identification VIs

SI Bandpass Filter VI

Owning Palette: Data Preprocessing VIs

Installed With: System Identification Toolkit

Applies a bandpass filter to stimulus and response signals. Wire data to the signal in and stimulus signal in inputs to determine the polymorphic instance to use or manually select the instance.

The bandpass filter is an elliptic infinite impulse response (IIR) filter and has no phase lag.

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

 Place on the block diagram  Find on the Functions palette

SI Bandpass Filter (SISO Waveform)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
stimulus signal in is the input waveform of the stimulus signal.
response signal in is the input waveform of the response signal.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signal out returns the filtered waveform of the stimulus signal.
response signal out returns the filtered waveform 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.

SI Bandpass Filter (SISO Array)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
stimulus signal in is the input array of the stimulus signal.
response signal in is the input array of the response signal.
sampling rate is the sampling rate of the stimulus and response signals. The default is 1.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signal out returns the filtered array of the stimulus signal.
response signal out returns the filtered array 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.

SI Bandpass Filter (MISO Waveform)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
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.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signals out returns the filtered waveform array of the stimulus signals.
response signal out returns the filtered waveform 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.

SI Bandpass Filter (MISO Array)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
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.
sampling rate is the sampling rate of the stimulus and response signals. The default is 1.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signals out returns the filtered array of the stimulus signals.
response signal out returns the filtered array 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.

SI Bandpass Filter (MIMO Waveform)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
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.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signals out returns the filtered waveform array of the stimulus signals.
response signals out returns the filtered waveform array of the response signals.
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.

SI Bandpass Filter (MIMO Array)

order specifies the filter order. The default is 6. The value of order must be greater than 0. Increasing the order value generates a sharper transition band from the filter.
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.
sampling rate is the sampling rate of the stimulus and response signals. The default is 1.
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.
low cutoff freq specifies the low cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate.
high cutoff freq specifies the high cutoff frequency of the bandpass filter. The cutoff frequency must be less than half the sampling rate and greater than the low cutoff freq.
stimulus signals out returns the filtered array of the stimulus signals.
response signals out returns the filtered array of the response signals.
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.