DFD MRate Filter Design VI

Digital Filter Design VIs and Functions

previous page next page
DFD MRate Filter Design VI

Owning Palette: Multirate Filter Design VIs

Installed With: Digital Filter Design Toolkit

Creates a single-stage multirate filter. You must manually select the polymorphic instance you want to use.

Example

Use the pull-down menu to select an instance of this VI.

 Place on the block diagram  Find on the Functions palette

DFD MRate Filter Design (Integer)

method specifies the method this VI uses to create the filter.

0Kaiser Window
1Dolph-Chebyshev Window
2Equi-Ripple (default)
factor specifies the sampling frequency conversion factor of the multirate filter. The value of factor must be an integer greater than zero. The default is 8.
order specifies the filter order. The value of order must be an even integer that is greater than zero. If order is not greater than zero, this VI uses the ripple specs input to estimate filter order. If order is an odd number, this VI returns an error. The default is –1.
freq specs specifies the passband edge frequency and stopband edge frequency of the multirate filter.
fpass specifies the passband edge frequency of the multirate filter.
fstop specifies the stopband edge frequency of the multirate filter.
ripple specs specifies the ripple level in the passband and stopband of the filter.
passband specifies the ripple level in the passband. The default is 0.1.
stopband specifies the ripple level in the stopband. The default is 60.
dB/linear? specifies whether this VI applies a decibel scale or a linear scale to the ripple levels. If the value is TRUE, this VI applies a decibel scale to the ripple level. If the value is FALSE, this VI applies a linear scale to the ripple level. The default is TRUE.
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. The default is 800.
filtering mode specifies the processing mode of the filter that this VI creates.

0No Rate Change—Does not change the sampling frequency of a signal.
1Interpolation—Increases the sampling frequency of a signal to a higher sampling frequency that differs from the original frequency by an integer value. Interpolation also is known as up-sampling.
2Decimation (default)—Reduces the sampling frequency of a signal to a lower sampling frequency that differs from the original frequency by an integer value. Decimation also is known as down-sampling.
multirate filter out returns a new 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.

DFD MRate Filter Design (Rational)

method specifies the method this VI uses to create the filter.

0Kaiser Window
1Dolph-Chebyshev Window
2Equi-Ripple (default)
factor contains the sampling frequency conversion factor of the multirate filter.
L contains the numerator factor of the rational resampling frequency conversion factor. The value of L must be an integer greater than zero. The value of L must not equal the value of M. The default is 8.
M contains the denominator factor of the rational resampling frequency conversion factor. The value of M must be an integer greater than zero. The value of M must not equal the value of L. The default is 3.
order specifies the filter order. The value of order must be an even integer that is greater than zero. If order is not greater than zero, this VI uses the ripple specs input to estimate filter order. If order is an odd number, this VI returns an error. The default is –1.
freq specs specifies the passband edge frequency and stopband edge frequency of the multirate filter.
fpass specifies the passband edge frequency of the multirate filter.
fstop specifies the stopband edge frequency of the multirate filter.
ripple specs specifies the ripple level in the passband and stopband of the filter.
passband specifies the ripple level in the passband. The default is 0.1.
stopband specifies the ripple level in the stopband. The default is 60.
dB/linear? specifies whether this VI applies a decibel scale or a linear scale to the ripple levels. If the value is TRUE, this VI applies a decibel scale to the ripple level. If the value is FALSE, this VI applies a linear scale to the ripple level. The default is TRUE.
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. The default is 100.
multirate filter out returns a new 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 Single Stage Multirate Filter Design VI in the labview\examples\Digital Filter Design\Floating-Point Filters\Multirate directory for an example of using the DFD MRate Filter Design VI.

 Open example  Browse related examples

previous page start next page