MatrixFeatureOutput#

Defined in: voxatlas.features.feature_output

class voxatlas.features.feature_output.MatrixFeatureOutput(feature, unit, time, frequency, values)[source]#

Bases: object

Store a time-frequency matrix output.

Parameters:

  • feature (str) – Registered feature name.

  • unit (str) – Unit level associated with the matrix.

  • time (ndarray) – Time axis of the matrix.

  • frequency (ndarray) – Frequency axis of the matrix.

  • values (ndarray) – Matrix values aligned to the time and frequency axes.

Returns:

Dataclass wrapping matrix-valued outputs.

Return type:

MatrixFeatureOutput

Notes

Spectrogram-style features use this container.

Examples

Usage example:

output = MatrixFeatureOutput(feature="acoustic.spectrogram.stft", unit="frame", time=time, frequency=freq, values=matrix)
print(output.values.shape)
feature: str#
unit: str#
time: ndarray#
frequency: ndarray#
values: ndarray#