DFD Plot NStage MRate Freq Response VI

Digital Filter Design VIs and Functions

DFD Plot NStage MRate Freq Response VI

Owning Palette: Multirate Filter Analysis VIs

Installed With: Digital Filter Design Toolkit

Plots the frequency responses, including the magnitude and phase responses, of multistage multirate filters.

Example

 Place on the block diagram  Find on the Functions palette
output option specifies the filter responses that this VI plots.

0Auto (default)—This VI automatically determines the responses of multirate filters in to plot. If multirate filters in are floating-point multirate filters, this VI plots the frequency responses of these multirate filters. If multirate filters in are fixed-point multirate filters, this VI plots the frequency responses of both these multirate filters and the reference floating-point multirate filters.
1Floating-Point Only—If multirate filters in are floating-point multirate filters, this VI plots the frequency responses of these multirate filters. If multirate filters in are fixed-point multirate filters, this VI plots the frequency responses of only the reference floating-point multirate filters.
2Fixed-Point Only—If multirate filters in are floating-point multirate filters, this VI returns an empty graph. If multirate filters in are fixed-point multirate filters, this VI plots the frequency responses of these multirate filters.
# freq bins specifies the number of frequency bins between 0 and the highest sampling frequency in the frequency response of the multirate filter. The default is –1, which specifies that this VI automatically determines the number of frequency bins.
multirate filters in specifies the input multistage multirate filters.
phase view specifies the phase response display settings.
unwrap? specifies whether this VI unwraps the phase. The default is FALSE, which specifies that the phase remains wrapped and is limited to [0, 2π).
degree? specifies whether the phase appears in degrees or radians. The default is FALSE, which specifies that the phase appears in radians.
dB on? specifies whether this VI uses decibels or a linear scale to express the magnitude response. The default is TRUE, which specifies that this VI converts linear magnitude response to decibels.
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.
fs in specifies the input sampling frequency of the multirate filter in hertz. If the value of fs in is equal to or less than zero, this VI uses the sampling frequency of the input filter. The default is –1.
multirate filters out returns the multirate filters in unchanged.
magnitude responses returns the overall magnitude response and the magnitude response of each stage of the multirate filters in. For fixed-point multistage multirate filters, this VI returns the magnitude responses of all stages by interleaving the fixed-point magnitude responses and reference floating-point magnitude responses in the following format: [MRoverall, MFoverall, MR1, MF1, MR2, MF2, …, MRn, MFn]
where MRoverall represents the overall magnitude response of the reference floating-point multistage multirate filter
MFoverall represents the overall magnitude response of the fixed-point multistage multirate filter
MRn represents the magnitude response of the nth stage of the reference floating-point multistage multirate filter
MFn represents the magnitude response of the nth stage of the fixed-point multistage multirate filter
phase responses returns the overall phase response and the phase response of each stage of the multirate filters in multirate filters in. For fixed-point multistage multirate filters, this VI returns the phase responses of all stages by interleaving the fixed-point phase responses and reference floating-point phase responses in the following format: [PRoverall, PFoverall, PR1, PF1, PR2, PF2, …, PRn, PFn]
where PRoverall represents the overall phase response of the reference floating-point multistage multirate filter
PFoverall represents the overall phase response of the fixed-point multistage multirate filter
PRn represents the phase response of the nth stage of the reference floating-point multistage multirate filter
PFn represents the phase response of the nth stage of the fixed-point multistage multirate filter
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 Analyze Coefficients-Quantized Multistage Multirate Filter VI in the labview\examples\Digital Filter Design\Fixed-Point Filters\Multirate directory for an example of using the DFD Plot NStage MRate Freq Response VI.

 Open example  Browse related examples