read
read(
path: str | Path ,
file_format: str | None ,
file_version: str | None ,
time: tuple[int | float | str | datetime64 | Timestamp | None, int | float | str | datetime64 | Timestamp | None] | None ,
distance: tuple[float | None, float | None] | None ,
**kwargs ,
)-> BaseSpool
Read a fiber file.
Parameters
Parameter | Description |
---|---|
path | A path to the file to read. |
file_format | A string indicating the file format. If not provided dascore will try to estimate the format. |
file_version | An optional string indicating the format version. |
time | An optional tuple of time ranges. |
distance | An optional tuple of distances. |
*kwargs | All kwargs are passed to the format-specific read functions. |