get_output

Stft.get_output()

Get the STFT of the signal as a DPF fields container.

Returns:

FieldsContainer

Complex STFT, as a fields container, indexed by labels “time” and “complex”. Each indexed field corresponds to the real or imaginary part of a time-wise STFT slice.

The label “complex” indicates whether the field corresponds to the real (0) or imaginary (1) part of the STFT slice. The module of each STFT slice is a two-sided RMS spectrum between 0 Hz and the sampling frequency, at a specific time, as indexed with label “time”. The spectrum values are in the input signal’s unit.

The support of the fields container, labeled “time”, provides the actual time values, in seconds, corresponding to each “time” label index.

For more information, see RMS spectrum.

Return type:

FieldsContainer

Notes

Prior to Sound version 2027.1.0, RMS spectrum scaling is not applied in the returned STFT. As a consequence, the stored STFT values are not in the input signal’s unit if the used Sound version is not 2027.1.0 or higher. In such case, to scale the STFT values, you need to divide them by the sum of the values of the window function that is specified with attributes window_type and fft_size (the window size is equal to the FFT size in fft_size).