scan
scan(
path_or_spool: Path | str | Patch | BaseSpool ,
file_format: str | None ,
file_version: str | None ,
ignore: bool ,
)-> list[PatchFileSummary]
Scan a file, return the summary dictionary.
Parameters
Parameter | Description |
---|---|
path_or_spool | The path the to file to scan |
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. |
ignore | If True, ignore non-DAS files by returning an empty list, else raise UnknownFiberFormat if unreadable file encountered. |
Note
The summary dictionaries contain the following fields: file_version file_format path