canonical_name

gwpy.signal.window.canonical_name(name: str) → str

Find the canonical name for the given window in scipy.signal.

Parameters:

namestr

The name of the window you want.

Returns:

realnamestr

The name of the window as implemented in scipy.signal.window.

Raises:

ValueError

If name cannot be resolved to a window function in scipy.signal.

Examples

>>> from gwpy.signal.window import canonical_name
>>> canonical_name("hann")
'hann'
>>> canonical_name("ksr")
'kaiser'