Skip to content

DOC: add warning to save DigMontage: ch_names are not saved #12992

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

Closed
sappelhoff wants to merge 1 commit into from
+12 −2
Closed

DOC: add warning to save DigMontage: ch_names are not saved #12992

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions mne/channels/montage.py
View file
Open in desktop
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
Loading