CD Construct Filter Model VI

Control Design VI and Function

CD Construct Filter Model VI

Owning Palette: Model Construction VIs

Installed With: Control Design and Simulation Module

Constructs a digital filter model. You must manually select the polymorphic instance to use.

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

 Place on the block diagram  Find on the Functions palette

CD Construct Filter Model (Coefficients)

Frequency (Hz) specifies the frequency, in hertz, of the digital filter this VI creates. The default value is 1 Hz.
Reverse Coefficients (Denominator) specifies the reverse coefficients of the digital filter this VI creates. The reverse coefficients also are the coefficients of the denominator polynomial function of the Transfer Function Model.
Forward Coefficients (Numerator) specifies the forward coefficients of the digital filter this VI creates. The forward coefficients also are the coefficients of the numerator polynomial function of the Transfer Function Model.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
Transfer Function Model returns the transfer function this VI constructs based on the inputs. To access and modify the data in the model, use the Model Information VIs.
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.

CD Construct Filter Model (Specifications)

Specification specifies the passband ripple and stopband attenuation of the filter.
passband ripple specifies the passband ripple, in decibels. The default value is 0.1 dB.
stopband attenuation specifies the stopband attenuation, in decibels. This parameter is valid only if you specify Elliptic for the Coefficients Type parameter. The default value of stopband attenuation is 60 dB.
Sampling Frequency specifies the sampling frequency, in hertz, of the filter. The value of this parameter must be greater 0, or LabVIEW returns an error. The default value is 10 Hz.
Coefficients Type specifies the type of coefficients this VI generates to create the filter. You also can specify the Order of these coefficients.

0Butterworth
1Chebyshev
2Elliptic (default)
Filter Type specifies the type of filter this VI creates.

0Lowpass
1Highpass
2Bandpass
3Bandstop (default)
Order specifies the order of the coefficients this VI generates to create the filter. The default value is 2.
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 exception control to treat what is normally an error as no error or to treat a warning as an error. 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.
High Cutoff Frequency specifies the upper cutoff frequency, in hertz, of the filter. The default value is 2 Hz. This parameter is valid only if you specify Bandpass or Bandstop for the Filter Type parameter. The value of the High Cutoff Frequency must be greater than the value of the Low Cutoff Frequency and observe the Nyquist criterion.
Low Cutoff Frequency specifies the lower cutoff frequency, in hertz, of the filter. The default value is 0.01 Hz. This parameter is valid only if you specify Bandpass or Bandstop for the Filter Type parameter. The value of the Low Cutoff Frequency must be less than the value of the High Cutoff Frequency and observe the Nyquist criterion.
Note  If the Low Cutoff Frequency is less than or equal to 0 or is greater than half the Sampling Frequency, this VI returns an error.
Zero-Pole-Gain Model returns the zero-pole-gain form of the digital filter this VI creates.
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.