From 73f60ce0d23d6c4d4234f84b7ac0cf3cecd65ee0 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Wed, 27 Nov 2024 11:35:32 +0100 Subject: [PATCH] DOC: add warning to save DigMontage: ch_names are not saved --- mne/channels/montage.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/mne/channels/montage.py b/mne/channels/montage.py index 5dad657a75c..f12a43e0795 100644 --- a/mne/channels/montage.py +++ b/mne/channels/montage.py @@ -409,6 +409,16 @@ def save(self, fname, *, overwrite=False, verbose=None): The filename to use. Should end in .fif or .fif.gz. %(overwrite)s %(verbose)s + + See Also + -------- + read_dig_fif + + Notes + ----- + .. warning:: The channel names will **not** be saved, so + when reading back via :func:`mne.channels.read_dig_fif`, + new channel names will be made up on the spot. """ coord_frame = _check_get_coord_frame(self.dig) write_dig(fname, self.dig, coord_frame, overwrite=overwrite) @@ -809,9 +819,9 @@ def read_dig_dat(fname): def read_dig_fif(fname): - r"""Read digitized points from a .fif file. + r"""Read digitized points from a FIF file. - Note that electrode names are not present in the .fif file so + Note that electrode names are not present in the FIF file so they are here defined with the convention from VectorView systems (EEG001, EEG002, etc.)