SI Estimate Partially Known State-Space Model VI

System Identification VIs

SI Estimate Partially Known State-Space Model VI

Owning Palette: Partially Known Model Estimation VIs

Installed With: System Identification Toolkit

Estimates a state-space model for a partially known system. Use the SI Create Partially Known State-Space Model VI to create the model you want to estimate. Wire data to the stimulus signal and response signal inputs to determine the polymorphic instance to use or manually select the instance.

Details  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 Partially Known State-Space Model (SISO Waveform)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
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.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model (SISO Array)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
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 frequency in hertz. For continuous models, sampling rate is used to convert the continuous system to a discrete system before this VI simulates the output. For discrete models, sampling rate is the sampling rate of the system.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model (MISO Waveform)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
stimulus signals is the input waveform array of the stimulus signals. Each element of the waveform 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.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model (MISO Array)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
stimulus signals is the input array of the stimulus signals. Each element 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 frequency in hertz. For continuous models, sampling rate is used to convert the continuous system to a discrete system before this VI simulates the output. For discrete models, sampling rate is the sampling rate of the system.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model (MIMO Waveform)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
stimulus signals is the input waveform array of the stimulus signals. Each element of the waveform 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.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model (MIMO Array)

system model in contains information for the mathematical model of a partially known system. The information includes the model type, model orders, constraints on each of the model coefficients, input and output names of the system, and so on.
stimulus signals is the input array of the stimulus signals. Each element in the array is one stimulus signal.
response signals is the input array of the response signals. Each element 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 frequency in hertz. For continuous models, sampling rate is used to convert the continuous system to a discrete system before this VI simulates the output. For discrete models, sampling rate is the sampling rate of the system.
Kalman gain returns the Kalman gain of the state-space model.
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 state-space model returns the coefficients of the state-space (SS) model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
C returns the C coefficients of the system model.
D returns the D coefficients of the system model.
variables returns the names and values of the variables in the state-space model.
name is a name this VI uses to define the variable of the system model. Variable names can be a combination of letters and numbers. A variable name that begins with a capital letter E can produce unpredictable errors if parts of the original string represent numbers like 1E–2. Avoid variable names beginning with E in such cases.
value returns the estimated value of each variable.
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.
initial states returns the initial states of the state-space model.

SI Estimate Partially Known State-Space Model Details

The SI Estimate Partially Known State-Space Model VI estimates a continuous or discrete state-space model for a partially known system, depending on the system model input. This VI accepts only models the SI Create Partially Known State-Space Model VI creates. When estimating discrete models from array data, you must set sampling rate to the same sampling rate you set when you created the model using the SI Create Partially Known State-Space Model VI. When estimating continuous models from array data, you must set the sampling rate for the VI to convert continuous systems to discrete systems. This VI simulates the output and then compares the simulated output with the response signal to optimize estimation.

Example

Refer to the Continuous State-Space Model of an RLC Circuit VI in the labview\examples\System Identification\Getting Started\Grey-Box Model.llb for an example of using the SI Estimate Partially Known State-Space Model VI.

 Open example  Browse related examples