You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.6 Advanced Signal Processing Toolkit Help

Owning Palette: Modeling and Prediction VIs

Installed With: Advanced Signal Processing Toolkit

Estimates the modal parametric model of an input univariate or multivariate (vector) time series. The modal parameters include magnitude, phase, damping factor, and natural frequency. Wire data to the Xt input to determine the polymorphic instance to use or manually select the instance.

Details  Examples

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

Select an instance TSA Modal Parametric Modeling (waveform)TSA Modal Parametric Modeling (array)TSA Vector Modal Parametric Modeling (waveform)TSA Vector Modal Parametric Modeling (array)

TSA Modal Parametric Modeling (waveform)

	Xt specifies the input univariate time series.
	method specifies the method to use in estimating the frequency component of the input time series. 0 Prony (default)—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method also is called the Least-Square Complex Exponential method. 1 Matrix Pencil—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method is a modified Prony method with noise disturbances considered.
	model order specifies the model order. The value of model order must be at least twice the number of frequency components you want to estimate. The default is 4.
	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.
	noise subspace specifies the percentage of frequency components due to noise in the input time series. The default is 50. This option is available only when method is Matrix Pencil.
	frequency components returns information about the estimated frequency components. frequency returns the estimated frequency of the frequency component. damping factor returns the estimated damping factor of the frequency component. magnitude returns the estimated magnitude of the frequency component. phase returns the estimated phase of the frequency component.
	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.

TSA Modal Parametric Modeling (array)

	Xt specifies the input univariate time series.
	method specifies the method to use in estimating the frequency component of the input time series. 0 Prony (default)—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method also is called the Least-Square Complex Exponential method. 1 Matrix Pencil—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method is a modified Prony method with noise disturbances considered.
	model order specifies the model order. The value of model order must be at least twice the number of frequency components you want to estimate. The default is 4.
	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.
	noise subspace specifies the percentage of frequency components due to noise in the input time series. The default is 50. This option is available only when method is Matrix Pencil.
	frequency components returns information about the estimated frequency components. frequency returns the estimated frequency of the frequency component. damping factor returns the estimated damping factor of the frequency component. magnitude returns the estimated magnitude of the frequency component. phase returns the estimated phase of the frequency component.
	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.

TSA Vector Modal Parametric Modeling (waveform)

	Xt specifies the input multivariate (vector) time series.
	method specifies the method to use in estimating the frequency component of the input time series. 0 Prony (default)—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method also is called the Least-Square Complex Exponential method. 1 Matrix Pencil—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method is a modified Prony method with noise disturbances considered.
	model order specifies the model order. The value of model order must be at least twice the number of frequency components you want to estimate. The default is 4.
	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.
	noise subspace specifies the percentage of frequency components due to noise in the input time series. The default is 50. This option is available only when method is Matrix Pencil.
	frequency components returns information about the estimated frequency components. frequency returns the estimated frequency of the frequency component. damping factor returns the estimated damping factor of the frequency component. magnitude returns the estimated magnitude of the frequency component. Each element of the array represents one channel series in Xt. phase returns the estimated phase of the frequency component. Each element of the array represents one channel series in Xt.
	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.

TSA Vector Modal Parametric Modeling (array)

	Xt specifies the input multivariate (vector) time series. Each column of the 2D array represents a vector at certain time.
	method specifies the method to use in estimating the frequency component of the input time series. 0 Prony (default)—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method also is called the Least-Square Complex Exponential method. 1 Matrix Pencil—Computes parameters of a modal parametric model by solving complex exponential equations in the lease-square sense. This method is a modified Prony method with noise disturbances considered.
	model order specifies the model order. The value of model order must be at least twice the number of frequency components you want to estimate. The default is 4.
	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.
	noise subspace specifies the percentage of frequency components due to noise in the input time series. The default is 50. This option is available only when method is Matrix Pencil.
	frequency components returns information about the estimated frequency components. frequency returns the estimated frequency of the frequency component. damping factor returns the estimated damping factor of the frequency component. magnitude returns the estimated magnitude of the frequency component. Each element of the array represents one channel series in Xt. phase returns the estimated phase of the frequency component. Each element of the array represents one channel series in Xt.
	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.

TSA Modal Parametric Modeling Details

For a univariate impulse response time series, this VI estimates the modal parametric model according to the following equation:

where h_t is the input univariate impulse response series, and n is the model order.

a_i denotes one of the complex amplitudes, which is defined as:

a_i = r_ie^jq

where r is magnitude, and q is phase.

S_i is one of the modal poles, which is defined as:

S_i = a + j2pf

where a is damping factor, and f is frequency.

For a multivariate impulse response time series, this VI estimates the modal parametric model according to the following equation:

where H_t is the input multivariate impulse response series. H_t is a k×1 vector with k variables that come from k sources. A_i is a k×1 complex amplitude vector with k variables. A_i^T=(a_1i,…,a_ki). S_i is one of the modal poles. n is the model order.

Refer to the univariate modal parametric model for the descriptions of a_ki in the vector A_i.

Reference:

Hua, Y., and T. K. Sarkar. 1990. "Matrix Pencil Method for Estimating Parameters of Exponentially Damped/Undamped Sinusoids in Noise." IEEE Transaction on Acoustic, Speech, and Signal Processing vol. 38.5: 814-824.

Examples

Refer to the following VIs for examples of using the TSA Modal Parametric Modeling VI:

• Modal Analysis of a Plate VI: labview\examples\Time Series Analysis\TSAApplications.llb
• Frequency Components VI: labview\examples\Time Series Analysis\TSAGettingStarted.llb