DFD FXP NStage MRate Modeling VI

Digital Filter Design VIs and Functions

previous page next page

Owning Palette: Multirate Fixed-Point Tools VIs

Installed With: Digital Filter Design Toolkit

Creates a fixed-point multistage multirate filter model according to the input and output word length settings.

Example

Place on the block diagram

Find on the Functions palette

interstage word lengths specifies the word lengths, in number of bits, that this VI uses to represent the signal between every two consecutive stages of the multirate filter.

multirate filters in specifies the input multistage multirate filter.

input word length specifies the word length, in number of bits, that this VI uses to represent the input signal. The valid range is [1, 32]. The default is 16.

output word length specifies the word length, in number of bits, that this VI uses to represent the output signal. The valid range is [1, 32]. The default is 16.

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.

output rounding mode specifies the rounding mode this VI uses in the output quantizer.

0	Nearest—Rounds to the closest representable number.
1	Truncation (default)—Rounds to the closest representable number less than the original value.

internal precision specifies the precision of the internal signals.

0	Truncated (default)—Approximates a full-precision result and helps spare logical resources of the FPGA hardware target. This option is valid for all finite impulse response (FIR) multirate filters and cascaded integrator comb (CIC) decimation filters.
1	Full—Provides a full-precision result. You must use this option if the filter is a moving average (MA) multirate filter. Otherwise the simulation cannot return the same results as the code generation results.

multirate filters out returns the fixed-point multistage multirate filters.

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 Fixed-Point Multistage Multirate Filter Modeling and Simulation VI in the labview\examples\Digital Filter Design\Fixed-Point Filters\Multirate directory for an example of using the DFD FXP NStage MRate Modeling VI.

Open example Browse related examples

previous page start next page