Skip to content

Commit

Permalink
DOC: impedances may be obtained for BrainVision (#12861)
Browse files Browse the repository at this point in the history
Co-authored-by: Clemens Brunner <[email protected]>
  • Loading branch information
sappelhoff and cbrnr authored Sep 19, 2024
1 parent efe8b6a commit fa841cb
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions mne/io/brainvision/brainvision.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ class RawBrainVision(BaseRaw):
Notes
-----
If the BrainVision header file contains impedance measurements, these may be
accessed using ``raw.impedances`` after reading using this function. However,
this attribute will NOT be available after a save and re-load of the data.
That is, it is only available when reading data directly from the BrainVision
header file.
BrainVision markers consist of a type and a description (in addition to other fields
like onset and duration). In contrast, annotations in MNE only have a description.
Therefore, a BrainVision marker of type "Stimulus" and description "S 1" will be
Expand Down Expand Up @@ -977,6 +983,12 @@ def read_raw_brainvision(
Notes
-----
If the BrainVision header file contains impedance measurements, these may be
accessed using ``raw.impedances`` after reading using this function. However,
this attribute will NOT be available after a save and re-load of the data.
That is, it is only available when reading data directly from the BrainVision
header file.
BrainVision markers consist of a type and a description (in addition to other fields
like onset and duration). In contrast, annotations in MNE only have a description.
Therefore, a BrainVision marker of type "Stimulus" and description "S 1" will be
Expand Down

0 comments on commit fa841cb

Please sign in to comment.