torch.stft

torch.stft(input, n_fft, hop_length=None, win_length=None, window=None, center=True, pad_mode='reflect', normalized=False, onesided=None, return_complex=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$ 是频率 $0 \leq \omega < \text{n\_fft}$，当 onesided=False 时，或 $0 \leq \omega < \lfloor \text{n\_fft} / 2 \rfloor + 1$，当 onesided=True 时。

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

• 如果 hop_length 为 None (默认)，则将其视为等于 floor(n_fft / 4)。

• 如果 win_length 为 None (默认)，则将其视为等于 n_fft。

• window 可以是大小为 win_length 的 1-D 张量，例如来自 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 (实数输入的默认值)，则仅返回 $\left[0, 1, 2, \dots, \left\lfloor \frac{\text{n\_fft}}{2} \right\rfloor + 1\right]$ 中的 $\omega$ 值，因为实数到复数傅里叶变换满足共轭对称性，即 $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 维实数张量，其中最后一维表示实部和虚部。

如果 return_complex 为 true，则返回大小为 $(* \times N \times T)$ 的复数张量，否则返回大小为 $(* \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) – 可选的窗口函数。形状必须是 1 维且 <= n_fft。默认值： None (被视为所有 $1$ s 的窗口)

• 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() 将恢复已弃用的输出格式。

返回

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

• 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 时存在。

返回类型

Tensor