LabVIEW Advanced Signal Processing Toolkit API Reference

SI Get Coefficients from System Model VI

  • Updated2023-02-21
  • 36 minute(s) read

SI Get Coefficients from System Model VI

Owning Palette: Model Management VIs

Requires: Advanced Signal Processing Toolkit or Control Design and Simulation Module

Returns the coefficients of system model and the standard deviation and covariance of the coefficients. Use the SI Set Coefficients to System Model VI to apply coefficients and the standard deviation and covariance of the coefficients to system model. You must manually select the polymorphic instance to use.

Example

SI Get Coefficients from AR Model

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients returns the coefficients of the AR model.
std deviations returns the standard deviations of coefficients. Each value in std deviations is the standard deviation of the corresponding coefficient in coefficients.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ARX Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of ARX model returns the coefficients of the ARX model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
std deviations returns the standard deviations of coefficients of ARX model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ARX Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of ARX model returns the coefficients of the ARX model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
std deviations returns the standard deviations of coefficients of ARX model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ARX Model (MIMO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of ARX model returns the coefficients of the ARX model.
A returns the A coefficients of the system model.
B returns the B coefficients of the system model.
std deviations returns the standard deviations of coefficients of ARX model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ARMAX Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of ARMAX model returns the coefficients of the ARMAX 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.
std deviations returns the standard deviations of coefficients of ARMAX model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ARMAX Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of ARMAX model returns the coefficients of the ARMAX 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.
std deviations returns the standard deviations of coefficients of ARMAX model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from OE Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of OE model returns the coefficients of the output-error (OE) model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
std deviations returns the standard deviations of coefficients of OE model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from OE Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of OE model returns the coefficients of the output-error (OE) model.
B returns the B coefficients of the system model.
F returns the F coefficients of the system model.
std deviations returns the standard deviations of coefficients of OE model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from BJ Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of BJ model returns the coefficients of the Box-Jenkins (BJ) 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.
std deviations returns the standard deviations of coefficients of BJ model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from BJ Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of BJ model returns the coefficients of the Box-Jenkins (BJ) 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.
std deviations returns the standard deviations of coefficients of BJ model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from GL Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
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.
std deviations returns the standard deviations of coefficients of GL model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from GL Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
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.
std deviations returns the standard deviations of coefficients of GL model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
F std dev returns the standard deviations of the F coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
covariance returns the covariance of the values of the system model coefficients.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from SS Model (SISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Kalman gain returns the Kalman gain of the state-space (SS) model. The number of rows in Kalman gain equals the number of states in the state-space model.
coefficients of state-space model returns the coefficients of the state-space model.
A returns the state matrix of the system model.
B returns the input matrix of the system model.
C returns the output matrix of the system model.
D returns the direct transmission matrix of the system model.
std deviations returns the standard deviations of coefficients of state-space model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviation of the D coefficient of the system model.
error out contains error information. This output provides standard error out functionality.
initial states returns the initial states of the state-space model. The length of initial states equals the number of states of the system model.

SI Get Coefficients from SS Model (MISO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Kalman gain returns the Kalman gain of the state-space (SS) model. The number of rows in Kalman gain equals the number of states in the state-space model.
coefficients of state-space model returns the coefficients of the state-space model.
A returns the state matrix of the system model.
B returns the input matrix of the system model.
C returns the output matrix of the system model.
D returns the direct transmission matrix of the system model.
std deviations returns the standard deviations of coefficients of state-space model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
error out contains error information. This output provides standard error out functionality.
initial states returns the initial states of the state-space model. The length of initial states equals the number of states of the system model.

SI Get Coefficients from SS Model (MIMO)

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Kalman gain returns the Kalman gain of the state-space (SS) model. The number of rows in Kalman gain equals the number of states in the state-space model.
coefficients of state-space model returns the coefficients of the state-space model.
A returns the state matrix of the system model.
B returns the input matrix of the system model.
C returns the output matrix of the system model.
D returns the direct transmission matrix of the system model.
std deviations returns the standard deviations of coefficients of state-space model.
A std dev returns the standard deviations of the A coefficients of the system model.
B std dev returns the standard deviations of the B coefficients of the system model.
C std dev returns the standard deviations of the C coefficients of the system model.
D std dev returns the standard deviations of the D coefficients of the system model.
error out contains error information. This output provides standard error out functionality.
initial states returns the initial states of the state-space model. The length of initial states equals the number of states of the system model.

SI Get Coefficients from TF Model (SISO)

input type specifies whether to obtain the coefficients of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the numerator and denominator coefficients of G(z), the transfer function between the stimulus and the response. G(z) is defined as the stimulus transfer function.
1noise—Obtains the numerator and denominator coefficients of H(z), the transfer function between the noise and the response. H(z) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of transfer function model returns the coefficients of the transfer function model.
numerator returns the numerator coefficients of the transfer function model.
denominator returns the denominator coefficients of the transfer function model.
std deviations returns the standard deviations of coefficients of transfer function model.
numerator std dev returns the standard deviation of the numerator coefficients of the stimulus or noise transfer function.
denominator std dev returns the standard deviation of the denominator coefficients of the stimulus or noise transfer function.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from TF Model (MISO)

input type specifies whether to obtain the coefficients of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the numerator and denominator coefficients of G(z), the transfer function between the stimulus and the response. G(z) is defined as the stimulus transfer function.
1noise—Obtains the numerator and denominator coefficients of H(z), the transfer function between the noise and the response. H(z) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of transfer function model returns the coefficients of the transfer function (TF) model.
numerator returns the numerator coefficients of the transfer function model.
denominator returns the denominator coefficients of the transfer function model.
std deviations returns the standard deviations of coefficients of transfer function model.
numerator std dev returns the standard deviation of the numerator coefficients of the stimulus or noise transfer function.
denominator std dev returns the standard deviation of the denominator coefficients of the stimulus or noise transfer function.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from TF Model (MIMO)

input type specifies whether to obtain the coefficients of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the numerator and denominator coefficients of G(z), the transfer function between the stimulus and the response. G(z) is defined as the stimulus transfer function.
1noise—Obtains the numerator and denominator coefficients of H(z), the transfer function between the noise and the response. H(z) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of transfer function model returns the coefficients of the transfer function (TF) model.
numerator returns the numerator coefficients of the transfer function model.
denominator returns the denominator coefficients of the transfer function model.
std deviations returns the standard deviations of coefficients of transfer function model.
numerator std dev returns the standard deviation of the numerator coefficients of the stimulus or noise transfer function.
denominator std dev returns the standard deviation of the denominator coefficients of the stimulus or noise transfer function.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ZPK Model (SISO)

input type specifies whether to obtain the poles and zeros of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the poles and zeros of G(q), the transfer function between the stimulus and the response. G(q) is defined as the stimulus transfer function.
1noise—Obtains the poles and zeros of H(q), the transfer function between the noise and the response. H(q) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of zero-pole-gain model returns the coefficients and gain of the zero-pole-gain (ZPK) model.
zeros returns the zeros of the zero-pole-gain model.
poles returns the poles of the zero-pole-gain model.
gain returns the gain of the zero-pole-gain model.
std deviations returns the standard deviations of coefficients of zero-pole-gain model.
zeros std dev returns the standard deviations of the zeros of the zero-pole-gain model.
poles std dev returns the standard deviations of the poles of the zero-pole-gain model.
gain std dev returns the standard deviation of the gain of the zero-pole-gain model.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ZPK Model (MISO)

input type specifies whether to obtain the poles and zeros of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the poles and zeros of G(q), the transfer function between the stimulus and the response. G(q) is defined as the stimulus transfer function.
1noise—Obtains the poles and zeros of H(q), the transfer function between the noise and the response. H(q) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of zero-pole-gain model returns the coefficients and gain of the zero-pole-gain (ZPK) model.
zeros returns the zeros of the zero-pole-gain model.
poles returns the poles of the zero-pole-gain model.
gain returns the gain of the zero-pole-gain model.
std deviations returns the standard deviations of coefficients of zero-pole-gain model.
zeros std dev returns the standard deviations of the zeros of the zero-pole-gain model.
poles std dev returns the standard deviations of the poles of the zero-pole-gain model.
gain std dev returns the standard deviation of the gain of the zero-pole-gain model.
error out contains error information. This output provides standard error out functionality.

SI Get Coefficients from ZPK Model (MIMO)

input type specifies whether to obtain the poles and zeros of the transfer function between the stimulus and the response of the system model or of the transfer function between the noise and the response of the system model.

0stimulus (default)—Obtains the poles and zeros of G(q), the transfer function between the stimulus and the response. G(q) is defined as the stimulus transfer function.
1noise—Obtains the poles and zeros of H(q), the transfer function between the noise and the response. H(q) is defined as the noise transfer function.
system model contains information about the model structure, nominal or estimated parameters, identification result, and so on.
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.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
coefficients of zero-pole-gain model returns the coefficients and gain of the zero-pole-gain (ZPK) model.
zeros returns the zeros of the zero-pole-gain model.
poles returns the poles of the zero-pole-gain model.
gain returns the gain of the zero-pole-gain model.
std deviations returns the standard deviations of coefficients of zero-pole-gain model.
zeros std dev returns the standard deviations of the zeros of the zero-pole-gain model.
poles std dev returns the standard deviations of the poles of the zero-pole-gain model.
gain std dev returns the standard deviation of the gain of the zero-pole-gain model.
error out contains error information. This output provides standard error out functionality.

Example

Refer to the Read Information from Model VI in the labview\examples\System Identification\Getting Started\General.llb for an example of using the SI Get Coefficients from System Model VI.

Log in to get a better experience