torch.hamming_window

torch.hamming_window(window_length, *, dtype=None, layout=None, device=None, pin_memory=False, requires_grad=False) → Tensor

Функция окна Хэмминга.

$$w[n] = \alpha - \beta\ \cos \left( \frac{2 \pi n}{N - 1} \right),$$

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

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

Примечание

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

Примечание

Это обобщённая версия функции torch.hann_window().

Параметры:

window_length (int) – размер возвращаемого окна

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

• 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.
• pin_memory (bool, необязательно) – если задано, возвращаемый тензор будет выделен в закреплённой памяти. Работает только для тензоров CPU. По умолчанию: False.
• requires_grad (bool, необязательно) – следует ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.

Возвращает:

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

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

Tensor

torch.hamming_window(window_length, periodic, *, dtype=None, layout=None, device=None, pin_memory=False, requires_grad=False) → Tensor

Функция окна Хэмминга с заданным периодическим режимом.

Параметры:

• 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.
• pin_memory (bool, необязательно) – если задано, возвращаемый тензор будет выделен в закреплённой памяти. Работает только для тензоров CPU. По умолчанию: False.
• requires_grad (bool, необязательно) – следует ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.

Возвращает:

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

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

Tensor

torch.hamming_window(window_length, periodic, float alpha, *, dtype=None, layout=None, device=None, pin_memory=False, requires_grad=False) → Tensor

Функция окна Хэмминга с заданными периодическим режимом и alpha.

Параметры:

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

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

• 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.
• pin_memory (bool, необязательно) – если задано, возвращаемый тензор будет выделен в закреплённой памяти. Работает только для тензоров CPU. По умолчанию: False.
• requires_grad (bool, необязательно) – следует ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.

Возвращает:

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

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

Tensor

torch.hamming_window(window_length, periodic, float alpha, float beta, *, dtype=None, layout=None, device=None, pin_memory=False, requires_grad=False) → Tensor

Функция окна Хэмминга с заданными периодическим режимом, alpha и beta.

Параметры:

• window_length (int) – размер возвращаемого окна
• periodic (bool) – если True, возвращает окно для использования в качестве периодической функции. Если False, возвращает симметричное окно.
• alpha (float) – коэффициент $\alpha$ в приведённом выше уравнении
• beta (float) – коэффициент $\beta$ в приведённом выше уравнении

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

• 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.
• pin_memory (bool, необязательно) – если задано, возвращаемый тензор будет выделен в закреплённой памяти. Работает только для тензоров CPU. По умолчанию: False.
• requires_grad (bool, необязательно) – следует ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.

Возвращает:

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

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

Tensor