scan

method of dascore.io.core.FiberIO

source

scan(
    self ,
    resource ,
    snap: bool = True,
    **kwargs ,
)-> ‘list[ScanPayload]’

Return patch-local metadata and exact coords for a resource.

Each item in the returned list should be a ScanPayload dict with exact coords and attrs for one logical patch. Do not populate source metadata such as path, file_format, or file_version; DASCore attaches those in the higher-level dc.scan(...) pipeline.

Multi-patch formats should set source_patch_key when needed so DASCore can reload the same logical patch later.

Parameters

Parameter	Description
resource	The resource to scan.
snap	If True (the default), formats may represent stored sample times as an idealized uniform range. If False, returned coords must represent stored coordinate values exactly. This is a documented no-op for formats whose coordinates are defined by start, step, and sample count metadata.