torch.bartlett_window

torch.bartlett_window(window_length, periodic=True, *, dtype=None, layout=torch.strided, device=None, requires_grad=False) → Tensor

Функция окна Бартлетта.

$$w[n] = 1 - \left| \frac{2n}{N-1} - 1 \right| = \begin{cases} \frac{2n}{N - 1} & \text{if } 0 \leq n \leq \frac{N - 1}{2} \\ 2 - \frac{2n}{N - 1} & \text{if } \frac{N - 1}{2} < n < N \\ \end{cases},$$

где $N$ — полный размер окна.

Входной параметр window_length — это положительное целое число, определяющее размер возвращаемого окна. Флаг periodic определяет, обрезает ли возвращаемое окно последнее повторяющееся значение симметричного окна и готово ли оно к использованию в качестве периодического окна с такими функциями, как torch.stft(). Поэтому, если periodic равен true, то $N$ в приведённой выше формуле фактически равен $\text{window\_length} + 1$. Также всегда выполняется равенство torch.bartlett_window(L, periodic=True) и torch.bartlett_window(L + 1, periodic=False)[:-1]).

Примечание

Если window_length $=1$, возвращаемое окно содержит единственное значение 1.

Параметры:

• window_length (int) – размер возвращаемого окна
• periodic (bool, необязательно) – Если True, возвращает окно для использования в качестве периодической функции. Если False, возвращает симметричное окно.

Именованные аргументы:

• dtype (torch.dtype, необязательно) – требуемый тип данных возвращаемого тензора. По умолчанию: если None, используется глобальное значение по умолчанию (см. torch.set_default_dtype()). Поддерживаются только типы с плавающей точкой.
• layout (torch.layout, необязательно) – требуемый формат возвращаемого тензора окна. Поддерживается только torch.strided (плотный формат).
• device (torch.device, необязательно) – требуемое устройство для возвращаемого тензора. По умолчанию: если None, используется текущее устройство для типа тензора по умолчанию (см. torch.set_default_device()). device будет соответствовать CPU для типов тензоров CPU и текущему устройству CUDA для типов тензоров CUDA.
• requires_grad (bool, необязательно) – Нужно ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.

Возвращает:

Одномерный тензор размера $(\text{window\_length},)$, содержащий окно

Тип возвращаемого значения:

Tensor