plot_custom

Stft.plot_custom(display_phase=True, display_in_dB=True, reference_value=1.0, range_magnitude=None, max_magnitude=None, max_frequency=None, title='STFT')

Plot the STFT with custom display settings.

Parameters:

display_phase: bool, default: True

Whether to include the STFT phase in the plot.

display_in_dB: bool, default: True

Whether to display the STFT magnitude in dB or in the input signal’s unit.

reference_value: float, default: 1.0

Reference value for dB conversion. Ignored if display_in_dB is False.

range_magnitude: float, default: None

Range of magnitude values for the colormap. If None, it is set to 60 dB if display_in_dB is True, otherwise it is set to the maximum magnitude (see max_magnitude).

max_magnitude: float, default: None

Maximum magnitude value for the colormap. If None, it is determined as the maximum magnitude in the STFT data.

max_frequency: float, default: None

Maximum frequency in Hz to display. If None, the full frequency range, that is, up to half the sampling frequency, is shown.

title: str, default: “STFT”

Title of the figure.

Return type:

None

Notes

Prior to Sound version 2027.1.0, RMS spectrum scaling is not applied in the returned STFT. As a consequence, the displayed STFT magnitude will be incorrect with Sound versions prior to 2027.1.0.