SI Estimate General Linear Model VI

System Identification VIs

previous page next page
SI Estimate General Linear Model VI

Owning Palette: Polynomial Model Estimation VIs

Installed With: System Identification Toolkit

Estimates the parameters of a general-linear (GL) model for an unknown system. Wire data to the stimulus signal and response signal inputs to determine the polymorphic instance to use or manually select the instance.

Example

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

 Place on the block diagram  Find on the Functions palette

SI Estimate General Linear Model (SISO Waveform)

stimulus signal specifies the input waveform of the stimulus signal.
response signal is the input waveform of the response signal. The length of response signal must be greater than [max(A order + D order, B order + (delay – 1) + D order, C order + F order) + (A order + B order + F order + C order + D order)].
orders of GL model specifies the orders and delay of the general-linear (GL) model.
A order specifies the order of the A coefficients of the system model. The value of A order must be greater than or equal to 0.
B order specifies the order of the B coefficients of the system model. The value of B order must be greater than or equal to 1.
F order specifies the order of the F coefficients of the system model. The value of F order must be greater than or equal to 0.
C order specifies the order of the C coefficients of the system model. The value of C order must be greater than or equal to 0.
D order specifies the order of the D coefficients of the model. The value of D order must be greater than or equal to 0.
delay specifies the delay k of the system model. The value of delay must be greater than or equal to 0.
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.
system model out returns 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 out 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.
coefficients of GL model returns the coefficients of the general-linear (GL) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
noise returns the disturbance e(t) in the estimated system 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.

SI Estimate General Linear Model (SISO Array)

stimulus signal specifies the input array of the stimulus signal.
response signal is the input array of the response signal. The length of response signal must be greater than [max(A order + D order, B order + (delay – 1) + D order, C order + F order) + (A order + B order + F order + C order + D order)].
orders of GL model specifies the orders and delay of the general-linear (GL) model.
A order specifies the order of the A coefficients of the system model. The value of A order must be greater than or equal to 0.
B order specifies the order of the B coefficients of the system model. The value of B order must be greater than or equal to 1.
F order specifies the order of the F coefficients of the system model. The value of F order must be greater than or equal to 0.
C order specifies the order of the C coefficients of the system model. The value of C order must be greater than or equal to 0.
D order specifies the order of the D coefficients of the model. The value of D order must be greater than or equal to 0.
delay specifies the delay k of the system model. The value of delay must be greater than or equal to 0.
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 frequency in hertz. The value of sampling rate must be greater than 0. The default is 1.
system model out returns 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 out 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.
coefficients of GL model returns the coefficients of the general-linear (GL) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
noise returns the disturbance e(t) in the estimated system 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.

SI Estimate General Linear Model (MISO Waveform)

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 is the input waveform of the response signal. The length of response signal must be greater than [max(A order + D order, max(B orders + (delays – 1)) + D order, C order + max(F orders)) + (A order + sum(B orders) + sum(F orders) + C order + D order)].
orders of GL model specifies the orders and delay of the general-linear (GL) model.
A order specifies the order of the A coefficients of the system model. The value of A order must be greater than or equal to 0.
B orders specifies the orders of the B coefficients of the model. The value of B orders must be greater than or equal to 1.
F orders specifies the orders of the F coefficients of the model. The value of F orders must be greater than or equal to 0.
C order specifies the order of the C coefficients of the system model. The value of C order must be greater than or equal to 0.
D order specifies the order of the D coefficients of the system model. The value of D order must be greater than or equal to 0.
delays specifies the delays k of the model. The value of delays must be greater than or equal to 0.
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.
system model out returns 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 out 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.
coefficients of GL model returns the coefficients of the general-linear (GL) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
noise returns the disturbance e(t) in the estimated system 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.

SI Estimate General Linear Model (MISO Array)

stimulus signals specifies the input array of the stimulus signals. Each row in the array is one stimulus signal.
response signal is the input array of the response signal. The length of response signal must be greater than [max(A order + D order, max(B orders + (delays – 1)) + D order, C order + max(F orders)) + (A order + sum(B orders) + sum(F orders) + C order + D order)].
orders of GL model specifies the orders and delay of the general-linear (GL) model.
A order specifies the order of the A coefficients of the system model. The value of A order must be greater than or equal to 0.
B orders specifies the orders of the B coefficients of the model. The value of B orders must be greater than or equal to 1.
F orders specifies the orders of the F coefficients of the model. The value of F orders must be greater than or equal to 0.
C order specifies the order of the C coefficients of the system model. The value of C order must be greater than or equal to 0.
D order specifies the order of the D coefficients of the system model. The value of D order must be greater than or equal to 0.
delays specifies the delays k of the model. The value of delays must be greater than or equal to 0.
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 frequency in hertz. The value of sampling rate must be greater than 0. The default is 1.
system model out returns 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 out 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.
coefficients of GL model returns the coefficients of the general-linear (GL) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
noise returns the disturbance e(t) in the estimated system 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.

Example

Refer to the Estimate Polynomial Models VI in the labview\examples\System Identification\Getting Started\Parametric Estimation.llb for an example of using the SI Estimate General Linear Model VI.

 Open example  Browse related examples

previous page start next page