ShortTimeFourierTransform

harmonic_indices

harmonic_indices	Description	Example
Required: True Type: typing.Union[int, list[int], NoneType] Units: None	List of harmonics indices kept, if all use -1	[0, 4, 8]

method

method	Description	Example
Required: True Type: <enum ‘MethodEnum’> Units: None	Fourier transform method	fft

min_num_stft_windows

min_num_stft_windows	Description	Example
Required: True Type: <class ‘int’> Units: None	How many FFT windows must be available for the time series to valid for STFT.	4

per_window_detrend_type

per_window_detrend_type	Description	Example
Required: True Type: <enum ‘PerWindowDetrendTypeEnum’> Units: None	Additional detrending applied per window. Not available for standard scipy spectrogram – placholder for ARMA prewhitening.	linear

pre_fft_detrend_type

pre_fft_detrend_type	Description	Example
Required: True Type: <enum ‘PreFftDetrendTypeEnum’> Units: None	Pre FFT detrend method to be applied	linear

prewhitening_type

prewhitening_type	Description	Example
Required: True Type: <enum ‘PrewhiteningTypeEnum’> Units: None	Prewhitening method to be applied	first difference

recoloring

recoloring	Description	Example
Required: True Type: <class ‘bool’> Units: None	Whether the data are recolored [True] or not [False].	True

window.num_samples

window.num_samples	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples in a single window	256

window.overlap

window.overlap	Description	Example
Required: True Type: <class ‘int’> Units: samples	Number of samples overlapped by adjacent windows	32

window.type

window.type	Description	Example
Required: True Type: <enum ‘TypeEnum’> Units: None	name of the window type	hamming

window.clock_zero_type

window.clock_zero_type	Description	Example
Required: True Type: <enum ‘ClockZeroTypeEnum’> Units: None	how the clock-zero is specified	user specified

window.clock_zero

window.clock_zero	Description	Example
Required: False Type: mt_metadata.common.mttime.MTime | str | float | int | Units: None	Start date and time of the first data window	2020-02- 01T09:23:45.453 670+00:00

window.normalized

window.normalized	Description	Example
Required: True Type: <class ‘bool’> Units: None	True if the window shall be normalized so the sum of the coefficients is 1	False

window.additional_args

window.additional_args	Description	Example
Required: False Type: <class ‘dict’> Units: None	Additional arguments for the window function	{‘param’: ‘value’}