master:fft parametersPSCAD On-Line Frequency Scanner
Every parameter of the PSCAD On-Line Frequency Scanner (master:fft): 11 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:fft is
The on-line frequency scanner: an FFT of a signal during the run, giving the magnitude and phase of each harmonic as signals.
- Definition
master:fft- PSCAD name
- On-Line Frequency Scanner
- Category
- Lines, cables and towers
- Parameters
- 11, in 2 groups; 1 carry a unit
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:fft 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:fft"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["F"])) # Base Frequency, in Hz
comp = project.find_all("master:fft")[0]
comp.parameters(F="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 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, "F") 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 |
|---|---|---|---|
AModChoice | · | RMS | Magnitude Output:Select what the magnitude outputs be, peaks or RMS valuesWritten as RMS, PEAK (Peak) |
EnabInteger | · | 1 | Frequency Tracking Enable SignalFrequency tracking could be dynamically controlled by this signal. Enable(1) or Disable(0)Range 0 to 1Used when Track==1 |
FReal | Hz | 60.0 | Base FrequencyEnter the base frequency. FFT window will be one cycle of this frequency.Range 1E-20 to 1E+36 |
FiltChoice | · | YES | Anti-aliasing Filter?Enable or Disable anti-aliasing filterWritten as NO (no), YES (yes) |
NameText | · | · | Name for IdentificationEnter a name for identification |
PModChoice | · | RADIANS | Phase Output Units:Select what the phase output be, radians or degreesWritten as RADIANS (Radians), DEGREES (Degrees) |
PModCSChoice | · | COSINE_WAVE | Phase Output ReferenceSelect what the reference waveform for phase computationWritten as COSINE_WAVE (Cosine wave), SINE_WAVE (Sine wave) |
SizeChoice | · | N_7 | Number of HarmonicsSelect the number of harmonics to computeWritten as N_7 (n=7), N_15 (n=15), N_31 (n=31), N_63 (n=63), N_127 (n=127), N_255 (n=255), N_511 (n=511), N_1023 (n=1023) |
TrackChoice | · | NO | Frequency Tracking?Enable or Disable frequency trakcingWritten as NO (no), YES (yes) |
TypeChoice | · | 1_PHASE | TypeEnter the type of input signalWritten as 1_PHASE (1 Phase), 2_PHASE (2 Phase), 3_PHASE (3 Phase), _0_SEQ (+/-/0 Seq), 3_PHASE_SLD (3 Phase SLD), _0_SEQ_SLD (+/-/0 Seq SLD) |
Frequency Output Variable
| Parameter | Unit | Default | Description |
|---|---|---|---|
FoutText | · | · | Name for Frequency Output: |
Related
- All 345 definitions in the component reference
- Harmonics and THD from a PSCAD run
- PSCAD automation with Python: getting started
← master:nl_tfun Non-Linear Transfer Characteristic · master:pi_ctlr PI Controller →