get_patch_window_size

function of dascore.utils.patch

source

get_patch_window_size(
    patch: Patch ,
    kwargs: <class ‘dict ,
    samples: bool = False,
    require_odd: bool = False,
    warn_above: int | None[int, None] = None,
    min_samples: int = 1,
    enforce_lt_coord: bool = False,
)-> ’tuple[int, …]’

Get window sizes for patch processing operations.

Parameters

Parameter	Description
patch	The input patch.
kwargs	Keyword arguments specifying dimension names and their window sizes.
samples	If True, kwargs values are in samples; if False, in coordinate units.
require_odd	If True, require odd window sizes. When samples=False, even sizes are adjusted to be odd. When samples=True, even sizes raise ParameterError.
warn_above	If specified, warn when any dimension window size exceeds this value.
min_samples	Minimum number of samples required per dimension.
enforce_lt_coord	If True, reject windows larger than coordinate length.

Returns

Tuple of window sizes for each dimension of the patch data.

Raises

ParameterError If window sizes are too small, or if require_odd=True and samples=True but window size is even.