ezmsg.sigproc.spectrogram#

Functions

spectrogram(window_dur=None, window_shift=None, window_anchor=Anchor.BEGINNING, window=WindowFunction.HAMMING, transform=SpectralTransform.REL_DB, output=SpectralOutput.POSITIVE)[source]#

Parameters:

window_dur (float | None)
window_shift (float | None)
window_anchor (str | Anchor)
window (WindowFunction)
transform (SpectralTransform)
output (SpectralOutput)

Return type:

SpectrogramTransformer

Classes

class Spectrogram(*args, settings=None, **kwargs)[source]#

Bases: BaseTransformerUnit[SpectrogramSettings, AxisArray, AxisArray, SpectrogramTransformer]

Parameters:: settings (Settings | None)

SETTINGS#: alias of SpectrogramSettings

class SpectrogramSettings(window_dur=None, window_shift=None, window_anchor=Anchor.BEGINNING, window=WindowFunction.HAMMING, transform=SpectralTransform.REL_DB, output=SpectralOutput.POSITIVE)[source]#

Bases: Settings

Settings for SpectrogramTransformer.

Parameters:

window_dur (float | None)
window_shift (float | None)
window_anchor (str | Anchor)
window (WindowFunction)
transform (SpectralTransform)
output (SpectralOutput)

window_dur: float | None = None#: window duration in seconds.

window_shift: float | None = None#: “window step in seconds. If None, window_shift == window_dur

window_anchor: str | Anchor = 'beginning'#

obj”WindowTransformer

Type:: See

window: WindowFunction = 'Hamming'#: The WindowFunction to apply to the data slice prior to calculating the spectrum.

transform: SpectralTransform = 'Log Power (Relative dB)'#: The SpectralTransform to apply to the spectral magnitude.

__init__(window_dur=None, window_shift=None, window_anchor=Anchor.BEGINNING, window=WindowFunction.HAMMING, transform=SpectralTransform.REL_DB, output=SpectralOutput.POSITIVE)#

Parameters:

window_dur (float | None)
window_shift (float | None)
window_anchor (str | Anchor)
window (WindowFunction)
transform (SpectralTransform)
output (SpectralOutput)

Return type:

None

output: SpectralOutput = 'Positive Frequencies'#: The SpectralOutput format.

class SpectrogramTransformer(*args, **kwargs)[source]#

Bases: CompositeProcessor[SpectrogramSettings, AxisArray, AxisArray]

Bases: Settings

Settings for SpectrogramTransformer.

Parameters:

window_dur (float | None)
window_shift (float | None)
window_anchor (str | Anchor)
window (WindowFunction)
transform (SpectralTransform)
output (SpectralOutput)

window_dur: float | None = None#: window duration in seconds.

window_shift: float | None = None#: “window step in seconds. If None, window_shift == window_dur

window_anchor: str | Anchor = 'beginning'#

obj”WindowTransformer

Type:: See

window: WindowFunction = 'Hamming'#: The WindowFunction to apply to the data slice prior to calculating the spectrum.

transform: SpectralTransform = 'Log Power (Relative dB)'#: The SpectralTransform to apply to the spectral magnitude.

__init__(window_dur=None, window_shift=None, window_anchor=Anchor.BEGINNING, window=WindowFunction.HAMMING, transform=SpectralTransform.REL_DB, output=SpectralOutput.POSITIVE)#