master:xyz_tf parametersPSCAD XYZ Transfer Function
Every parameter of the PSCAD XYZ Transfer Function (master:xyz_tf): 17 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:xyz_tf is
XYZ Transfer Function (XYZ transfer function), a component of PSCAD's Master Library, filed under control blocks.
- Definition
master:xyz_tf- PSCAD name
- XYZ Transfer Function
- Category
- Control blocks
- Parameters
- 17, in 1 group
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:xyz_tf 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:xyz_tf"): # 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:xyz_tf")[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.
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
FileText | · | datafile | File NameName of the datafile with extensionUsed when datasource==0 |
KxReal | · | 1.0 | X Axis GainEnter a multiplier for X values |
KyReal | · | 1.0 | Y Axis GainEnter a multiplier for Y values |
KzReal | · | 1.0 | Z Axis GainEnter a multiplier for Z values |
ModeChoice | · | INTERPOLATE | Ouput ModeSelect to output nearest value or interpolated valueWritten as INTERPOLATE (Interpolate), NEAREST_DATA_POINT (Nearest data point) |
NLinesInteger | · | 10000 | Approximate Number of Lines in the Fileused for assigning storage, should be accurate within 10%Range 3 to 2147483647Used when datasource==0 |
NameText | · | · | Name for IdentificationEnter a name for identification |
XoffReal | · | 0.0 | X Axis Offset or Phase ShiftEnter a value for x values to be shifted |
XvaluesTable | · | [['Real (10)']] | X ValuesX data in ascending orderUsed when datasource==1 |
YoffReal | · | 0.0 | Y Axis Offset or Phase ShiftEnter a value for Y values to be shifted |
YvaluesTable | · | [['Real (1', '10)']] | Y ValuesY values in ascending orderUsed when datasource==1 |
ZOFFReal | · | 0.0 | Z Axis Offset or DC OffsetEnter a value for Z values to be shifted |
datasourceChoice | · | DATAFILE | Data SourceSelect how the data is enteredWritten as DATAFILE (DataFile), TABLE (Table) |
datatableTable | · | [['Real (10', '10)']] | Data TableData entered in (X1,Y1),(X1,Y2),.....(X2,Y1)... order Left to Right, Top to BottomUsed when datasource==1 |
ncolmsInteger | · | 3 | Number of Effective Columns (Y)Effective number of columns in the tableRange 1 to 10Used when datasource==1 |
nrowsInteger | · | 4 | Number of Effective Rows (X)Effective number of rows in the tableRange 1 to 10Used when datasource==1 |
pathChoice | · | RELATIVE | Pathname to the Datafile is Given asSelect how the path to the datafile is enteredWritten as RELATIVE (relative pathname), ABSOLUTE (absolute pathname)Used when datasource==0 |
Related
← master:xy_transfer_function X-Y Transfer Function · master:zerodetect Zero Detector →