Window Reference

JaxGB window module

This module provides some well known window functions, which are commonly applied to LISA data and therefore should be included in the fast response.

Retrieve a window

Use the following function to generate a window for a given size, using its name, optional parameters or an already-generated array.

All Scipy window functions and aliases from scipy.signal.window.get_window are supported, in addition to the windows defined in this module.

jaxgb.window.get_window(window: str | tuple | Array, size: int) → Array

Return a window function of given size.

Parameters:

• window – Either a string with the window name or a tuple consisting of window name and window parameters. If None, a rectangular window is returned. If array-like, return as is.

• size – Number of desired points.

Returns:

window.

Return type:

jax.Array of shape (size,)

Custom windows

jaxgb.window.tukey4(n: int = 128, alpha: float = 0.1) → Array

Construct a tukey-taper window to the power 4 of length n.

Parameters:

• n – Number of points in the window.

• alpha – Shape parameter of the Tukey window, representing the fraction of the window inside the cosine tapered region. Default is 0.1.

Returns:

Tukey-taper window.

Return type:

jax.Array of shape (n,)

jaxgb.window.planck(n: int = 128, alpha: float = 0.1) → Array

Construct a Planck-taper window of length n.

Parameters:

• n – Number of points in the window.

• alpha – Fraction of the window length to taper at each end. Must be between 0 and 0.5. Default is 0.1.

Returns:

Planck-taper window.

Return type:

jax.Array of shape (n,)