master:Ztrans_fcnZ parametersPSCAD Nth Order Transfer Function
Every parameter of the PSCAD Nth Order Transfer Function (master:Ztrans_fcnZ): 47 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:Ztrans_fcnZ is
Nth Order Transfer Function (Z domain transfer function), a component of PSCAD's Master Library, filed under control blocks.
- Definition
master:Ztrans_fcnZ- PSCAD name
- Nth Order Transfer Function
- Category
- Control blocks
- Parameters
- 47, in 4 groups
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:Ztrans_fcnZ in Python
import mhi.pscad
pscad = mhi.pscad.connect() # the PSCAD that is open; launch() starts one
project = pscad.project("my_case") # a case loaded in the workspace
for comp in project.find_all("master:Ztrans_fcnZ"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["Dim"])) # Dimension
comp = project.find_all("master:Ztrans_fcnZ")[0]
comp.parameters(Dim="2") # written as text
- A parameter is named exactly as in the table, letter case included:
parameters()gives every one of them in a dictionary, and a name the component does not have is refused. - A value that carries a unit comes back as a number whose unit is only in its text, so read it as text first (
str(...)) or the unit is lost. PSCAD keeps a written unit as it is given:"2500 [mohm]"stays in mohm. - A Choice is read and written as its symbol (the capitals in "Written as"), not as the words PSCAD shows in the dialog.
find_all()takes the exact definition only. A wildcard or a bare name withoutmaster:comes back empty; the Builder'spx_findwalks the pages for those.
The Builder's runtime does the same with the unit handled for you: px_get(comp, "Dim") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
DimInteger | · | 1 | Dimensiondimension of input/output signalsRange 1 to 2147483647 |
INTRChoice | · | NO | Is Input Already Sampled?Select Yes if the input is already sampled with the same execution frequency, Select No if sampling is needed.Written as YES (Yes), NO (No) |
NameText | · | · | Name for identificationEnter a name for identification |
Denominator
| Parameter | Unit | Default | Description |
|---|---|---|---|
OrderDChoice | · | 1 | Order of DenominatorWritten as 0 = 0, 1 = 1, 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10 |
d0Real | · | 1.0 | Constant CoefficientRange -100000000 to 100000000 |
d1Real | · | 0.0 | Coefficient of z^(-1)Range -100000000 to 100000000Used when (OrderD>0) |
d10Real | · | 0.0 | Coefficient of z^(-10)Range -100000000 to 100000000Used when (OrderD>9) |
d2Real | · | 0.0 | Coefficient of z^(-2)Range -100000000 to 100000000Used when (OrderD>1) |
d3Real | · | 0.0 | Coefficient of z^(-3)Range -100000000 to 100000000Used when (OrderD>2) |
d4Real | · | 0.0 | Coefficient of z^(-4)Range -100000000 to 100000000Used when (OrderD>3) |
d5Real | · | 0.0 | Coefficient of z^(-5)Range -100000000 to 100000000Used when (OrderD>4) |
d6Real | · | 0.0 | Coefficient of z^(-6)Range -100000000 to 100000000Used when (OrderD>5) |
d7Real | · | 0.0 | Coefficient of z^(-7)Range -100000000 to 100000000Used when (OrderD>6) |
d8Real | · | 0.0 | Coefficient of z^(-8)Range -100000000 to 100000000Used when (OrderD>7) |
d9Real | · | 0.0 | Coefficient of z^(-9)Range -100000000 to 100000000Used when (OrderD>8) |
Numerator
| Parameter | Unit | Default | Description |
|---|---|---|---|
OrderNChoice | · | 1 | Order of NumeratorWritten as 0 = 0, 1 = 1, 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10 |
n0Real | · | 1.0 | Constant CoefficientRange -100000000 to 100000000 |
n1Real | · | 0.0 | Coefficient of z^(-1)Range -100000000 to 100000000Used when (OrderN>0) |
n10Real | · | 0.0 | Coefficient of z^(-10)Range -100000000 to 100000000Used when (OrderN>9) |
n2Real | · | 0.0 | Coefficient of z^(-2)Range -100000000 to 100000000Used when (OrderN>1) |
n3Real | · | 0.0 | Coefficient of z^(-3)Range -100000000 to 100000000Used when (OrderN>2) |
n4Real | · | 0.0 | Coefficient of z^(-4)Range -100000000 to 100000000Used when (OrderN>3) |
n5Real | · | 0.0 | Coefficient of z^(-5)Range -100000000 to 100000000Used when (OrderN>4) |
n6Real | · | 0.0 | Coefficient of z^(-6)Range -100000000 to 100000000Used when (OrderN>5) |
n7Real | · | 0.0 | Coefficient of z^(-7)Range -100000000 to 100000000Used when (OrderN>6) |
n8Real | · | 0.0 | Coefficient of z^(-8)Range -100000000 to 100000000Used when (OrderN>7) |
n9Real | · | 0.0 | Coefficient of z^(-9)Range -100000000 to 100000000Used when (OrderN>8) |
Initial Conditions
| Parameter | Unit | Default | Description |
|---|---|---|---|
x1Real | · | 0.0 | X1 Initial ValueRange -100000000 to 100000000Used when (OrderN>0) |
x10Real | · | 0.0 | X10 Initial ValueRange -100000000 to 100000000Used when (OrderN>9) |
x2Real | · | 0.0 | X2 Initial ValueRange -100000000 to 100000000Used when (OrderN>1) |
x3Real | · | 0.0 | X3 Initial ValueRange -100000000 to 100000000Used when (OrderN>2) |
x4Real | · | 0.0 | X4 Initial ValueRange -100000000 to 100000000Used when (OrderN>3) |
x5Real | · | 0.0 | X5 Initial ValueRange -100000000 to 100000000Used when (OrderN>4) |
x6Real | · | 0.0 | X6 Initial ValueRange -100000000 to 100000000Used when (OrderN>5) |
x7Real | · | 0.0 | X7 Initial ValueRange -100000000 to 100000000Used when (OrderN>6) |
x8Real | · | 0.0 | X8 Initial ValueRange -100000000 to 100000000Used when (OrderN>7) |
x9Real | · | 0.0 | X9 Initial ValueRange -100000000 to 100000000Used when (OrderN>8) |
y1Real | · | 0.0 | Y1 Initial ValueRange -100000000 to 100000000Used when (OrderD>0) |
y10Real | · | 0.0 | Y10 Initial ValueRange -100000000 to 100000000Used when (OrderD>9) |
y2Real | · | 0.0 | Y2 Initial ValueRange -100000000 to 100000000Used when (OrderD>1) |
y3Real | · | 0.0 | Y3 Initial ValueRange -100000000 to 100000000Used when (OrderD>2) |
y4Real | · | 0.0 | Y4 Initial ValueRange -100000000 to 100000000Used when (OrderD>3) |
y5Real | · | 0.0 | Y5 Initial ValueRange -100000000 to 100000000Used when (OrderD>4) |
y6Real | · | 0.0 | Y6 Initial ValueRange -100000000 to 100000000Used when (OrderD>5) |
y7Real | · | 0.0 | Y7 Initial ValueRange -100000000 to 100000000Used when (OrderD>6) |
y8Real | · | 0.0 | Y8 Initial ValueRange -100000000 to 100000000Used when (OrderD>7) |
y9Real | · | 0.0 | Y9 Initial ValueRange -100000000 to 100000000Used when (OrderD>8) |
Related
- All 345 definitions in the component reference
- Control tuning: overshoot, rise time and damping
- PSCAD automation with Python: getting started
← master:trans_fcn Nth Order Transfer Function · master:over_current Over Current Detection →