DFD NStage MRate Filtering for Single Block VI

Digital Filter Design VIs and Functions

previous page next page
DFD NStage MRate Filtering for Single Block VI

Owning Palette: Multirate Processing VIs

Installed With: Digital Filter Design Toolkit

Filters a single-block signal with a multistage multirate filter. 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 NStage MRate Filtering for Single Block (Array)

signal in specifies the input array of single-channel samples you want to process.
multirate filters specifies the input multirate filters.
extension type specifies the method this VI uses to pad data at the beginning and end of signal in to lessen artificial jumps.

0Zero padding (default)—Uses zeroes to pad the input data. Watch for abrupt transitions between the padded zeroes and the input data, which causes large artifacts near the transition.
1Symmetric—Uses replications of the input data to pad the data, except that this VI flips the replications so that there are mirroring symmetries at the beginning and at the end of the input data.
2Periodic—Adds a replication of the input data block at the beginning of the input data block and adds another replication at the end to pad the data.
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 the VI uses the multistage multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. The default is TRUE. You can use a multistage multirate filter as a zero-phase filter only if every stage 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 NStage MRate Filtering for Single Block (Wfm)

signal in specifies the input waveform you want to process.
multirate filters specifies the input multirate filters.
extension type specifies the method this VI uses to pad data at the beginning and end of signal in to lessen artificial jumps.

0Zero padding (default)—Uses zeroes to pad the input data. Watch for abrupt transitions between the padded zeroes and the input data, which causes large artifacts near the transition.
1Symmetric—Uses replications of the input data to pad the data, except that this VI flips the replications so that there are mirroring symmetries at the beginning and at the end of the input data.
2Periodic—Adds a replication of the input data block at the beginning of the input data block and adds another replication at the end to pad the data.
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 the VI uses the multistage multirate filter as a zero-phase filter, in which no delay occurs between signal in and signal out. The default is TRUE. You can use a multistage multirate filter as a zero-phase filter only if every stage 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.
previous page start next page