Skip to content

Commit 927f88d

Browse files
MAINT, DOC: add eyetracking & Dipole convention for loc array to Info class API (mne-tools#12023)
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
1 parent e5a9db2 commit 927f88d

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

mne/_fiff/meas_info.py

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -998,6 +998,7 @@ def _check_helium_info(helium_info):
998998
return helium_info
999999

10001000

1001+
# TODO: Add fNIRS convention to loc
10011002
class Info(dict, SetChannelsMixin, MontageMixin, ContainsMixin):
10021003
"""Measurement information.
10031004
@@ -1185,11 +1186,22 @@ class Info(dict, SetChannelsMixin, MontageMixin, ContainsMixin):
11851186
kind : int
11861187
The kind of channel, e.g. ``FIFFV_EEG_CH``.
11871188
loc : array, shape (12,)
1188-
Channel location. For MEG this is the position plus the
1189-
normal given by a 3x3 rotation matrix. For EEG this is the
1190-
position followed by reference position (with 6 unused).
1191-
The values are specified in device coordinates for MEG and in
1192-
head coordinates for EEG channels, respectively.
1189+
Channel location information. The first three elements ``[:3]`` always store
1190+
the nominal channel position. The remaining 9 elements store different
1191+
information based on the channel type:
1192+
1193+
MEG
1194+
Remaining 9 elements ``[3:]``, contain the EX, EY, and EZ normal
1195+
triplets (columns) of the coil rotation/orientation matrix.
1196+
EEG
1197+
Elements ``[3:6]`` contain the reference channel position.
1198+
Eyetrack
1199+
Element ``[3]`` contains information about which eye was tracked
1200+
(-1 for left, 1 for right), and element ``[4]`` contains information
1201+
about the the axis of coordinate data (-1 for x-coordinate data, 1 for
1202+
y-coordinate data).
1203+
Dipole
1204+
Elements ``[3:6]`` contain dipole orientation information.
11931205
logno : int
11941206
Logical channel number, conventions in the usage of this
11951207
number vary.

0 commit comments

Comments
 (0)