seek_localize.read_dig_bids

seek_localize.read_dig_bids(fname, root, intended_for: Optional[str] = None)

Read electrode coordinates from BIDS files.

TODO: improve to error check coordinatesystem.

Parameters

fnamestr | pathlib.Path

File path to the electrodes.tsv file, or file path to the coordsystem.json file. Each one will be inferred based on the BIDS entities inside the filename.

intended_forstr | None

Optional parameter to tell function path of the Nifti image to interpret sensor coordinates for.

Returns

sensorsseek_localize.Sensors

A data class containing the electrode sensors.