Skip to content

Commit

Permalink
DOC: add warning to save DigMontage: ch_names are not saved
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Nov 27, 2024
1 parent e06873d commit 21b99ca
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions mne/channels/montage.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.)
Expand Down

0 comments on commit 21b99ca

Please sign in to comment.