SI Draw Model VI

System Identification VIs

previous page next page

SI Draw Model VI

Owning Palette: Utilities VIs

Installed With: System Identification Toolkit

Displays model equations and the sampling rate in a picture indicator. You can use this VI to display the equations of a transfer function, state-space, zero-pole-gain, AR, ARX, ARMAX, output-error, Box-Jenkins, or general-linear model in a picture indicator according to the model representation you wire to the system model input.

Place on the block diagram

Find on the Functions palette

system model contains information about the model structure, nominal or estimated parameters, identification result, and so on. Use the Model Management VIs to retrieve the information system model contains.

Note You can use a customized system model probe to view model information that flows through system model wires when you debug a block diagram created with the System Identification VIs. Right-click a system model wire and select Custom Probe»SI System Model from the shortcut menu to use the system model probe.

origin specifies the position in the picture indicator where you want this VI to display the upper-left corner of the equation image. LabVIEW considers the upper-left position of the picture indicator to be the origin, (0,0), when determining the locations of the left and top coordinates.

	left specifies the number of pixels to the right of the origin that LabVIEW places the upper-left corner of the equation image. The default is 10.
	top specifies the number of pixels below the origin that LabVIEW places the upper-left corner of the equation image. The default is 8.

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.

display format for TF model specifies the format in which this VI displays transfer function equations. This VI ignores the display format for TF model if the system model is a not transfer function model.

0	Descending
1	Ascending (default)
2	Negative Power

display format for ZPK model specifies the format in which this VI displays zero-pole-gain equations. This VI ignores the display format for ZPK model if the system model is not a zero-pole-gain model.

0	Standard (default)
1	Engineering
2	Time Constant
3	Negative Power

model displays the model equations that the system model defines in a picture indicator.

size returns the size of the area in the picture control this VI uses to draw the model equations.

	width returns the width of the area in the picture control this VI uses to draw the model equations.
	height returns the height of the area in the picture control this VI uses to draw the model equations.

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.

previous page start next page