window

module of dascore.utils source

One way to say “a window of X, overlapping by Y” along a patch’s dimensions.

Every windowed patch function takes its windows as dimension keywords – time=0.5, distance=32 * m, time=16 with samples=True – and some take an overlap or step between windows besides. Turning those into sample counts is one job, and :func:resolve_window does it for all of them, returning a :class:Window.

What differs between functions is policy, not conversion: whether an even window is adjusted or refused, whether a window longer than the coordinate is refused, what a missing overlap means. Each of those is a keyword here, stated by the function which wants it.

Functions

Name Description
resolve_window Return the window a call’s dimension keywords describe, in samples.

Classes

Name Description
Window A window along some of a patch’s dimensions, in samples.
Windowed What a window is resolved against: a patch, or its metadata alone.