scan

function of dascore.io.core source

scan(
    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, False] | Progress = standard,
)-> ‘list[PatchSummary]’

Scan a potential patch source and return its patch summaries.

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 Progress display. None disables it, "basic" suits low-latency
operations, and a rich.progress.Progress subclass customizes it.

Returns

A list of PatchSummary instances.

Examples

import dascore as dc

summary = dc.scan("examples://terra15_das_1_trimmed.hdf5")[0]

See Also

scan_payloads Return full coordinate managers instead of envelope summaries.