scan_payloads

scan_payloads(
    path: str | pathlib._local.Path | upath.core.UPath | dascore.core.patch_meta.PatchMeta | dascore.core.spool.Spool | dascore.utils.io.IOResourceManager | collections.abc.Iterable[str, Path, UPath, PatchMeta, Spool, IOResourceManager, collections.abc.Iterable[str | pathlib._local.Path | upath.core.UPath | dascore.core.patch_meta.PatchMeta | dascore.utils.io.IOResourceManager[str, Path, UPath, PatchMeta, IOResourceManager]]] ,
    file_format: str | None[str, None] = None,
    file_version: str | None[str, None] = None,
    ext: str | None[str, None] = None,
    timestamp: float | None[float, None] = None,
    progress: Literal[‘standard’, ‘basic’, None, False] | Progress = standard,
    snap: bool | str | collections.abc.Collection[bool, str, collections.abc.Collection[str]] = True,
)-> ‘list[dc.PatchMeta]’

Scan a potential patch source and return full coordinate payloads.

Parameters

Parameter	Description
path	A resource containing fiber data.
file_format	File format. DASCore detects it when omitted. Only applies to path-like inputs.
file_version	File version. DASCore detects it when omitted. Only applies to path-like inputs.
ext	The extensions to map.
timestamp	Minimum modification time.
progress	The type of progress bar to use. None disables the progress bar.
snap	If True (the default), formats may represent stored sample times as an idealized uniform range. If False, returned coords represent stored coordinate values exactly when the format exposes them. A coordinate name or tuple of names enables snapping only for those coordinates.

Returns

A list of PatchMeta objects with full coordinate managers, dtype, and private source provenance.

Note

Scan payloads retain real coordinate arrays and can use substantially more memory than scan summaries. Prefer scanning specific files and discard payloads promptly when probing many resources.