What’s new?¶
Version 0.10 (2022-03-14)¶
This release brings experimental fNIRS suppot, improvements in coordinate frame handling, and various enhancements regarding MRI fiducials.
📝 Notable changes¶
We now have experimental support for fNIRS data (SNIRF format). This is still super fresh, and the respective BIDS enhancement proposal (BEP) has not yet been finalized & accepted into the standard. However, we’re excitied to be able to do this first step towards fNIRS support!
Numerous improvements have been added to enhance our support for various coordinate frames, including those that are not yet supported by MNE-BIDS. These changes are mostly relevant to iEEG users. Please see the detailed list of changes below.
We have added support for storing and reading multiple anatomical landmarks (“fiducials”) for the same participant. This makes it possible, for example, to store different sets of landmarks for each recording session.
It’s now possible to store Neuroscan (CNT) files with MNE-BIDS.
Detailed list of changes¶
🚀 Enhancements¶
Add experimental support for fNIRS (SNIRF) files in
mne_bids.write_raw_bids()
, by Robert Luke (#406)Add support for CNT (Neuroscan) files in
mne_bids.write_raw_bids()
, by Yorguin Mantilla (#924)Add the ability to write multiple landmarks with
mne_bids.write_anat()
(e.g. to have separate landmarks for different sessions) via the newkind
parameter, by Alexandre Gramfort (#955)Similarly,
mne_bids.get_head_mri_trans()
andmne_bids.update_anat_landmarks()
gained a newkind
parameter to specify which of multiple landmark sets to operate on, by Alexandre Gramfort and Richard Höchenberger (#955, #957)Add support for iEEG data in the coordinate frame
Pixels
; although MNE-Python does not recognize this coordinate frame and so it will be set tounknown
in the montage, MNE-Python can still be used to analyze this kind of data, by Alex Rockhill (#976)Add an explanation in 08. Convert iEEG data to BIDS format of why it is better to have intracranial data in individual rather than template coordinates, by Alex Rockhill (#975)
mne_bids.update_anat_landmarks()
can now directly work with fiducials saved from the MNE-Python coregistration GUI ormne.io.write_fiducials()
, by Richard Höchenberger (#977)All non-MNE-Python BIDS coordinate frames are now set to
'unknown'
on reading, by Alex Rockhill (#979)mne_bids.write_raw_bids()
can now write to template coordinates by Alex Rockhill (#980)Add
mne_bids.template_to_head()
to transform channel locations in BIDS standard template coordinate systems tohead
and also provides atrans
, by Alex Rockhill (#983)
🧐 API and behavior changes¶
mne_bids.update_anat_landmarks()
will now by default raise an exception if the requested MRI landmarks do not already exist. Use the newon_missing
parameter to control this behavior, by Richard Höchenberger (#957)mne_bids.get_head_mri_trans()
now raises a warning ifdatatype
orsuffix
of the provided electrophysiologicalmne_bids.BIDSPath
are not set. In the future, this will raise an exception, by Richard Höchenberger`_(:gh:`969)Passing
fs_subject=None
toget_head_mri_trans()
has been deprecated. Please pass the FreeSurfer subject name explicitly, by Richard Höchenberger`_ (#977)Corrupted or missing fiducials in
head
coordinates now raise an error instead of warning inmne_bids.write_raw_bids()
by Alex Rockhill (#980)
🛠 Requirements¶
MNE-BIDS now requires Jinja2 to work with MNE-Python 0.24.
🪲 Bug fixes¶
Forcing EDF conversion in
mne_bids.write_raw_bids()
properly uses theoverwrite
parameter now, by Adam Li (#930)mne_bids.make_report()
now correctly handlesparticipant.tsv
files that only contain aparticipant_id
column, by Simon Kern (#912)mne_bids.write_raw_bids()
doesn’t store age, handedness, and sex inparticipants.tsv
anymore for empty-room recordings, by Richard Höchenberger (#935)When
mne_bids.read_raw_bids()
automatically creates new hierarchical event names based on event values (in cases where the sametrial_type
was assigned to differentvalue``s in ``*_events.tsv
),'n/a'
values will now be converted to'na'
, by Richard Höchenberger (#937)Avoid
DeprecationWarning
inmne_bids.inspect_dataset()
with the upcoming MNE-Python 1.0 release, by Richard Höchenberger (#942)Avoid modifying the instance of
mne_bids.BIDSPath
if validation fails when callingmne_bids.BIDSPath.update()
, by Alexandre Gramfort (#950)mne_bids.get_head_mri_trans()
now respectsdatatype
andsuffix
of the provided electrophysiologicalmne_bids.BIDSPath
, simplifying e.g. reading of derivaties, by Richard Höchenberger (#969)Do not convert unknown coordinate frames to
head
, by Alex Rockhill (#976)