scan_to_df

function of dascore.io.core

source

scan_to_df(
    path: Path | str | Patch | BaseSpool ,
    file_format: str | None ,
    file_version: str | None ,
    ignore: bool ,
)-> DataFrame

Scan a path, return a dataframe of contents.

Parameters

Parameter	Description
path	The path the to file to scan
file_format	Format of the file. If not provided DASCore will try to determine it.
ignore	If True, ignore non-DAS files by returning an empty list, else raise UnknownFiberFormat if unreadable file encountered.

Returns

Return a dataframe with columns: data_type data_category data_units time_min time_max d_time time_units distance_min distance_max d_distance distance_units instrument_id cable_id dims tag station network history file_version file_format path