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

Owning Palette: Filtered-X Adaptive Filter VIs

Installed With: Adaptive Filter Toolkit

Processes an input signal with an adaptive filter you create by using the AFT Create FIR Filtered-X LMS or AFT Create FIR Normalized Filtered-X LMS VI.

Examples

	reset? specifies whether to reset the internal states and coefficients of the adaptive filter to zeroes. The default is FALSE.
	filtered-x adaptive filter in specifies the filtered-x adaptive filter that you create.
	x(n) specifies the input signal x(n) to the adaptive filter.
	e(n) specifies the error signal e(n) 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 value for the filtered-x 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  If the filtered-x adaptive filter uses the normalized filtered-x LMS algorithm, the value must be less than 2.
	filtered-x adaptive filter out returns the filtered-x adaptive filter in unchanged.
	y(n) returns the output signal from the filtered-x adaptive filter.
	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 Filtered-X Filter Signal and Update Coefficients VI:

• Active Noise Control (Simulated) VI: labview\examples\Adaptive Filters\Applications\Active Noise Control
• Use Filtered-X LMS Adaptive Filter VI: labview\examples\Adaptive Filters\Getting Started