Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: impedances may be obtained for BrainVision #12861

Merged
merged 3 commits into from
Sep 19, 2024
Merged

DOC: impedances may be obtained for BrainVision #12861

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c98ded0
DOC: impedances may be obtained for BrainVision
sappelhoff Sep 18, 2024
ebaca94
Apply suggestions from code review
sappelhoff Sep 18, 2024
094716d
no roundtrip survive [skip ci] [ci skip]
sappelhoff Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions mne/io/brainvision/brainvision.py
View file
Open in desktop
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