Convenience Functions

High-level functions for one-shot spectrogram computation. For batch processing, use the Planner API API instead.

Linear Spectrograms

spectrograms.compute_linear_power_spectrogram()

Compute a linear power spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
paramsSpectrogramParams: Spectrogram parameters

Returns

Spectrogram: Spectrogram with linear frequency scale and power amplitude scale

spectrograms.compute_linear_magnitude_spectrogram()

Compute a linear magnitude spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
paramsSpectrogramParams: Spectrogram parameters

Returns

Spectrogram: Spectrogram with linear frequency scale and magnitude amplitude scale

spectrograms.compute_linear_db_spectrogram()

Compute a linear decibel spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
paramsSpectrogramParams: Spectrogram parameters

Returns

Spectrogram: Spectrogram with linear frequency scale and decibel amplitude scale

Mel Spectrograms

spectrograms.compute_mel_power_spectrogram()

Compute a mel power spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyMelParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with mel frequency scale and power amplitude scale

spectrograms.compute_mel_magnitude_spectrogram()

Compute a mel magnitude spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyMelParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with mel frequency scale and magnitude amplitude scale

spectrograms.compute_mel_db_spectrogram()

Compute a mel decibel spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyMelParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with mel frequency scale and decibel amplitude scale

ERB Spectrograms

spectrograms.compute_erb_power_spectrogram()

Compute a ERB/gammatone power spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyErbParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with ERB/gammatone frequency scale and power amplitude scale

spectrograms.compute_erb_magnitude_spectrogram()

Compute a ERB/gammatone magnitude spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyErbParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with ERB/gammatone frequency scale and magnitude amplitude scale

spectrograms.compute_erb_db_spectrogram()

Compute a ERB/gammatone decibel spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D array
paramsSpectrogramParams: Spectrogram parameters
filter_paramsPyErbParams: Filterbank parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: Spectrogram with ERB/gammatone frequency scale and decibel amplitude scale

Audio Features

spectrograms.compute_cqt()

Compute a Constant-Q Transform power spectrogram.

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
paramsSpectrogramParams: Spectrogram parameters
cqtCqtParams: CQT parameters
dbtyping.Optional[LogParams], optional: Optional decibel scaling parameters

Returns

Spectrogram: CQT spectrogram with power amplitude scale

spectrograms.compute_chromagram()

Compute a chromagram (pitch class profile).

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
stft_paramsStftParams: STFT parameters
sample_ratefloat: Sample rate in Hz
chroma_paramsChromaParams: Chromagram parameters

Returns

numpy.ndarray: Chromagram as a 2D NumPy array (12 x n_frames)

spectrograms.compute_mfcc()

Compute MFCCs (Mel-Frequency Cepstral Coefficients).

Parameters

samplesnumpy.typing.NDArray[numpy.float64]: Audio samples as a 1D NumPy array
stft_paramsStftParams: STFT parameters
sample_ratefloat: Sample rate in Hz
n_melsint: Number of mel bands
mfcc_paramsMfccParams: MFCC parameters

Returns

numpy.ndarray: MFCCs as a 2D NumPy array (n_mfcc x n_frames)

Low-Level Functions

spectrograms.compute_stft()

Compute the raw STFT (Short-Time Fourier Transform).

Returns the complex-valued STFT matrix before any frequency mapping or amplitude scaling.

Parameters

:param samples - Audio samples as a 1D NumPy array :param params - Spectrogram parameters

Returns

Complex STFT as a 2D NumPy array of complex128 (n_fft/2+1 x n_frames)