master:trans_filt parametersPSCAD Nth Order Butterworth/Chebyshev Filter

Every parameter of the PSCAD Nth Order Butterworth/Chebyshev Filter (master:trans_filt): 11 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:trans_filt is

Nth Order Butterworth/Chebyshev Filter, a component of PSCAD's Master Library, filed under passive branches, loads and filters.

Definition
master:trans_filt
PSCAD name
Nth Order Butterworth/Chebyshev Filter
Category
Passive branches, loads and filters
Parameters
11, in 1 group; 4 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:trans_filt 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:trans_filt"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["FBase"]))          # Base Frequency, in Hz

comp = project.find_all("master:trans_filt")[0]
comp.parameters(FBase="120 [Hz]")        # a value that carries a unit is written with it
  • 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 without master: comes back empty; the Builder's px_find walks the pages for those.

The Builder's runtime does the same with the unit handled for you: px_get(comp, "FBase") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Configuration

ParameterUnitDefaultDescription
BandChoice·LOW_PASSFilter PassbandWritten as LOW_PASS (Low pass), HIGH_PASS (High pass), BAND_PASS (Band pass), BAND_STOP (Band stop)
CnfgChoice·CENTRE_FREQUENCY_Q_FACTORData EntryWritten as CENTRE_FREQUENCY_Q_FACTOR (Centre Frequency and Q Factor), UPPER_LOWER_CUTOFF_FREQUENCIES (Upper and Lower cut-off frequencies)Used when (Band>=3)
DimInteger·1DimensionRange 1 to 2147483647
FBaseRealHz60.0Base FrequencyRange 1E-10 to 1E+20Used when (Band<=2)||(Cnfg==0)
FlowRealHz10.0Lower Cutoff FrequencyRange 1E-10 to 1E+20Used when (Band>=3)&&(Cnfg==1)
FupRealHz100.0Upper Cutoff FrequencyRange 1E-10 to 1E+20Used when (Band>=3)&&(Cnfg==1)
NameText··Name for IdentificationEnter a name for identification
OrderChoice·3Order of Transfer FunctionWritten as 1 = 1, 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10
PRipRealdB0.1Passband RippleRange 0.001 to 100Used when (Type==2)
QReal·5.0Q Factor (FBase/Bandwidth)Range 0.1 to 1000Used when (Band>=3)&&(Cnfg==0)
TypeChoice·BUTTERWORTHFilter TypeSelect Butterworth or ChebyshevWritten as BUTTERWORTH (Butterworth), CHEBYSHEV (Chebyshev)

Related

← master:Line_Ground Line|Cable Ground Properties · master:PUImpedanceBranch PU Impedance Branch →