CD Bode VI

Control Design VI and Function

previous page next page
CD Bode VI

Owning Palette: Frequency Response VIs

Installed With: Control Design and Simulation Module

Produces the Bode magnitude and Bode phase plots of the system model on an XY graph. The data types you wire to the State-Space Model and Frequency Info inputs determine the polymorphic instance to use.

This VI converts state-space and zero-pole-gain models to transfer function models before calculating the frequency response.

Details  

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

 Place on the block diagram  Find on the Functions palette

CD Bode (Frequency Range, State-Space)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
State-Space Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Range contains the frequency information of the model.
Initial frequency is the minimum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Final frequency is the maximum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Minimum number of points is the minimum number of points this VI uses in calculating the frequency response and producing the plots. The default is 100 points.
Frequency Unit specifies the units of frequency, either in Hertz or radians/seconds, to use in calculating the frequency response and producing the plots.

0Hz
1rad/s (default)
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode (Frequency Range, Transfer Function)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Transfer Function Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Range contains the frequency information of the model.
Initial frequency is the minimum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Final frequency is the maximum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Minimum number of points is the minimum number of points this VI uses in calculating the frequency response and producing the plots. The default is 100 points.
Frequency Unit specifies the units of frequency, either in Hertz or radians/seconds, to use in calculating the frequency response and producing the plots.

0Hz
1rad/s (default)
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode (Frequency Range, Zero-Pole-Gain)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Zero-Pole-Gain Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Range contains the frequency information of the model.
Initial frequency is the minimum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Final frequency is the maximum frequency this VI uses in calculating the frequency response and producing the plots. The default is –1.
Minimum number of points is the minimum number of points this VI uses in calculating the frequency response and producing the plots. The default is 100 points.
Frequency Unit specifies the units of frequency, either in Hertz or radians/seconds, to use in calculating the frequency response and producing the plots.

0Hz
1rad/s (default)
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode (Frequency Vector, State-Space)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
State-Space Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Vector specifies information about the frequencies this VI uses to excite the model.
Frequency specifies the frequencies this VI uses to excite the model.
Frequency Unit specifies the unit of measurement of the Frequency array.

0Hz—Specifies that the frequency is measured in hertz.
1rad/s (default)—Specifies that the frequency is measured in radians per second.
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode (Frequency Vector, Transfer Function)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Transfer Function Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Vector specifies information about the frequencies this VI uses to excite the model.
Frequency specifies the frequencies this VI uses to excite the model.
Frequency Unit specifies the unit of measurement of the Frequency array.

0Hz—Specifies that the frequency is measured in hertz.
1rad/s (default)—Specifies that the frequency is measured in radians per second.
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode (Frequency Vector, Zero-Pole-Gain)

Phase Graph Reference is a reference to the Bode Phase plot on an XY graph. Phase Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Magnitude Graph Reference is a reference to the Bode Magnitude plot on an XY graph. Magnitude Graph Reference automatically configures the x-scale, y-scale, and legend properties. If you want to use the default settings or customize the settings for these properties, do not wire a value to this input.
Zero-Pole-Gain Model contains a mathematical representation of and information about the system of which this VI produces Bode plots.
Frequency Vector specifies information about the frequencies this VI uses to excite the model.
Frequency specifies the frequencies this VI uses to excite the model.
Frequency Unit specifies the unit of measurement of the Frequency array.

0Hz—Specifies that the frequency is measured in hertz.
1rad/s (default)—Specifies that the frequency is measured in radians per second.
Magnitude Scale specifies how to scale the magnitude of the frequency response.

0linear—Does not convert the magnitude of the frequency response to decibels.
1db (default)—Converts the magnitude of the frequency 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 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.
Plots Index specifies which input and which output to plot. If you do not specify the input #, this VI plots all the inputs.
input # is the index number of the specific input to the system. This VI displays the response to this input on the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
output # is the index number of the specific output of the system that this VI displays in the Bode Magnitude and Bode Phase plots on XY graphs. The index is zero-based.
Bode Magnitude is a plot on an XY graph that plots the linear or decibel magnitude of the given model against a set of frequencies. The Plots Index array determines the plots on this XY graph.
Bode Phase is a plot on an XY graph that plots the phase (in degrees) of the model against a set of frequency values. The Plots Index array determines the plots on this XY graph.
Bode Data returns information about the Bode plot. To access the Bode Data, use the CD Get Frequency Response Data VI.
Frequency is a 1D-array of frequency values at which this VI calculates the magnitude and phase.
Magnitude is a 3D-array. The ith column in the nth page of the array is the magnitude of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be magnitudes of transfer functions between outputs y0 and y1 and the first input u0.
Phase is a 3D-array. The ith column in the nth page of the array is the phase of the transfer function between the ith output and the nth input. For example, the first two columns of the 0th page will be the phase of transfer functions between outputs y0 and y1 and the first input u0.
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.
Frequency Info Out returns the frequency information of the model.

CD Bode Details

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

previous page start next page