DFD Narrowband Filtering with State VI

Digital Filter Design VIs and Functions

previous page next page

Installed With: Digital Filter Design Toolkit

Filters a signal with a narrowband filter. You must specify the initial internal states in state in to generate an accurate output. Wire data to the signal in input to determine the polymorphic instance to use or manually select the instance.

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

Place on the block diagram

Find on the Functions palette

DFD Narrowband Filtering with State (Array)

signal in specifies the input array of single-channel samples you want to process.

narrowband filter contains the narrowband filter.

multirate filters contains the multirate filters this VI uses to construct the narrowband filter.

filter type contains the type of filter.

0	Lowpass (default)
1	Highpass
2	Bandpass
3	Bandstop
4	Wideband-Lowpass
5	Wideband-Highpass

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.

state in specifies the initial internal states before filtering.

state specifies the internal states of one filter within narrowband filter.

signal out returns an array of filtered single-channel samples.

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.

state out returns the internal states after filtering. You can wire this output to the state in input of another call to this VI if you want to process data continuously.

state returns the internal states of one filter in narrowband filter after filtering.

DFD Narrowband Filtering with State (Wfm)

signal in specifies the input waveform you want to process.