You are here: NI Home > Support > Product Reference > Manuals > Sound and Vibration Measurement Suite 7.0 Help

Owning Palette: Weighting and Filtering VIs

Installed With: Sound and Vibration Measurement Suite

Designs an IIR filter and filters the scaled signal [EU]. The data type you wire to the scaled signal [EU] input determines the polymorphic instance to use.

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

Select an instance OAT IIR Preprocess Filter (1 Channel)OAT IIR Preprocess Filter (N Channels)

OAT IIR Preprocess Filter (1 Channel)

	design method specifies the design method. The default is Butterworth. 0 Butterworth (default) 1 Chebyshev 2 Inverse Chebyshev 3 Elliptic
	reset? specifies the initialization of the internal states. The first time this VI runs, or when reset? is TRUE, the internal states initialize to zero. If reset? is FALSE, this VI sets the internal states to the final states from the previous call to the VI. The default is FALSE.
	filter type specifies the type of filter. 0 Lowpass (default) 1 Highpass 2 Bandpass 3 Bandstop
	scaled signal [EU] specifies the scaled signals expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
	order specifies the filter order. The filter order must be greater than zero. When order increases, the transition band becomes narrower, and the time to get a stable output increases. The default is 2.
	freq specs specifies the cut-off frequency in hertz. low cutoff freq specifies the low cutoff frequency. The default is 100 Hz. high cutoff freq specifies the high cutoff frequency. Use high cutoff frequency for bandpass or bandstop filter design. high cutoff freq must be greater than low cutoff freq. The default is 200 Hz.
	ripple specs specifies the ripple level, in decibels, in both the passband and the stopband. passband ripple specifies the ripple level in the passband in decibels. The default is 0.1. stopband attenuation specifies the ripple level in the stopband in decibels. The default is 60.
	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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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 scaled signal returns the filtered waveform expressed in the selected engineering units.
	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.

OAT IIR Preprocess Filter (N Channels)

	design method specifies the design method. The default is Butterworth. 0 Butterworth (default) 1 Chebyshev 2 Inverse Chebyshev 3 Elliptic
	reset? specifies the initialization of the internal states. The first time this VI runs, or when reset? is TRUE, the internal states initialize to zero. If reset? is FALSE, this VI sets the internal states to the final states from the previous call to the VI. The default is FALSE.
	filter type specifies the type of filter. 0 Lowpass (default) 1 Highpass 2 Bandpass 3 Bandstop
	scaled signals [EU] specifies the scaled signals expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
	order specifies the filter order. The filter order must be greater than zero. When order increases, the transition band becomes narrower, and the time to get a stable output increases. The default is 2.
	freq specs specifies the cut-off frequency in hertz. low cutoff freq specifies the low cutoff frequency. The default is 100 Hz. high cutoff freq specifies the high cutoff frequency. Use high cutoff frequency for bandpass or bandstop filter design. high cutoff freq must be greater than low cutoff freq. The default is 200 Hz.
	ripple specs specifies the ripple level, in decibels, in both the passband and the stopband. passband ripple specifies the ripple level in the passband in decibels. The default is 0.1. stopband attenuation specifies the ripple level in the stopband in decibels. The default is 60.
	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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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 scaled signals contains the filtered waveforms for each channel expressed in the selected engineering units.
	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.