DFD FXP Get MRate Coef Quantizer VI

Digital Filter Design VIs and Functions

previous page next page

Owning Palette: Multirate Fixed-Point Tools VIs

Installed With: Digital Filter Design Toolkit

Retrieves settings for the filter coefficients quantizer of a multirate filter.

Place on the block diagram

Find on the Functions palette

multirate filter in specifies the input fixed-point multirate filter. You must specify a finite impulse response (FIR) multirate filter for this input.

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.

multirate filter out returns the multirate filter in unchanged.

coefficients quantizer returns the settings of the filter coefficients quantizer.

	source returns the quantizer source.
	wl returns the word length, in number of bits, that the quantizer uses to represent a fixed-point number.
	iwl returns the integer word length, in number of bits, within wl that the quantizer uses to represent the integer part of a fixed-point number.
	overflow mode returns the operation mode for overflow and underflow in the quantizer.
	rounding mode returns the mode for rounding numbers in the quantizer.
	signed? is TRUE if the fixed-point number is a signed number. signed? is FALSE if the fixed-point number is an unsigned number.

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