recommended_overlap

gwpy.signal.window.recommended_overlap(name: str, nfft: int | None = None) → float | int

Return the recommended fractional overlap for the given window.

If nfft is given, the return is in samples.

Parameters:

namestr

The name of the window you are using.

nfftint

The length of the window.

Returns:

rovfloat, int

The recommended overlap (ROV) for the given window, in samples if nfft is given (int), otherwise fractional (float).

Examples

>>> from gwpy.signal.window import recommended_overlap
>>> recommended_overlap("hann")
0.5
>>> recommended_overlap("blackmanharris", nfft=128)
85