torch.functional.stft

torch.functional.stft(input, n_fft, hop_length=None, win_length=None, window=None, center=True, pad_mode='reflect', normalized=False, onesided=None, return_complex=None, align_to_window=None)

短时傅里叶变换 (STFT)。

警告

从 1.8.0 版本开始，对于实数输入，return_complex 必须始终显式给出，并且 return_complex=False 已被弃用。强烈建议使用 return_complex=True，因为在未来的 PyTorch 版本中，此函数将仅返回复数张量。

请注意，可以使用 torch.view_as_real() 来恢复一个具有额外最后一个维度来表示实部和虚部的实数张量。

警告

从 2.1 版本开始，如果未指定 window，则会提供警告。在未来的版本中，此属性将是必需的。当前未提供窗口将默认使用矩形窗口，这可能会导致不希望出现的伪影。请考虑使用渐变窗口，例如 torch.hann_window()。

STFT 计算输入短重叠窗口的傅里叶变换。这可以给出信号随时间变化的频率分量。此函数接口模仿了（但*不是*完全兼容） librosa 的 stft 函数。

忽略可选的批处理维度，此方法计算以下表达式：

$$X[\omega, m] = \sum_{k = 0}^{\text{win\_length-1}}$$

其中 $m$ 是滑动窗口的索引，而 $\omega$ 是频率，对于 onesided=False，$0 \leq \omega < \text{n\_fft}$，或者对于 onesided=True，$0 \leq \omega < \lfloor \text{n\_fft} / 2 \rfloor + 1$。

• input 必须是 1D 时间序列或 2D 时间序列批次。

• 如果 hop_length 是 None（默认值），它将被视为等于 floor(n_fft / 4)。

• 如果 win_length 是 None（默认值），它将被视为等于 n_fft。

• window 可以是大小为 win_length 的 1D 张量，例如，来自 torch.hann_window()。如果 window 是 None（默认值），它将被视为窗口中所有位置都为 $1$。如果 $\text{win\_length} < \text{n\_fft}$，window 将在两侧填充到长度 n_fft 后再应用。

• 如果 center 为 True（默认值），input 将在两侧填充，以便第 $t$ 个帧位于时间 $t \times \text{hop\_length}$ 的中心。否则，第 $t$ 个帧开始于时间 $t \times \text{hop\_length}$。

• pad_mode 确定了当 center 为 True 时在 input 上使用的填充方法。有关所有可用选项，请参阅 torch.nn.functional.pad()。默认为 "reflect"。

• 如果 onesided 为 True（实数输入的默认值），则只返回 $\omega$ 在 $\left[0, 1, 2, \dots, \left\lfloor \frac{\text{n\_fft}}{2} \right\rfloor + 1\right]$ 中的值，因为实数到复数的傅里叶变换满足共轭对称性，即 $X[m, \omega] = X[m, \text{n\_fft} - \omega]^*$。如果输入或窗口张量是复数，则不可能进行 onesided 输出。

• 如果 normalized 为 True（默认为 False），则函数返回归一化的 STFT 结果，即乘以 $(\text{frame\_length})^{-0.5}$。

• 如果 return_complex 为 True（如果输入是复数，则为默认值），则返回一个 input.dim() + 1 维的复数张量。如果为 False，则输出是一个 input.dim() + 2 维的实数张量，其中最后一个维度表示实部和虚部。

返回一个大小为 $(* \times N \times T)$ 的复数张量（如果 return_complex 为 true），或者一个大小为 $(* \times N \times T \times 2)$ 的实数张量。其中 $*$ 是 input 的可选批处理大小，$N$ 是应用 STFT 的频率样本数，$T$ 是使用的总帧数。

警告

此函数在 0.4.1 版本更改了签名。使用先前签名调用可能会导致错误或返回不正确的结果。

参数

• input (Tensor) – 输入张量，形状为 (B?, L)，其中 B? 是可选的批处理维度

• n_fft (int) – 傅里叶变换的大小

• hop_length (int, optional) – 相邻滑动窗口帧之间的距离。默认值：None（视为等于 floor(n_fft / 4)）

• win_length (int, optional) – 窗口帧和 STFT 滤波器的尺寸。默认值：None（视为等于 n_fft）

• window (Tensor, optional) – 可选的窗口函数。形状必须是 1d 且 <= n_fft。默认值：None（视为所有 $1$ 的窗口）

• center (bool, optional) – 是否在两侧填充 input，以便第 $t$ 个帧位于时间 $t \times \text{hop\_length}$ 的中心。默认值：True

• pad_mode (str, optional) – 控制当 center 为 True 时使用的填充方法。默认值："reflect"

• normalized (bool, optional) – 控制是否返回归一化的 STFT 结果。默认值：False

• onesided (bool, optional) – 控制是否为实数输入和窗口返回一半结果以避免冗余。默认值：对于实数 input 和 window 为 True，否则为 False。

• return_complex (bool, optional) –

  控制是否返回一个复数张量，或者一个带有额外最后一个维度表示实部和虚部的实数张量。

  已更改版本 2.0: 对于实数输入，return_complex 现在是必需参数，因为默认值正在过渡到 True。

  已弃用版本 2.0: return_complex=False 已弃用，请改用 return_complex=True。请注意，对输出调用 torch.view_as_real() 可以恢复弃用的输出格式。

返回

返回一个形状为 (B?, N, T, C?) 的 STFT 结果张量，其中：

• B? 是输入的（可选）批处理维度。

• N 是频率样本数，对于 onesided=True 为 (n_fft // 2) + 1，否则为 n_fft。

• T 是帧数，对于 center=True 为 1 + L // hop_length，否则为 1 + (L - n_fft) // hop_length。

• C? 是一个可选的长度为 2 的实部和虚部维度，当 return_complex=False 时存在。

返回类型

张量