Reader function for Raw FIF data. Parameters ---------- fname : path-like | file-like The raw filename to load. For files that have automatically been split, the split part will be automatically loaded. Filenames should end with raw.fif, raw.fif.gz, raw_sss.fif,
(
fname, allow_maxshield=False, preload=False, on_split_missing="raise", verbose=None
)
| 498 | |
| 499 | @fill_doc |
| 500 | def read_raw_fif( |
| 501 | fname, allow_maxshield=False, preload=False, on_split_missing="raise", verbose=None |
| 502 | ) -> Raw: |
| 503 | """Reader function for Raw FIF data. |
| 504 | |
| 505 | Parameters |
| 506 | ---------- |
| 507 | fname : path-like | file-like |
| 508 | The raw filename to load. For files that have automatically been split, |
| 509 | the split part will be automatically loaded. Filenames should end |
| 510 | with raw.fif, raw.fif.gz, raw_sss.fif, raw_sss.fif.gz, raw_tsss.fif, |
| 511 | raw_tsss.fif.gz, or _meg.fif. If a file-like object is provided, |
| 512 | preloading must be used. |
| 513 | |
| 514 | .. versionchanged:: 0.18 |
| 515 | Support for file-like objects. |
| 516 | allow_maxshield : bool | str (default False) |
| 517 | If True, allow loading of data that has been recorded with internal |
| 518 | active compensation (MaxShield). Data recorded with MaxShield should |
| 519 | generally not be loaded directly, but should first be processed using |
| 520 | SSS/tSSS to remove the compensation signals that may also affect brain |
| 521 | activity. Can also be "yes" to load without eliciting a warning. |
| 522 | %(preload)s |
| 523 | %(on_split_missing)s |
| 524 | %(verbose)s |
| 525 | |
| 526 | Returns |
| 527 | ------- |
| 528 | raw : instance of Raw |
| 529 | A Raw object containing FIF data. |
| 530 | |
| 531 | Notes |
| 532 | ----- |
| 533 | .. versionadded:: 0.9.0 |
| 534 | |
| 535 | When reading a FIF file, note that the first N seconds annotated |
| 536 | ``BAD_ACQ_SKIP`` are **skipped**. They are removed from ``raw.times`` and |
| 537 | ``raw.n_times`` parameters but ``raw.first_samp`` and ``raw.first_time`` |
| 538 | are updated accordingly. |
| 539 | """ |
| 540 | return Raw( |
| 541 | fname=fname, |
| 542 | allow_maxshield=allow_maxshield, |
| 543 | preload=preload, |
| 544 | verbose=verbose, |
| 545 | on_split_missing=on_split_missing, |
| 546 | ) |
| 547 | |
| 548 | |
| 549 | def _path_from_fname(fname) -> Path | None: |