SI Model Residual Analysis VI

SI Model Residual Analysis (SISO Waveform)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signal specifies the input waveform of the stimulus signal.
	response signal specifies the input waveform of the response signal.
	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.
	confidence level of autocorrelation returns the confidence level of autocorrelation. The values of autocorrelation between plus and minus confidence level of autocorrelation are insignificant, and you can consider them to be equal to 0.
	prediction error returns the waveform of the one-step-ahead prediction error of the system response.
	autocorrelation returns the autocorrelation of prediction error. autocorrelation and cross correlation provide the measure of the quality of the estimated model.
	cross correlation returns the cross correlation of prediction error and stimulus signal. autocorrelation and cross correlation provide the measure of the quality of the estimated model.
	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.
	confidence level of cross correlation returns the confidence level of cross correlation. The values of cross correlation between plus and minus confidence level of cross correlation are insignificant, and you can consider them to be equal to 0.

SI Model Residual Analysis (SISO Array)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signal specifies the input array of the stimulus signal.
	response signal specifies the input array of the response signal.
	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.
	sampling rate specifies the sampling rate of the input signals. sampling rate must equal the sampling rate used to estimate the system model.
	confidence level of autocorrelation returns the confidence level of autocorrelation. The values of autocorrelation between plus and minus confidence level of autocorrelation are insignificant, and you can consider them to be equal to 0.
	prediction error returns the one-step-ahead prediction error of the system response.
	autocorrelation returns the autocorrelation of prediction error. autocorrelation and cross correlation provide the measure of the quality of the estimated model.
	cross correlation returns the cross correlation of prediction error and stimulus signal. autocorrelation and cross correlation provide the measure of the quality of the estimated model.
	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.
	confidence level of cross correlation returns the confidence level of cross correlation. The values of cross correlation between plus and minus confidence level of cross correlation are insignificant, and you can consider them to be equal to 0.

SI Model Residual Analysis (MISO Waveform)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signals specifies the input waveform array of the stimulus signals. Each element of the array is the waveform of one stimulus signal.
	response signal specifies the input waveform of the response signal.
	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.
	confidence level of autocorrelation returns the confidence level of autocorrelation. The values of autocorrelation between plus and minus confidence level of autocorrelation are insignificant, and you can consider them to be equal to 0.
	prediction error returns the waveform of the one-step-ahead prediction error of the system response.
	autocorrelation returns the autocorrelation of prediction error. autocorrelation and cross correlations provide the measure of the quality of the estimated model.
	cross correlations returns the cross correlations of prediction error and stimulus signals. Each element of the waveform array is the cross correlation between one input and the prediction error of the output. autocorrelation and cross correlations provide the measure of the quality of the estimated model.
	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.
	confidence levels of cross correlations returns the confidence levels of cross correlations. The values of cross correlations between plus and minus confidence levels of cross correlations are insignificant, and you can consider them to be equal to 0.

SI Model Residual Analysis (MISO Array)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signals specifies the input array of the stimulus signals. Each row in the array is one stimulus signal.
	response signal specifies the input array of the response signal.
	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.
	sampling rate specifies the sampling rate of the input signals. sampling rate must equal the sampling rate used to estimate the system model.
	confidence level of autocorrelation returns the confidence level of autocorrelation. The values of autocorrelation between plus and minus confidence level of autocorrelation are insignificant, and you can consider them to be equal to 0.
	prediction error returns the one-step-ahead prediction error of the system response.
	autocorrelation returns the autocorrelation of prediction error. autocorrelation and cross correlations provide the measure of the quality of the estimated model.
	cross correlations returns the cross correlations of prediction error and stimulus signals. Each row in the array is the cross correlation between one input and the prediction error of the output. autocorrelation and cross correlations provide the measure of the quality of the estimated model.
	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.
	confidence levels of cross correlations returns the confidence levels of cross correlations. The values of cross correlations between plus and minus confidence levels of cross correlations are insignificant, and you can consider them to be equal to 0.

SI Model Residual Analysis (MIMO Waveform)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signals specifies the input waveform array of the stimulus signals. Each element of the array is the waveform of one stimulus signal.
	response signals specifies the input waveform array of the response signals. Each element of the array is the waveform of one response signal.
	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.
	confidence levels of autocorrelations returns the confidence levels of autocorrelations. Each element of the array is the confidence level of one autocorrelation. The values of autocorrelations between plus and minus confidence levels of autocorrelations are insignificant, and you can consider them to be equal to 0.
	prediction errors returns the one-step-ahead prediction errors of the system response. Each element of the waveform array is the prediction error of one response.
	autocorrelations returns the autocorrelations of prediction errors. Each element of the array is the autocorrelation of the prediction error for one output. autocorrelations and cross correlations provide the measure of the quality of the estimated model.
	cross correlations returns the cross correlations of prediction errors and stimulus signals. autocorrelations and cross correlations provide the measure of the quality of the estimated model. The element of the ith row and jth column in the array is the cross correlation between the jth input and the prediction error of the ith output.
	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.
	confidence levels of cross correlations returns the confidence levels of cross correlations. Each element of the array is the confidence level of one cross correlation. The element in the ith row and jth column of confidence levels of cross correlations is the confidence level of the cross correlation between the jth input and the prediction error of the ith output. The values of cross correlations between plus and minus confidence levels of cross correlations are insignificant, and you can consider them to be equal to 0.

SI Model Residual Analysis (MIMO Array)

	system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains. Note  You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.
	stimulus signals specifies the input array of the stimulus signals. Each row in the array is one stimulus signal.
	response signals specifies the input array of the response signals. Each row in the array is one response signal.
	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.
	sampling rate specifies the sampling rate of the input signals. sampling rate must equal the sampling rate used to estimate the system model.
	confidence levels of autocorrelations returns the confidence levels of autocorrelations. Each element of the array is the confidence level of one autocorrelation. The values of autocorrelations between plus and minus confidence levels of autocorrelations are insignificant, and you can consider them to be equal to 0.
	prediction errors returns the one-step-ahead prediction errors of the system response. Each row in the array is the prediction error for one output.
	autocorrelations returns the autocorrelations of prediction errors. Each row in the array is the autocorrelation of the prediction error for one output. autocorrelations and cross correlations provide the measure of the quality of the estimated model.
	cross correlations returns the cross correlations of prediction errors and stimulus signals. autocorrelations and cross correlations provide the measure of the quality of the estimated model. The 1D subarray of cross correlations with the ith first index and jth second index is the cross correlation between the jth input and the prediction error of the ith output.
	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.
	confidence levels of cross correlations returns the confidence levels of cross correlations. Each element of the array is the confidence level of one cross correlation. The element in the ith row and jth column of confidence levels of cross correlations is the confidence level of the cross correlation between the jth input and the prediction error of the ith output. The values of cross correlations between plus and minus confidence levels of cross correlations are insignificant, and you can consider them to be equal to 0.

Examples

Refer to the following VIs for examples of using the SI Model Residual Analysis VI:

• Residual Analysis VI: labview\examples\System Identification\Getting Started\General.llb

   Open example  Browse related examples

• Flexible Arm VI: labview\examples\System Identification\Industry Applications\Mechanical Systems.llb

   Open example  Browse related examples