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

Scan a potential patch source, return a list of patch summaries.

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 progress bar and
“basic” is best for low latency scenarios. Can also accept a subclass
of rich.progress.Progress.

Returns

A list of PatchSummary instances.

Examples

import dascore as dc
from dascore.utils.downloader import fetch

file_path = fetch("terra15_das_1_trimmed.hdf5")
summary = dc.scan(file_path)[0]

See Also

scan_payloads Return full coordinate managers instead of envelope summaries.