documentation.HELP! Control Design VI and Function Documentation

CD Singular Values VI

Control Design VI and Function

previous page next page

CD Singular Values VI

Owning Palette: Frequency Response VIs

Installed With: Control Design and Simulation Module

Calculates the singular values of the frequency response of the input model. The data types you wire to the State-Space Model and Frequency Info inputs determine the polymorphic instance to use.

This VI converts transfer function and zero-pole-gain models into state-space models before determining the singular values.

Details  

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

Select an instance CD Singular Values (Frequency Range, State-Space)CD Singular Values (Frequency Range, Transfer Function)CD Singular Values (Frequency Range, Zero-Pole-Gain)CD Singular Values (Frequency Vector, State-Space)CD Singular Values (Frequency Vector, Transfer Function)CD Singular Values (Frequency Vector, Zero-Pole-Gain)

Place on the block diagram

Find on the Functions palette

CD Singular Values (Frequency Range, State-Space)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz 1 rad/s (default)
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values (Frequency Range, Transfer Function)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz 1 rad/s (default)
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values (Frequency Range, Zero-Pole-Gain)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz 1 rad/s (default)
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values (Frequency Vector, State-Space)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz—Specifies that the frequency is measured in hertz. 1 rad/s (default)—Specifies that the frequency is measured in radians per second.
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values (Frequency Vector, Transfer Function)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz—Specifies that the frequency is measured in hertz. 1 rad/s (default)—Specifies that the frequency is measured in radians per second.
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values (Frequency Vector, Zero-Pole-Gain)

	Singular Values Plot Reference is a reference to the Singular Values Plot. Singular Values Plot Reference 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 for which this VI determines the frequency response singular values.
	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. 0 Hz—Specifies that the frequency is measured in hertz. 1 rad/s (default)—Specifies that the frequency is measured in radians per second.
	Type specifies what type of singular value decomposition to perform. 0 H (default)—Calculates the singular value decomposition of H 1 I+H—Calculates the singular value decomposition of I+H 2 inverse(H)—Calculates the singular value decomposition of H-1 3 I + inverse(H)—Calculates the singular value decomposition of I+H-1
	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.
	Singular Values Plot plots the singular values (in decibels) of the frequency response of the system against a set of frequencies.
	Singular Values Data returns information about the singular values data. To access the Singular Values Data, use the CD Get Frequency Response Data VI. Frequency is a 1D-array of frequency values at which this VI determines the singular values. Singular Values is a 2D-array. The ith column of this array contains the data for the ith singular value as a function of frequency.
	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 Singular Values Details

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

previous page start next page

Get in touch

Submit feedback about this site to:

• [email protected]