sample_windows

hypercoil.functional.window.sample_windows(allow_overlap: bool = False, create_new_axis: bool = False) → Callable

Sample windows from a tensor.

Parameters:

allow_overlapbool (default: False)

Whether to allow windows to overlap.

create_new_axisbool (default: False)

Whether to create a new axis for the windows. Default: False. If this is True, the new axis will be inserted at multiplying_axis. Otherwise, the windows will be multiplied along the existing multiplying_axis.

Returns:

callable

A function that samples windows from a tensor.