DFD MRate Filtering VI

Digital Filter Design VIs and Functions

previous page next page
DFD MRate Filtering VI

Owning Palette: Multirate Processing VIs

Installed With: Digital Filter Design Toolkit

Filters a signal continuously with a multirate filter. Wire data to the signal in input to determine the polymorphic instance to use or manually select the instance.

Example

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

 Place on the block diagram  Find on the Functions palette

DFD MRate Filtering (Array)

init? controls the initialization of internal states. The default is FALSE, in which this VI initializes internal states from the final states of the previous call to the current VI instance. If you select TRUE, this VI initializes internal states to zero.
signal in specifies the input array of single-channel samples you want to process.
multirate filter specifies the input multirate 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.
zero phase? specifies whether this VI uses the multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. This input is valid only if you set init? to TRUE or if you run this VI for the first time. The default is TRUE. You can use a multirate filter as a zero-phase filter only if it is an even-order 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.

DFD MRate Filtering (Wfm)

init? controls the initialization of internal states. The default is FALSE, in which this VI initializes internal states from the final states of the previous call to the current VI instance. If you select TRUE, this VI initializes internal states to zero.
signal in specifies the input waveform you want to process.
multirate filter specifies the input multirate 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.
zero phase? specifies whether this VI uses the multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. This input is valid only if you set init? to TRUE or if you run this VI for the first time. The default is TRUE. You can use a multirate filter as a zero-phase filter only if it is an even-order filter.
signal out returns the filtered waveform.
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.

DFD MRate Filtering (Array NChan)

init? controls the initialization of internal states. The default is FALSE, in which this VI initializes internal states from the final states of the previous call to the current VI instance. If you select TRUE, this VI initializes internal states to zero.
signal in is the input array of multiple-channel samples you want to process. Each element in the first dimension of the array corresponds to a channel. Each element in the second dimension of the array corresponds to a sample from each channel.
multirate filter specifies the input multirate 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.
zero phase? specifies whether this VI uses the multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. This input is valid only if you set init? to TRUE or if you run this VI for the first time. The default is TRUE. You can use a multirate filter as a zero-phase filter only if it is an even-order filter.
signal out returns an array of filtered multiple-channel samples. Each element in the first dimension of the array corresponds to a channel. Each element in the second dimension of the array corresponds to a sample from each channel.
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.

DFD MRate Filtering (Wfm NChan)

init? controls the initialization of internal states. The default is FALSE, in which this VI initializes internal states from the final states of the previous call to the current VI instance. If you select TRUE, this VI initializes internal states to zero.
signal in is the input array of multiple-channel waveforms you want to process.
multirate filter specifies the input multirate 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.
zero phase? specifies whether this VI uses the multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. This input is valid only if you set init? to TRUE or if you run this VI for the first time. The default is TRUE. You can use a multirate filter as a zero-phase filter only if it is an even-order filter.
signal out returns an array of filtered multiple-channel waveforms.
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.

Example

Refer to the Single Stage Multirate Filter Design VI in the labview\examples\Digital Filter Design\Floating-Point Filters\Multirate directory for an example of using the DFD MRate Filtering VI.

 Open example  Browse related examples

previous page start next page