DFD FXP MRate Quantization VI

	scale by power of 2? specifies whether this VI scales the multirate filter with the original norm value or the smallest power of 2 value that is greater than the norm value. If scale by power of 2? is TRUE, this VI scales the multirate filter with the smallest power of 2 value. If scale by power of 2? is FALSE, this VI scales the multirate filter with the original norm value. The default is FALSE.
	scale type specifies how to scale the multirate filter coefficients. Refer to the Details section of the DFD Scale Filter VI for more information about each scale type. 0 No Norm 1 Time Domain 1-Norm (default) 2 Time Domain 2-Norm 3 Time Domain Inf-Norm
	multirate filter in specifies the input multirate filter.
	coefficients word length specifies the word length, in number of bits, that this VI uses to represent the multirate filter coefficients. 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.
	gain settings specifies the settings for the multirate filter gain. gain processing specifies whether you want to process the multirate filter gain on a host machine or an NI Reconfigurable I/O (RIO) target. 0 On Target—Specifies to process the multirate filter gain on an NI-RIO target. 1 On Host (default)—Specifies to process the multirate filter gain on a host machine. gain word length specifies the word length, in number of bits, that this VI uses to represent the multirate filter gain if you set gain processing to On Target. The valid range is [1, 32]. The default is 16.
	multirate filter out returns a fixed-point multirate filter.
	postprocessing gain returns the filter gain that this VI scaled.
	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 FXP MRate Quantization Details

The DFD FXP MRate Quantization VI automatically determines a quantizer for the filter coefficients according to the scale type you specify. The input coefficients word length determines the word length of the quantizer, and the maximum absolute value among the filter coefficients determines the integer word length of the quantizer. This VI sets the overflow mode and rounding mode to saturation and nearest, respectively.

Tip  You can use the DFD FXP Get MRate Coef Quantizer VI to retrieve the quantizer information.

Examples

Refer to the following VIs for examples of using the DFD FXP MRate Quantization VI:

• How to Build Coefficients Quantizer VI: labview\examples\Digital Filter Design\Getting Started\Apply Filters

   Open example  Browse related examples

• Analyze Coefficients-Quantized Multirate Filter VI: labview\examples\Digital Filter Design\Fixed-Point Filters\Multirate

   Open example  Browse related examples