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

Creates a finite impulse response (FIR) adaptive filter with the normalized filtered-x least mean squares (LMS) algorithm.

Note  National Instruments recommends that you create and destroy adaptive filters outside loop structures.

	secondary path specifies the impulse response of the secondary path. The length of the secondary path array must be greater than zero.
	filter length specifies the filter length of the adaptive filter. The value must be greater than or equal to 2. The default is 128.
	step size specifies the step size of the adaptive filter. The value must be greater than zero and less than 2. The default is 0.1. A large step size can improve the convergence speed of the resulting adaptive filter. However, a large step size might result in a large steady state error or cause instability in the resulting adaptive filter. The adaptive filter becomes unstable if the step size value is greater than 2.
	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.
	filtered-x adaptive filter out returns the normalized filtered-x adaptive filter that this VI creates.
	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.