zpkinfo (MathScript RT Module Function)
- Updated2023-03-14
- 2 minute(s) read
zpkinfo (MathScript RT Module Function)
Owning Class: info
Requires: Control Design and Simulation Module and MathScript RT Module
Syntax
[z, p, K, Ts] = zpkinfo(SysInZPK)
[z, p, K, delay, Ts] = zpkinfo(SysInZPK)
[z, p, K, Ts] = zpkinfo(SysInZPK, iy, iu)
[z, p, K, delay, Ts] = zpkinfo(SysInZPK, iy, iu)
Legacy Name: zpkdata
Description
Returns information about a zero-pole-gain system model.
Inputs
| Name | Description |
|---|---|
| SysInZPK | Specifies a linear time-invariant (LTI) model in zero-pole-gain form. |
| iy | Specifies the index number of a model output. The default value is 1. iy is an integer scalar. |
| iu | Specifies the index number of a model input. iu is an integer scalar. |
Outputs
| Name | Description |
|---|---|
| z | Returns the locations of the zeros of the SysInZPK model. z is a complex vector. |
| p | Returns the locations of the poles of the SysInZPK model. p is a complex vector. |
| K | Returns the gain of the SysInZPK model. K is a real scalar or real matrix, depending on the number of inputs and outputs of the SysInZPK model. |
| delay | Returns the total delay present in the SysInZPK model, in seconds. |
| Ts | Returns the sampling time of the SysInZPK model. If the value of Ts is 0, the SysInZPK model is continuous. Otherwise, the model is discrete. Ts is a real scalar. |
Details
The following table lists the support characteristics of this function.
| Supported in the LabVIEW Run-Time Engine | Yes |
| Supported on RT targets | Yes |
| Suitable for bounded execution times on RT | Not characterized |
Examples
z1 = 1
p1 = 2
z2 = []
p2 = [1, 1]
K = [2; 1]
SysInZPK = zpk(z1, z2, p1, p2, K)
[z2, p2, k2] = zpkinfo(SysInZPK, 2, 1)