chunk

method of dascore.core.spool.DataFrameSpool source

chunk(
    self: BaseSpool ,
    overlap: int | float | str | datetime64 | Timestamp | None = None,
    keep_partial: bool = False,
    snap_coords: bool = True,
    tolerance: float = 1.5,
    **kwargs ,
)-> Self

Chunk the data in the spool along specified dimensions.

Parameters

Parameter Description
overlap The amount of overlap between each segment, starting with the end of first patch. Negative values can be used to induce gaps.
keep_partial If True, keep the segments which are smaller than chunk size. This often occurs because of data gaps or at end of chunks.
snap_coords If True, snap the coords on joined patches such that the spacing remains constant.
tolerance The number of samples a block of data can be spaced and still be considered contiguous.
kwargs kwargs are used to specify the dimension along which to chunk, eg: time=10 chunks along the time axis in 10 second increments.