master:xy_transfer_function parametersPSCAD X-Y Transfer Function
Every parameter of the PSCAD X-Y Transfer Function (master:xy_transfer_function): 37 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:xy_transfer_function is
X-Y Transfer Function (X-Y transfer function), a component of PSCAD's Master Library, filed under control blocks.
- Definition
master:xy_transfer_function- PSCAD name
- X-Y Transfer Function
- Category
- Control blocks
- Parameters
- 37, in 3 groups
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:xy_transfer_function 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:xy_transfer_function"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["Kx"])) # X Axis Gain
comp = project.find_all("master:xy_transfer_function")[0]
comp.parameters(Kx="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, "Kx") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Data - Filename
| Parameter | Unit | Default | Description |
|---|---|---|---|
FileText | · | datafile | File NameEnter the name of the file with the extension. Include the path (relative or absolute) if applicable.Range 0 to 0Used when (Method==0) |
npairsInteger | · | 1000 | Approximate Number of Pairs of Data in the Fileused for assigining storage, should be accurate within 10%Range 1 to 2147483647 |
pathChoice | · | RELATIVE | Pathname to the Datafile is Given asFilename may be given as an absolute path or relative to where the project resides.Written as RELATIVE (relative pathname), ABSOLUTE (absolute pathname) |
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
InTypeChoice | · | REAL | Input TypeWritten as REAL (Real), INTEGER (Integer)Used when false |
KxReal | · | 1.0 | X Axis Gain |
KyReal | · | 1.0 | Y Axis Gain |
MethodChoice | · | FILE | Data Entry MethodSelect the data entry method: File or TableWritten as FILE (File), TABLE (Table) |
ModeChoice | · | INTERPOLATE | Ouput ModeSpecify how output is made: interpolate or sample and holdWritten as INTERPOLATE (Interpolate), SAMPLE_AND_HOLD (Sample and Hold) |
NameText | · | · | Name for IdentificationEnter a name for identificationRange 0 to 0 |
PerChoice | · | NO | PeriodicSpecify whether data is periodic or notWritten as NO (No), YES (Yes) |
XoffReal | · | 0.0 | X Axis Offset or Phase Shift |
YoffReal | · | 0.0 | Y Axis Offset or DC Offset |
Data - Table
| Parameter | Unit | Default | Description |
|---|---|---|---|
NChoice | · | 10 | Number of PointsSelect the number of points in the tableWritten as 1 = 1, 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10, 11 = 11, 12 = 12Used when (Method==1) |
X1Real | · | 1.0 | Point 1 - XUsed when N>=1 |
X10Real | · | 10.0 | Point 10 - XUsed when N>=10 |
X11Real | · | 11.0 | Point 11 - XUsed when N>=11 |
X12Real | · | 12.0 | Point 12 - XUsed when N>=12 |
X2Real | · | 2.0 | Point 2 - XUsed when N>=2 |
X3Real | · | 3.0 | Point 3 - XUsed when N>=3 |
X4Real | · | 4.0 | Point 4 - XUsed when N>=4 |
X5Real | · | 5.0 | Point 5 - XUsed when N>=5 |
X6Real | · | 6.0 | Point 6 - XUsed when N>=6 |
X7Real | · | 7.0 | Point 7 - XUsed when N>=7 |
X8Real | · | 8.0 | Point 8 - XUsed when N>=8 |
X9Real | · | 9.0 | Point 9 - XUsed when N>=9 |
Y1Real | · | 1.0 | Point 1 - YUsed when N>=1 |
Y10Real | · | 10.0 | Point 10 - YUsed when N>=10 |
Y11Real | · | 11.0 | Point 11 - YUsed when N>=11 |
Y12Real | · | 12.0 | Point 12 - YUsed when N>=12 |
Y2Real | · | 2.0 | Point 2 - YUsed when N>=2 |
Y3Real | · | 3.0 | Point 3 - YUsed when N>=3 |
Y4Real | · | 1.0 | Point 4 - YUsed when N>=4 |
Y5Real | · | 5.0 | Point 5 - YUsed when N>=5 |
Y6Real | · | 6.0 | Point 6 - YUsed when N>=6 |
Y7Real | · | 7.0 | Point 7 - YUsed when N>=7 |
Y8Real | · | 8.0 | Point 8 - YUsed when N>=8 |
Y9Real | · | 9.0 | Point 9 - YUsed when N>=9 |
Related
← master:vdcl Voltage Dependent Current Limits · master:xyz_tf XYZ Transfer Function →