SI Estimate User-Defined Model VI

SI Estimate User-Defined Model (SISO Waveform)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal specifies the input waveform of the stimulus signal.
	response signal specifies the input waveform of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model (SISO Array)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal specifies the input array of the stimulus signal.
	response signal specifies the input array of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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 is the signal sampling rate in hertz. The value of sampling rate must be greater than 0.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model (MISO Waveform)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal is the input waveform array of the stimulus signal.
	response signal specifies the input waveform of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model (MISO Array)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal is the input array of the stimulus signal.
	response signal specifies the input array of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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 is the signal sampling rate in hertz. The value of sampling rate must be greater than 0.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model (MIMO Waveform)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal is the input waveform array of the stimulus signal.
	response signal is the input waveform array of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model (MIMO Array)

	data specifies the static data that the user-defined function needs at run time.
	user defined model is a file path to the VI that defines the model to be estimated. Use the model template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb to create a VI from a template.
	stimulus signal is the input array of the stimulus signal.
	response signal is the input array of the response signal.
	variables specifies 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. initial guess is the initial guess of the numeric value this VI associates with the variable. upper limit specifies the upper limit to use to search for the optimal value of each variable. The default is Inf. lower limit specifies the lower limit to use to search for the optimal value of each variable. The default is -Inf.
	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 is the signal sampling rate in hertz. The value of sampling rate must be greater than 0.
	termination describes the stopping conditions for the model estimation. max iterations is the largest number of iterations of the optimization routine. If the number of iterations exceeds max iterations, the estimation terminates. tolerance is the relative change between consecutive cost function values. If the difference between the current cost function value and the next cost function value is less than tolerance, LabVIEW accepts the current value and terminates the estimation.
	response obtained by estimated model returns the simulated response signal from the estimated model.
	optimized variables returns the name and optimized value of each variable. 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.
	number of function calls returns the number of times that LabVIEW calls the user-defined model VI.
	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 User-Defined Model Details

The SI Estimate User-Defined Model VI estimates a user-defined model using the Gauss-Newton algorithm to optimize the parameters. This VI requires a predefined model to optimize the parameters. You can use the template in the labview\vi.lib\addons\System Identification\User-Defined Model Templates.llb directory to create a predefined model. If you create a predefined model from scratch, make sure your model has exactly the same connector pane as that in the template.

The predefined model can be either a linear or nonlinear model. The LabVIEW System Identification Toolkit provides two common nonlinear models, the Weiner model and the Hammerstein model, as examples of defining nonlinear models.

Examples

Refer to the following VIs for examples of using the SI Estimate User-Defined Model VI:

• Estimate Partially Known State-Space Model VI: labview\examples\System Identification\Getting Started\User Defined Model.llb

   Open example  Browse related examples

• Parameterize Nonlinear Differential Equation VI: labview\examples\System Identification\Getting Started\User Defined Model.llb

   Open example  Browse related examples

• Estimate Hammerstein-Wiener Model VI: labview\examples\System Identification\Getting Started\User Defined Model.llb

   Open example  Browse related examples