You are here: NI Home > Support > Product Reference > Manuals > LabVIEW Adaptive Filter Toolkit 1.0 Help

Owning Palette: Adaptive Filters VIs

Installed With: Adaptive Filter Toolkit

Filters an input signal with an adaptive filter and updates the coefficients of the adaptive filter iteratively. You must use the least mean squares (LMS) or recursive least squares (RLS) algorithms to create the adaptive filter. Wire data to the x(n) and d(n) inputs to determine the polymorphic instance to use or manually select the instance. The data type of the adaptive filter that you wire to the adaptive filter in input must match the instance of the AFT Filter Signal and Update Coefficients VI.

Note  If you use the AFT Create FIR Fast Block LMS VI to create an adaptive filter, you can filter the input signal only by arrays or waveforms.

Examples

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

Select an instance AFT Filter Signal and Update Coefficients (Real, PtByPt)AFT Filter Signal and Update Coefficients (Real, Waveform)AFT Filter Signal and Update Coefficients (Real, Array)AFT Filter Signal and Update Coefficients (Complex, PtByPt)AFT Filter Signal and Update Coefficients (Complex, Waveform)AFT Filter Signal and Update Coefficients (Complex, Array)

AFT Filter Signal and Update Coefficients (Real, PtByPt)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

AFT Filter Signal and Update Coefficients (Real, Waveform)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter. If the input adaptive filter uses the fast block least mean squares (LMS) algorithm, the number of samples in the x(n) waveform must equal the length of the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter. If the input adaptive filter uses the fast block least mean squares (LMS) algorithm, the number of samples in the d(n) waveform must equal the length of the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

AFT Filter Signal and Update Coefficients (Real, Array)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter. If the adaptive filter uses the fast block least mean squares (LMS) algorithm, the length of the x(n) array must equal the length of the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter. If the adaptive filter uses the fast block least mean squares (LMS) algorithm, the length of the d(n) array must equal the length of the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

AFT Filter Signal and Update Coefficients (Complex, PtByPt)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

AFT Filter Signal and Update Coefficients (Complex, Waveform)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter. If the input adaptive filter uses the fast block least mean squares (LMS) algorithm, the number of samples in the x(n) waveform must equal the length of the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter. If the input adaptive filter uses the fast block least mean squares (LMS) algorithm, the number of samples in the d(n) waveform must equal the length of the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

AFT Filter Signal and Update Coefficients (Complex, Array)

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	adaptive filter in specifies the adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter. If the adaptive filter uses the fast block least mean squares (LMS) algorithm, the length of the x(n) array must equal the length of the adaptive filter.
	d(n) specifies the input signal d(n) to the adaptive filter. If the adaptive filter uses the fast block least mean squares (LMS) algorithm, the length of the d(n) array must equal the length of the adaptive filter.
	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.
	step size specifies the step size for the adaptive filter. If this value is less than zero, this VI ignores this parameter and uses the step size that you specify when you create the adaptive filter. If this value is zero, this VI processes the input signal without updating the coefficients of the adaptive filter. If this value is greater than zero, this VI uses this value as the step size to update the coefficients of the adaptive filter. The default is –1. Note  This parameter is valid only if the adaptive filter uses a least mean squares (LMS) algorithm. If the adaptive filter uses the normalized LMS or normalized leaky LMS algorithm, the value must be less than 2.
	adaptive filter out returns the adaptive filter in unchanged.
	y(n) returns the output signal from the adaptive filter.
	e(n) returns the error signal, which is the difference between d(n) and y(n).
	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.

Examples

Refer to the following VIs for examples of using the AFT Filter Signal and Update Coefficients VI:

• System Identification VI: labview\examples\Adaptive Filters\Applications\System Identification
• Fetal ECG Signal Extraction VI: labview\examples\Adaptive Filters\Applications\Fetal ECG Signal Extraction
• Use Adaptive Filter (Array) VI: labview\examples\Adaptive Filters\Getting Started
• Use Adaptive Filter (Point by Point) VI: labview\examples\Adaptive Filters\Getting Started
• Use Adaptive Filter (Waveform) VI: labview\examples\Adaptive Filters\Getting Started