get_window_axis_step

get_window_axis_step(
    patch ,
    overlap = None,
    step = None,
    samples = False,
    **kwargs ,
)-> ‘tuple[int, int, int | None]’

Get window size, axis, and step for a single patch dimension.

Parameters

Parameter	Description
patch	The patch with the dimension and coordinate.
overlap	Optional overlap between adjacent windows. Percent quantities are interpreted relative to the window size.
step	Optional step between adjacent windows. Mutually exclusive with overlap. Percent quantities are interpreted relative to the window size.
samples	If True, numeric window, overlap, and step values are interpreted as sample counts. Quantities with explicit units keep their unit meaning.
**kwargs	Exactly one dimension name and window size.

tuple The window size in samples, the axis for the dimension, and the step in samples. The step is None if neither step nor overlap was provided.