CD Get Frequency Response Data VI

Control Design VI and Function

CD Get Frequency Response Data VI

Owning Palette: Frequency Response VIs

Installed With: Control Design and Simulation Module

Gives access to the frequency response information the Frequency Response VIs return. The data types you wire to the Input and Output inputs determine the polymorphic instance to use. To get the frequency response data from all input-output pairs, you must manually select the polymorphic instance to use.

Details  

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

 Place on the block diagram  Find on the Functions palette

CD Get Frequency Response Data (Input-Output Pair)

Frequency Response Data contains information about the frequency response of a model. Refer to the Details section for more information about the frequency response data.
Frequency is the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain contains data about the frequency response of the real part of the elements in the matrix H(w).
Phase/Imaginary/Open-Loop Phase contains data about the frequency response of the imaginary part of the elements in the matrix H(w).
Input determines the index number of each input for which you want to obtain data.
Output determines the index number of each output for which you want to obtain data.
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.
Frequency returns the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain returns the magnitude or real part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Magnitude/Real/Open-Loop Gain returns the magnitude of the response. For the CD Nyquist VI, Magnitude/Real/Open-Loop Gain returns the real part of the response.
Phase/Imaginary/Open-Loop Phase returns the phase or imaginary part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Phase/Imaginary/Open-Loop Phase returns the phase of the response. For the CD Nyquist VI, Phase/Imaginary/Open-Loop Phase returns the imaginary part of the response.
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.
Type of Response Data returns the type of response data.

0bode-magnitude
1bode-phase
2nichols
3nyquist
4singular values (default)
5step
6impulse
7initial
8simulation

CD Get Frequency Response Data (Input-Output List)

Frequency Response Data contains information about the frequency response of a model. Refer to the Details section for more information about the frequency response data.
Frequency is the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain contains data about the frequency response of the real part of the elements in the matrix H(w).
Phase/Imaginary/Open-Loop Phase contains data about the frequency response of the imaginary part of the elements in the matrix H(w).
Inputs specifies a list of index numbers of the inputs for which you want to obtain data. The index is zero-based.
Outputs specifies a list of index numbers of the outputs for which you want to obtain data.
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.
Frequency returns the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain returns the magnitude or real part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Magnitude/Real/Open-Loop Gain returns the magnitude of the response. For the CD Nyquist VI, Magnitude/Real/Open-Loop Gain returns the real part of the response.
Phase/Imaginary/Open-Loop Phase returns the phase or imaginary part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Phase/Imaginary/Open-Loop Phase returns the phase of the response. For the CD Nyquist VI, Phase/Imaginary/Open-Loop Phase returns the imaginary part of the response.
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.
Type of Response Data returns the type of response data.

0bode-magnitude
1bode-phase
2nichols
3nyquist
4singular values (default)
5step
6impulse
7initial
8simulation

CD Get Frequency Response Data (All Input-Output)

Frequency Response Data contains information about the frequency response of a model. Refer to the Details section for more information about the frequency response data.
Frequency is the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain contains data about the frequency response of the real part of the elements in the matrix H(w).
Phase/Imaginary/Open-Loop Phase contains data about the frequency response of the imaginary part of the elements in the matrix H(w).
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.
Frequency returns the frequency response vector at which this VI plots the real versus imaginary parts of the transfer function H(w).
Magnitude/Real/Open-Loop Gain returns the magnitude or real part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Magnitude/Real/Open-Loop Gain returns the magnitude of the response. For the CD Nyquist VI, Magnitude/Real/Open-Loop Gain returns the real part of the response. Refer to the Details section for more information about the frequency response data.
Phase/Imaginary/Open-Loop Phase returns the phase or imaginary part of the transfer function H(w). For the CD All Margins, CD Bode, and CD Nichols VIs, Phase/Imaginary/Open-Loop Phase returns the phase of the response. For the CD Nyquist VI, Phase/Imaginary/Open-Loop Phase returns the imaginary part of the response. Refer to the Details section for more information about the frequency response data.
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.
Type of Response Data returns the type of response data.

0bode-magnitude
1bode-phase
2nichols
3nyquist
4singular values (default)
5step
6impulse
7initial
8simulation

CD Get Frequency Response Data Details

Frequency Response Data

The Frequency Response Data data type contains information about the frequency response of all the input-output pairs in the model. You can use the CD Get Frequency Response VI to customize how you want to view this information. The following explanation describes how to view and understand the frequency response data.

The Frequency is an array of frequencies this VI records at a certain interval. The Magnitude/Real/Open-Loop Gain and Phase/Imaginary/Open-Loop Phase arrays are three-dimensional arrays with three index displays. The first index display is the index number of the inputs. The third index display is the index number of the outputs. The data this VI displays in Magnitude/Real/Open-Loop Gain and Phase/Imaginary/Open-Loop Phase depends on the input-output pair these two index displays specify. The second index display is the index number of the response data. This index display is relative to the index display of the Frequency. The indexes are zero-based.

For example, consider the following Frequency Response Data.

If you want to know the frequency response at w = 1.10, set the index displays for Magnitude/Real/Open-Loop Gain and Phase/Imaginary/Open-Loop Phase equal to the index display for Frequency. In this example, the index display is equal to 50. The Magnitude/Real/Open-Loop Gain indicates that for the input-output pair (1, 0), the magnitude at that frequency is –1.43. The Phase/Imaginary/Open-Loop Phase indicates that for the input-output pair (1, 0), the phase is –241.22.

The Frequency Response Data displays the frequency response in terms of magnitude and phase when you use the CD Bode VI and CD Nichols VI to analyze the frequency response. The Frequency Response Data displays the frequency response in terms of real and imaginary parts when you use the CD Nyquist VI to analyze the frequency response.

Delay Support

This VI supports delays. Refer to the LabVIEW Control Design User Manual for more information about delays.