torchaudio.functional.mask_along_axis

torchaudio.functional.mask_along_axis(specgram: Tensor, mask_param: int, mask_value: float, axis: int, p: float = 1.0) → Tensor

Apply a mask along axis.

Mask will be applied from indices [v_0, v_0 + v), where v is sampled from uniform(0, max_v) and v_0 from uniform(0, specgrams.size(axis) - v), with max_v = mask_param when p = 1.0 and max_v = min(mask_param, floor(specgrams.size(axis) * p)) otherwise. All examples will have the same mask interval.

Parameters:

• specgram (Tensor) – Real spectrogram (channel, freq, time)

• mask_param (int) – Number of columns to be masked will be uniformly sampled from [0, mask_param]

• mask_value (float) – Value to assign to the masked columns

• axis (int) – Axis to apply masking on (1 -> frequency, 2 -> time)

• p (float, optional) – maximum proportion of columns that can be masked. (Default: 1.0)

Returns:

Masked spectrogram of dimensions (channel, freq, time)

Return type:

Tensor