scan_payloads

scan_payloads(
    path: str | pathlib._local.Path | upath.core.UPath | dascore.core.patch.Patch | dascore.core.spool.Spool | dascore.utils.io.IOResourceManager | collections.abc.Iterable[str, Path, UPath, Patch, Spool, IOResourceManager, collections.abc.Iterable[str | pathlib._local.Path | upath.core.UPath | dascore.core.patch.Patch | dascore.utils.io.IOResourceManager[str, Path, UPath, Patch, 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] | Progress = standard,
    snap: bool = True,
)-> ‘list[ScanPayload]’

Scan a potential patch source and return full coordinate payloads.

Parameters

Parameter	Description
path	A resource containing fiber data.
file_format	Format of the file. If not provided DASCore will try to determine it. Only applicable for path-like inputs.
file_version	Version of the file. If not provided DASCore will try to determine it. Only applicable for path-like inputs.
ext	The extensions to map.
timestamp	Time stamp indicating the minimum mtime.
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.

Returns

A list of ScanPayload dictionaries with full coordinate managers and 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.