pop_loadbv

pop_loadbv(path: str | Path, hdrfile: str | Path | None = None, srange: Any = None, chans: Any = None, metadata: bool = False, *, return_com: Literal[False] = False) → dict[str, Any]

pop_loadbv(path: str | Path, hdrfile: str | Path | None = None, srange: Any = None, chans: Any = None, metadata: bool = False, *, return_com: Literal[True]) → tuple[dict[str, Any], str]

Load a BrainVision .vhdr recording.

Parameters:

• path (str | Path) – Directory containing the recording, or the full header path.

• hdrfile (str | Path | None) – Header filename when path is a directory.

• srange (Any) – One-based first sample, or inclusive [first, last] range.

• chans (Any) – One-based channel indices to load, in the requested order.

• metadata (bool) – Read metadata and events without loading signal samples.

• return_com (bool) – Return (EEG, command) for command-history workflows.

Returns:

An EEGPrep EEG dictionary, optionally paired with its replay command.

Return type:

dict[str, Any] | tuple[dict[str, Any], str]

Notes

Voltage channels are converted to EEGPrep’s microvolt convention. The original BrainVision unit and resolution remain available as chanlocs[*]["bvunit"] and chanlocs[*]["bvresolution"].