NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI
PyPI
MNE-Python is an open-source Python package for exploring, visualizing, and analyzing human neurophysiological data. It provides methods for data input/output, preprocessing, visualization, source estimation, time-frequency analysis, machine learning, and statistics.
Latest stable
1.13.2
Last release 2 months ago
11 Sep 2026
Ships fairly regularly
a new release about every 2 months
Some releases are documented
notes for 29 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
15 years old
89 releases · first in 2011
Drag across the ruler to compare, or tap a release to open it.
Nothing published for this version
Nothing published for this version
In mne.Evoked.animate_topomap the vmin and vmax keyword arguments have been deprecated in favor of vlim and will be removed in MNE 1.14, by Eric Larso…
Updated minimum for:
Core dependency matplotlib >= 3.9
Changes implemented via CI action created by `Thomas Binns`_. (#13899)
Updated minimum for:
Optional dependency scikit-learn >= 1.5
Changes implemented via CI action created by `Thomas Binns`_. (#13916)
Switch the default Qt bindings from PyQt6 to PySide6. As a result, mne[full] now includes PySide6 instead of PyQt6. Users who prefer PyQt6 can continue to use mne[full-pyqt6], and mne[full-pyside6] remains available as an alias for mne[full]. Changes by `Clemens Brunner`_. (#13960)
PyQt5 is no longer an officially supported Qt binding, by `Eric Larson`_. (#13981)
Updated minimum for:
Core dependency numpy >= 2.0, < 3
Core dependency scipy >= 1.14
Changes implemented via CI action created by `Thomas Binns`_. (#14023)
Updated minimum for:
Optional dependency pyvista >= 0.44
Changes implemented via CI action created by `Thomas Binns`_. (#14048)
Raised minimum versions of some optional dependencies to comply with MNE-Python's SPEC0-like policy, and added them to the set kept up to date automatically by the spec_zero CI job, by `Eric Larson`_:
Optional dependency dipy >= 1.9
Optional dependency mne-qt-browser >= 0.6
Optional dependency nibabel >= 5.2
Optional dependency nilearn >= 0.10
Optional dependency numba >= 0.60 (#14108)
Updated minimum Python version to 3.11, by `Thomas Binns`_. (#14140)
Updated minimum for:
Core dependency numpy >= 2.1, < 3
Changes implemented via CI action created by `Thomas Binns`_. (#14193)
Fix bug where mne.io.read_raw_eyelink fails to handle data starting with empty blocks or blocks starting with missing values, by Varun Kasyap Pentamaraju and `Qian Chu`_. (#13571)
Fix mode parameter in ~mne.minimum_norm.get_point_spread and ~mne.minimum_norm.get_cross_talk to correctly map public mode names ('max', 'svd') to internal names, expose previously hidden modes 'sum' and 'maxval' in the public API, and raise ValueError for invalid mode values, by Famous Raj Bhat. (#13754)
Fixed incorrect label orientation for nodes in the 0–90° polar range (the 12–3 o'clock quadrant) of the connectivity circle plot, by Pavel Popov. (#13855)
Fixed an indexing bug in fNIRS support in mne.io.BaseRaw.interpolate_bads (and related methods) that could errantly use incorrect donor channels, by Kalle Makela. (#13856)
Fix handling of optional dependencies that don't specify a version attribute, by Baris Talar. (#13870)
Improved error message when FreeSurfer executable is not found, by Ayushi Satodiya. (#13874)
Fix mne.set_eeg_reference so that passing a list of channel types with projection=False and ref_channels="average" now references each channel type independently by default (matching the projection=True path), by Ben Tang. Previously a single average was computed across the union of the listed types. Pass joint=True for the previous behavior. (#13920)
Fix mne.preprocessing.eyetracking.interpolate_blinks so that all annotation descriptions passed via match are interpolated over, rather than only BAD_blink ones, by Vincent Gao. (#13940)
Fix bug in mne.read_annotations where reading a .txt file containing a single channel-specific annotation raised an AttributeError, by Piotr Durka. (#13962)
Fix bug where mne.preprocessing.write_fine_calibration wrote internal MEG channel names (e.g. MEG0113) instead of the bare channel numbers (e.g. 113) that MaxFilter expects, breaking round trips of Neuromag calibration files, by Apoorva Verma. (#13999)
Fix mne.preprocessing.eyetracking.read_eyelink_calibration to decode .asc files as UTF-8 instead of ASCII, so non-ASCII characters in MSG lines no longer raise a UnicodeDecodeError, by Cedric Conday. (#14002)
Fix the tube method of the abstract 3D renderer, whose signature was missing the opacity parameter that the PyVista implementation accepts, and whose docstring documented backface_culling, which tube does not take, while omitting normalized_colormap, which it does, by Anton Karpov. (#14125)
Use a fixed normalized Kuiper-index cutoff of 0.3 for automatic CTPS ECG detection in mne.preprocessing.ICA.find_bads_ecg, independent of sampling frequency and trial count, by Amirali Moradniaei. (#14279)
Fix incorrect TFCE scores in mne.stats.permutation_cluster_test, mne.stats.permutation_cluster_1samp_test, and related functions when using 1D data or non-unit threshold steps. The cluster extent was always counted as 1 for 1D data, and the per-threshold height contribution did not match the reference values, by Antonio Elias Sánchez Soto. (#14286)
Fixed a bug in mne.stats.spatio_temporal_cluster_1samp_test and related spatio-temporal permutation cluster functions where, in rare cases, clusters that should have been joined by a chain of spatial and temporal adjacency steps were incorrectly reported as separate clusters, by `Sharif Haason`_. (#13731)
Make channel name labels easier to read in mne.viz.plot_alignment, by `Aman Srivastava`_. (#13773)
Improved colocated OPM topomap handling by recognizing additional OPM coil types (FieldLine and Kernel), by `Pragnya Khandelwal`_. (#13825)
Fix bug where logging messages were sometimes errantly printed, by `Eric Larson`_. (#13843)
Add a memmap keyword argument to mne.io.BaseRaw.load_data, allowing loading deferred raw data into a memory-mapped file after object creation, by `Aniket Singh Yadav`_. (#13858)
Completed triaxial OPM topomap grouping by rendering separate radial and tangential maps in ~mne.viz.plot_evoked_topomap and ~mne.preprocessing.ICA.plot_components, and fixed shape-mismatch crashes in ~mne.viz.plot_projs_topomap and ~mne.Evoked.animate_topomap with colocated OPM channels, by `Pragnya Khandelwal`_. (#13866)
Fix bug with mne.preprocessing.ICA.plot_properties when using reject in mne.preprocessing.ICA.fit, by `Eric Larson`_. (#13885)
Fix bug where picks was ignored in mne.Epochs.apply_function when channel_wise=False, by `Thomas Binns`_. (#13894)
Fix iteration errors in mne.io.read_raw_nihon when reading log files, by `Tom Ma`_. (#13915)
Fix bug with mne.set_eeg_reference not working when passing a single channel name as string, by `Michael Straube`_. (#13917)
Use mffpy-backed parsing for EGI MFF event tracks while tolerating nanosecond timestamps that some files store in beginTime, by `Pragnya Khandelwal`_. (#13932)
Fix channel ordering bug in mne.viz.plot_compare_evokeds when axes="topo", by `Lifeng Qiu Lin`_. (#13943)
Fixed bug where mne.sys_info would silently change the active Matplotlib backend (e.g. when ipympl is installed) as an import-time side effect, by `Stefan Appelhoff`_. (#13963)
Fix the error message raised when a requested FIR filter_length is too short, which reported half the actual transition bandwidth, by `Cedric Conday`_. (#14005)
Fix a crash (AttributeError on NoneType) when picking channels on a ~mne.io.Raw whose _orig_units is None, by `Cedric Conday`_. (#14006)
Fixed several error messages that displayed literal {...} placeholder text instead of the intended values, due to a missing f string prefix (in mne.SourceEstimate, mne.io.read_raw_hitachi, mne.preprocessing.compute_current_source_density, and mne.preprocessing.maxwell_filter), by `Cedric Conday`_. (#14008)
Fix spatial_colors is not "auto" as described by docstring in mne.viz.plot_evoked. Fix empty topomap created when clicking after time range selection in mne.viz.plot_evoked, by `Lifeng Qiu Lin`_. (#14025)
Fix bug where mne.concatenate_epochs could silently concatenate epochs with conflicting event_id dicts, by `Eric Larson`_. (#14051)
Fixed two bugs in how SSS information is stored and read: mne.preprocessing.maxwell_filter recorded which multipole moments it had kept in the wrong order (the filtered data itself was unaffected), and mne.compute_rank reported the full MEG rank rather than the reduced SSS rank for data processed with MaxFilter™-3.0, by `Eric Larson`_. (#14059)
Fix figures not being displayed in notebook-style frontends when using a Matplotlib inline backend, by `Mingjian He`_. (#14076)
Fix Qt browser close messages from mne.io.Raw.plot appearing in the wrong Jupyter notebook cell, by `Mingjian He`_. (#14077)
When concatenating ~mne.io.Raw objects containing annotations, also merge the extras fields, by `Marijn van Vliet`_ (#14084)
Fixed ~mne.viz.plot_evoked_topomap and ~mne.viz.plot_sensors (and the plot_sensors methods) to follow Matplotlib's blocking behavior when show=True instead of returning immediately; plot_sensors keeps its block argument (default now None), by `Clemens Brunner`_. (#14098)
Fixed bug in mne.io.Raw.plot where, with the matplotlib backend and group_by="selection", the channel-selection radio buttons no longer all appeared selected while in butterfly mode, by `Eric Larson`_. (#14108)
Fixed bug where dialogs of mne.io.Raw.plot did not respect dark mode, by `Eric Larson`_. (#14109)
mne.chpi.filter_chpi now smoothly interpolates the fitted cHPI/line amplitudes by default (interp="hann"), by `Eric Larson`_. (#14112)
Speed up mne.filter.notch_filter and related methods when method="spectrum_fit" by caching repeated multitaper window setup, by `Clemens Brunner`_. (14116) (#14114)
Fix bug in mne.gui.coregistration where "Save Scaled Anatomy" failed with an Error scaling ... message and no scaled subject was created, by `Eric Larson`_. (#14132)
Fix bug in mne.preprocessing.find_bad_channels_maxwell and mne.preprocessing.maxwell_filter: data is processed in chunks, but when head_pos was provided, the head positions from the beginning of the recording were used for each chunk rather than from the chunk's time window. In find_bad_channels_maxwell this affected every interval after the first, and in maxwell_filter every segment following a segment skipped due to skip_by_annotation, as well as every chunk containing no head position update at all, by `Christian Brodbeck`_. (#14142)
Allow mne.read_epochs_eeglab to read epoched .set files without event information, by `Daria Agafonova`_. (#14163)
Add CUDA support to mne.io.Raw.apply_hilbert and related data classes, allowing mne.preprocessing.annotate_muscle_zscore to use n_jobs='cuda', by `Daria Agafonova`_. (#14164)
Fixed a bug where block=True in plotting functions such as mne.io.Raw.plot ran the Qt application's own event loop, which deadlocked or silently did not block when something else already owned that loop (for example inside a notebook kernel), and could not be interrupted, by `Eric Larson`_. (#14179)
Fix a bug that caused mne.io.Raw.pick and mne.io.Raw.drop_channels to fail on the result of mne.preprocessing.maxwell_filter when movement compensation was enabled with head_pos, by `Christian Brodbeck`_. (#14180)
Fix bug where assigning into mne.Annotations.description (e.g., annotations.description[0] = "a_longer_description") silently truncated the new value, by storing descriptions using NumPy's variable-width string dtype (numpy.dtypes.StringDType) instead of a fixed-width "<U" dtype, by `Eric Larson`_. (#14186)
Fixed a bug where volumetric source estimates plotted with signed data and the default MIP mapping (volume_options=dict(blending="mip")) rendered the negative half on top of the positive half from every viewing angle, by `Eric Larson`_. (#14187)
Fix mne.concatenate_epochs failing on epochs cropped after baseline correction, by `Kalle Makela`_. (#14188)
Fix reading CTF datasets whose .hc file spells the head coils Nasion/LPA/RPA, by `Seyed Yahya Shirazi`_. (#14191)
Fix bug where clicking on the brain in mne.viz.Brain did not work with recent PyVista versions, by `Eric Larson`_. (#14202)
Preserve caller-owned memory-mapped preload files after Raw objects are destroyed, by `Bruno Aristimunha`_. (#14213)
Fix bug where mne.io.read_raw_ant and mne.io.read_raw_curry ignored projections and non-boolean preload values respectively when reading data lazily, by `Bruno Aristimunha`_. (#14216)
Fix bug where mne.io.anonymize_info could set an incorrect date in info["proc_history"], causing an OverflowError when writing FIF files anonymized with a large daysback, by `Eric Larson`_. (#14248)
Fix bug where selecting epochs (e.g., epochs[0]) copied the entire data array, by `Eric Larson`_. (#14262)
Fix bug where mne.io.Raw.interpolate_to and related methods with method="spline" did not center the target sensor positions on the fitted sphere origin, by `Eric Larson`_. (#14266)
Rename standard_1005 and standard_1020 montages to colin27_1005 and colin27_1020, respectively. If you used standard_1005 or standard_1020, either switch to the new names colin27_1005 and colin27_1020 or use the new spherical montages spherical_1005, spherical_1010, or spherical_1020, which provide idealized template locations on a sphere (useful for plotting). By `Clemens Brunner`_. (#13903)
In mne.Evoked.animate_topomap the vmin and vmax keyword arguments have been deprecated in favor of vlim and will be removed in MNE 1.14, by `Eric Larson`_. (#13905)
In mne.viz.iter_topography, the on_pick callable for sub-figures now has a new parameter orig_fig that refers to the main figure. To preserve backward compatibility, it is made optional. By `Lifeng Qiu Lin`_. (#13968)
The block parameter of mne.time_frequency.Spectrum.plot_topo, the legacy plot_psd_topo methods, and mne.viz.plot_raw_psd_topo is deprecated and will be removed in MNE 1.14; these plots now follow Matplotlib's blocking behavior, by `Clemens Brunner`_. (#14098)
Deprecate the epochs parameter of mne.compute_covariance in favor of inst; it will be removed in MNE 1.14, by `Hamza Abdelhedi`_. (#14129)
The matplotlib 3D backend for plotting source estimates (backend="matplotlib" in mne.viz.plot_source_estimates, along with the spacing argument that only affects it) has been deprecated and will be removed in MNE 1.14; use a proper 3D backend such as pyvistaqt instead, by `Eric Larson`_. (#14160)
Add rng parameters to APIs that use randomness, while retaining keyword-only seed and random_state for compatibility (9233 by `Bruno Aristimunha`_). (#14199)
Speed up mne.stats.spatio_temporal_cluster_1samp_test and related permutation cluster functions via precomputed sum-of-squares for sign-flip t-tests and SciPy connected-components clustering (~5x), by Sharif Haason. (#13731)
Fix mne.preprocessing.nirs.beer_lambert_law to support explicitly provided sd_distances during Beer-Lambert conversion. When valid source-detector distances are already present in raw.info, overriding them now emits a warning, and when all inferred distances are invalid and no explicit distances are provided, a ValueError is raised instead of silently producing zero concentrations, by Kalle Makela. (#13875)
Added basic support for TD fNIRS data, by Zahra M. Aghajan, Julien Dubois, John Griffiths, `Robert Luke`_, and `Eric Larson`_. (#13938)
Added public mne.viz.LayeredMesh class (previously private _LayeredMesh) with a smooth_mat attribute for efficient real-time source-space data streaming. Added Brain.layered_meshes attribute to access meshes after plotting, and a key parameter to mne.viz.Brain.add_data for named overlays, by Payam Sadeghi-Shabestari. (#13970)
Allow subclasses of MNEBrowseFigure to be passed to plot_raw/plot_epochs, as well as the corresponding plot(...) methods of the raw and epochs classes, by Frankie Robertson (#13979)
Added meanlogratio baselining mode to mne.time_frequency.EpochsTFR.apply_baseline and related functions, by Virginie van Wassenhove. (#14205)
Added tut-gal-decoding, a tutorial on Generalization Across Location (GAL) and Time-GAL decoding of EEG data, by `Bruno Aristimunha`_ and Alejandro Santos Mayo. (#14211)
Speed up the permutation cluster tests (e.g., mne.stats.spatio_temporal_cluster_1samp_test), especially with TFCE, by grouping cluster indices with a single sort instead of one pass over the data per cluster, by Luca Kaemmer. (#14217)
Added 4 new ERP measures: peak latency, peak amplitude, fractional peak latency, and fractional area latency. By `Jacob Woessner`_ and Beliz Sertcan Gökmen. (#14221)
Add mne.label_adjacency and mne.volume_label_adjacency for determining whether labels are adjacent (touching) or not, by Raphaël Bordas and `Marijn van Vliet`_ (#14226)
Add mne.io.BaseRaw.get_annotation_spans to convert annotation spans to the time reference used by Raw data and plotting methods, by Tim Anderson. (#14240)
Add single-model JAMICA support to mne.preprocessing.ICA via method="jamica", by Sina Esmaeili. (#14247)
Add mne.preprocessing.eyetracking.find_blinks to detect blinks in eye-tracking data from pupil dropouts and return them as ~mne.Annotations, by `Stefan Appelhoff`_. (#12946)
Add a GUI for interactive guided dipole fitting (mne.gui.dipolefit), by `Marijn van Vliet`_ (#13074)
It is now possible to concatenate raw objects with mne.concatenate_raws as long as they inherit from ~mne.io.BaseRaw, even if their specific types differ (e.g., ~mne.io.Raw and ~mne.io.RawArray), by `Clemens Brunner`_. (#13263)
Add a preprocessing example showing how to explore epoch quality before rejection using robust statistics (peak-to-peak amplitude, variance, and kurtosis) inspired by FASTER (Nolan et al., 2010) and Delorme et al. (2007), by `Aman Srivastava`_. (#13710)
Add annotation_colors parameter to mne.io.Raw.plot and mne.Epochs.plot to allow users to specify custom colors for annotations by passing a dict mapping annotation description strings to colors (for example, annotation_colors=dict(bad_segment="orange")), by `Clemens Brunner`_. (#13838)
Add dark theme support (theme="light", "dark", or "auto") to the 'matplotlib' browser backend used by mne.io.Raw.plot, mne.Epochs.plot, and mne.preprocessing.ICA.plot_sources, by `Clemens Brunner`_. (#13861)
Add overrides parameter to mne.io.read_raw_brainvision for reading non-spec-compliant .vhdr files where the header contradicts the actual layout (e.g. renamed BIDS siblings, missing MarkerFile=, truncated [Channel Infos]). Accepts a dict with keys data_fname, marker_fname, n_channels, sfreq, ch_names, units_fallback, data_orientation, data_format, and binary_format; see the function docstring for details. Missing or empty MarkerFile= is now also tolerated natively (per the BV Core Data Format spec). When MarkerFile= names a path that does not exist (common after BIDS renames), mne.io.read_raw_brainvision now falls back to the co-located <stem>.vmrk next to the .vhdr and warns, instead of raising FileNotFoundError, by `Bruno Aristimunha`_. (#13884)
Add idealized spherical 10–05, 10–10, and 10–20 montages (spherical_1005, spherical_1010, spherical_1020), by `Clemens Brunner`_. (#13903)
Improved mne.Report by:
Using "agg" backend for 2D plots to avoid windows unnecessarily popping up
Improving ~mne.Report.add_stc by using direct capture of brain images, allowing direct control of image size using stc_plot_kwargs["size"]
Improving ~mne.Report.add_evokeds evoked topomap plotting by using mne.Evoked.animate_topomap with butterfly=True rather than re-plotting each topomap in a loop
Also improved mne.Evoked.animate_topomap by deduplicating code with mne.Evoked.plot_topomap. Changes by `Eric Larson`_. (#13905)
Add support for reading cross-talk and fine-calibration embedded in FIF files during acquisition into raw.info["cross_talk"] and raw.info["fine_calibration"], respectively, by `Eric Larson`_. (#13911)
Add support for interactive label browsing using hover=True in mne.viz.Brain.add_annotation, by `Eric Larson`_. (#13931)
Added 'fsaverage_1005' montage, which is a slightly improved version of the existing 'colin27_1005' montage (known in 1.12 and older as 'standard_1005'). The electrodes have already been mapped to the fsaverage head surface. Changes by `Eric Larson`_. (#13936)
Add support for automatic cross_talk and fine_calibration adjustments in mne.preprocessing.maxwell_filter when these are stored in mne.Info during acquisition (e.g., by newer MEGIN acquisition software), by `Eric Larson`_. (#13942)
Added the n_components parameter to ICA plotting and report generation functions to allow dynamic control over the number of components displayed by Athish M. (#13958)
Added a volume_options["interpolation"] option to mne.viz.plot_source_estimates and mne.viz.Brain.add_data to control the interpolation method used for volume rendering. It can be "linear" (default) or "nearest". Changes by `Eric Larson`_. (#13966)
Include label and description fields when reading EGI mff files, by `Martin Oberg`_. (#13967)
Add TimeChange behaviour for mne.viz.plot_evoked_topo, where time is marked with solid vertical line after clicking on subfigure axis. Add recursive parameter to mne.viz.ui_events.link that enables linking to a target figure, as well as all figures that the target figure links to, by `Lifeng Qiu Lin`_. (#13968)
Add mask_label_params parameter to ~mne.viz.plot_topomap and ~mne.viz.plot_evoked_topomap to allow for customisation of masked channel labels, by `Carina Forster`_. (#13969)
Skip replotting of annotations on the horizontal scrollbar in the matplotlib browser backend, resulting in a significant speedup for traces with a large number of annotations by `Frankie Robertson`_. (#13972)
Add mouse wheel scrolling support to the 'matplotlib' browser backend to navigate through channels, by `Clemens Brunner`_. (#13988)
~mne.viz.Brain.add_data now supports multiple simultaneous overlays via remove_existing=False and distinct key values. The remove_existing parameter now accepts True / False in addition to None. By `Payam Sadeghi-Shabestari`_. (#13995)
Add on_outside parameter to mne.Epochs and mne.EpochsArray classes to control the behaviour when events exist outside the data range. The options are to 'warn' (new default), 'raise', or 'ignore' (old behaviour), by `Cedric Conday`_. (#14004)
mne.viz.Brain's silhouette option now accepts a spacing string (e.g. "ico5", now the default) to decimate using the same vertex-picking as mne.setup_source_space instead of a generic mesh decimation. mne.viz.plot_alignment and mne.viz.Brain should also be faster when plotting many sensors (e.g., whole-head MEG systems), by `Eric Larson`_. (#14016)
Add a show_zero_line parameter (and 0 keyboard shortcut) to mne.io.Raw.plot and mne.Epochs.plot to show a reference line at each channel's zero, by `Clemens Brunner`_. (#14018)
Add TimeChange behaviour for mne.viz.plot_evoked, where vertical time cursor is previewed on hover and marked on click. Also change previous channel names pop-up on click to on hover. Refactor mne.viz.plot_ica_sources when plotting mne.evoked.Evoked instance, unify under mne.viz.evoked._plot_lines, equipping this plot with hover and click behaviours, by `Lifeng Qiu Lin`_. (#14025)
When multiple overlays are active (via remove_existing=False in ~mne.viz.Brain.add_data), the interactive Brain viewer now shows an "Overlay" drop-down in the Color Limits dock panel that lets the user switch which overlay's color limits and smoothing the sliders control. By `Payam Sadeghi-Shabestari`_. (#14031)
Make mne.viz.plot_evoked_topo show the currently select time with a solid vertical line also in the main figure, by `Marijn van Vliet`_. (#14032)
Added a weighted option to mne.chpi.compute_head_pos that fits all cHPI coils simultaneously with per-coil weights derived from their goodness of fit and inter-coil distance error, avoiding discontinuous jumps ("teleporting") in the estimated head position caused by coils switching in and out of the best-three subset (11330). The default will change from False to True in version 1.14; until then, leaving it unset emits a FutureWarning. By `Eric Larson`_. (#14034)
More complete type checking has been implemented for mne.io, plus Epochs and Evoked, by `Eric Larson`_. (#14036)
Make the vertical (channel) and horizontal (time) scrollbar handles in the 'matplotlib' browser backend draggable, by `Clemens Brunner`_. (#14040)
The colorbar in the mne.viz.Brain viewer now automatically switches to scientific notation for tick labels, and has more tick-label spacing. The Help dialog now uses a Qt dialog styled to match mne-qt-browser's help dialog instead of a matplotlib popup, and the "Press ? for help" status bar message is now clickable, and "Help" text was removed from the top left of the GUI by `Payam Sadeghi-Shabestari`_. (#14054)
Added support for newer recording software in mne.io.read_raw_nirx, by `Emma Bailey`_. (#14055)
Added type annotations to public members of mne/io, mne.Evoked, and mne.Epochs, by `Eric Larson`_. (#14056)
Sped up mne.stats.spatio_temporal_cluster_1samp_test by graph reduction and more efficiently applying sign-flips, by `Eric Larson`_. (#14057)
mne.viz.plot_ica_components and mne.preprocessing.ICA.plot_components now set the window title to "Independent Components" instead of adding a suptitle and append the plotted component range when it is contiguous, by `Clemens Brunner`_. (#14058)
Added regularize="in_argmax" to mne.preprocessing.maxwell_filter to allow component selection more similar to that of MaxFilter™-2.2, by `Eric Larson`_. (#14059)
Speed up and slightly improved the accuracy of mne.make_forward_solution, by `Eric Larson`_. (#14061)
The colorbar in the mne.viz.Brain viewer now shows tick marks aligned with its labels, and its title now defaults to the active overlay's key (see ~mne.viz.Brain.add_data). The interactive viewer can show vertex coordinates and camera orientation, toggled via the v key or a new toolbar button, by `Payam Sadeghi-Shabestari`_. (#14062)
When reading EGI MFF files with mne.io.read_raw_egi, passing event_key='cel#' now returns compound event codes (e.g. stm+_1 and stm+_2) so that trials from different conditions can be distinguished via raw.event_id, by `Pragnya Khandelwal`_ and `Scott Huberty`_. (#14086)
On Linux, mne.sys_info now includes the detected windowing system (Wayland or X11), by `Clemens Brunner`_. (#14099)
Added surf and cortex controls to the mne.viz.Brain GUI, by `Payam Sadeghi-Shabestari`_. (#14102)
Add source_id as an optional parameter in mne.viz.ui_events.VertexSelect, by `Lifeng Qiu Lin`_. (#14126)
Add mne.preprocessing.remove_fmri_gradient_artifact and the mne.preprocessing.GradientRemover class to remove the fMRI gradient (imaging) artifact from EEG recorded during functional MRI using average artifact subtraction (AAS, AllenEtAl2000), along with a new tutorial (tut-fmri-gradient) demonstrating the full workflow, by `Peter Molfese`_ and `Joshua Teves`_. (#14127)
Add the mne.datasets.lite_data.data_path fetcher for the curated data subset used by the JupyterLite browser documentation, by `Natneal B`_. (#14128)
Allow mne.compute_covariance to estimate spatial covariance from an mne.Evoked by treating time samples as observations, by `Hamza Abdelhedi`_. (#14129)
Add a vtk.js drawing backend for MNE's 3D renderer, selected with mne.viz.set_3d_backend("jupyterlite_notebook") and used by the JupyterLite documentation where VTK cannot load, by `Natneal B`_. (#14144)
Added a trace-list sidebar to the mne.viz.Brain GUI, replacing legend by `Payam Sadeghi-Shabestari`_. (#14149)
3D plot windows (e.g., mne.SourceEstimate.plot) now follow light/dark mode switches of the operating system (macOS only for now) while they are open, by `Eric Larson`_. (#14151)
mne.io.read_raw_egi now reads bad channels from categories.xml (when present in the MFF directory) and populates info["bads"] with channels marked exclusion="badChannels" in NetStation. By `Pragnya Khandelwal`_. (#14156)
Added a rank parameter to mne.preprocessing.Xdawn for using Xdawn with rank-deficient data without regularization, by `Eric Larson`_. (#14182)
Add a block parameter to mne.viz.plot_source_estimates, mne.SourceEstimate.plot and mne.VolSourceEstimate.plot_3d to halt execution until the figure is closed, by `Cedric Conday`_. (#14185)
Add mne.viz.clear_3d_figure to remove all actors from a 3D figure so that it can be reused for another plot, by `Eric Larson`_. (#14197)
Speed up reading by optimizing small read paths, by `Bruno Aristimunha`_ (#14212)
Speed up repeated preloading of any file-backed ~mne.io.Raw with preload="auto", which persists decoded data in a copy-on-write cache below mne.set_cache_dir, by `Bruno Aristimunha`_. (#14216)
Add support for applying selected SSP projectors and reconstructing projected data in sensor space on ~mne.io.Raw, ~mne.Epochs, and ~mne.Evoked objects via apply_proj(projs=...) and the new public reconstruct_proj(projs=...) method, by `Hamza Abdelhedi`_. (#14220)
The auto-picked peak vertex and its activity trace in the mne.viz.Brain GUI now follow the active overlay, by `Payam Sadeghi-Shabestari`_. (#14222)
Add exclude parameter to mne.io.Raw.get_data, mne.Epochs.get_data, and mne.Evoked.get_data by `Carina Forster`_. (#14225)
Projection reconstruction can now use an explicit ~mne.Forward model and standard MNE rank handling, by `Hamza Abdelhedi`_. (#14235)
Speed up preloading Raw data and reading uniform EDF and BDF data by avoiding unnecessary setup and using pure-NumPy record-stride decoders, by `Bruno Aristimunha`_. (#14237)
Speed up mne.io.read_raw_brainvision by reading binary data in cache-sized blocks, by `Bruno Aristimunha`_. (#14241)
Speed up channel selection and projector construction by replacing linear channel-name lookups with dictionaries, by `Bruno Aristimunha`_. (#14245)
Speed up reading large Artemis123, Curry, EEGLAB, Eximia, FIL and NSx files by reading them in cache-sized blocks, by `Bruno Aristimunha`_. (#14246)
Sped up various evoked plotting functions by taking advantage of blitting, and mne.Report image embedding by compressing rendered pixels directly, by `Eric Larson`_ (#14249)
Speed up mne.io.read_raw_egi on simple-binary files by reading the event channels in blocks instead of one sample at a time, by `Bruno Aristimunha`_. (#14250)
Speed up mne.io.read_raw_persyst and mne.io.read_raw_nihon by decoding data in cache-sized blocks rather than materializing the whole request, by `Bruno Aristimunha`_. (#14251)
Speed up mne.io.read_raw_fif on integer-format files by normalizing the byte order of each data buffer before calibrating it, by `Bruno Aristimunha`_. (#14252)
Speed up windowed reads and epoching of MEF3 files by reusing the session across reads instead of reparsing its metadata each time, by `Bruno Aristimunha`_. (#14254)
Speed up reading large KIT files by reading them in cache-sized blocks, by `Bruno Aristimunha`_. (#14255)
Added a only_if_changed=True parameter to mne.Report.save to skip writing an already up-to-date file, by `Eric Larson`_. (#14261)
Remove numpy.ndarray from colormap parameter in mne.viz.plot_source_estimates to solve documentation conflict , by Lifeng Qiu Lin. (#13797)
Added cross-references to common modification methods in mne.Info docstring by Athish M. (#13811)
Add notes to ~mne.set_eeg_reference and tut-set-eeg-ref about the correct procedure to create an average reference, by Deep Kaur and Farzah11. (#13846)
Add Zuna to related software list by Jonas Mago. (#13849)
Fixed typos in error messages when reading measurement info, by Seth Bashford. (#13881)
Fixed the fun shape description in mne.Epochs.apply_function's docstring, by Bhargav Kowshik. (#13891)
Batch and vectorise classifier estimation and scoring in mne.decoding.GeneralizingEstimator.score for scoring=None, "accuracy", "balanced_accuracy" and "roc_auc", by Mathias Sablé-Meyer. (#13909)
Add MNE-RT to related software ecosystem and roadmap by Payam Sadeghi-Shabestari. (#13950)
Converted the remaining percent-style string formatting to f-strings in internal code, by Théo Castillo. (#13974)
Add AI policy pointer by sametseckın. (#14037)
Document how to check and tune the OpenBLAS thread count when decomposition-heavy operations are unexpectedly slow, by Daria Agafonova. (#14064)
Correct typo in comment by Samarth D N. (#14117)
Fix hemisphere generation in test_vertex_to_mni_fs_nibabel to cover both by Marcus Campbell. (#14183)
Avoid pytest 10 deprecation warnings when parametrizing scikit-learn estimator checks, by Deepesh Sonar. (#14283)
Adopting the diataxis framework by improving the phantom dipole tutorial, by `Carina Forster`_. (#13584)
Reorganized EDF submodule structure by moving private functionality into the public mne.io namespace to improve module consistency and avoid exposing private modules in the Credits page, by `Aniket Singh Yadav`_. (#13673)
Document ~mne.Annotations.onset, ~mne.Annotations.duration, ~mne.Annotations.description, and ~mne.Annotations.ch_names attributes of mne.Annotations, by `Famous Raj Bhat`_. (#13680)
Made evoked.plot() instantiate MNELineFigure when it creates its own figure, aligning this path with the ongoing 2D plotting figure-class refactor discussed in 7751, by `Pragnya Khandelwal`_. (#13795)
Adding checks in mne.stats.permutation_t_test() to warn the user when provided with bad input values, by `Himanshu Mahor`_. (#13813)
Added regression coverage for colocated triaxial OPM topomap handling in plot_joint() and ICA.plot_components(), by `Pragnya Khandelwal`_. (#13842)
Added a helper to split colocated OPM overlap sets into radial and tangential channel groups, and updated topomap regression coverage to use shared triaxial OPM fixtures, by `Pragnya Khandelwal`_. (#13847)
Convert non-empty drop_log entries from numpy.str_ to regular Python strings, by `Clemens Brunner`_. (#13923)
Refactor the EGI MFF reader to use mffpy for metadata parsing, improving robustness and maintainability. This includes a shim for PNS sensor parsing to bypass an upstream bug in mffpy and resolves channel naming inconsistencies, by `Pragnya Khandelwal`_. (#13945)
Replace the internal binary-block EEG sample reader in mne.io.read_raw_egi with mffpy-backed reading via mffpy.Reader.get_physical_samples_from_epoch, removing manual block-header parsing and np.fromfile calls, by `Pragnya Khandelwal`_. (#13973)
Replace defusedxml-backed implementations of _get_ep_info and _get_signalfname in the EGI MFF reader with mffpy-backed parsing via mne.io.read_raw_egi, by `Pragnya Khandelwal`_. (#13991)
Replace defusedxml-backed _get_gains with mffpy-backed parsing via mne.io.read_raw_egi and remove the internal _extract helper, fully eliminating defusedxml from the EGI MFF reader, by `Pragnya Khandelwal`_. (#14007)
Add table with all available config options to tut-configure-mne, by `Clemens Brunner`_. (#14010)
Remove _get_eeg_calibration_info from the EGI MFF reader and delegate per-channel GCAL scaling to mffpy's native calibration, simplifying EEG channel calibration in mne.io.read_raw_egi, by `Pragnya Khandelwal`_. (#14011)
Replace the manual PNS binary block reader in mne.io.read_raw_egi with mffpy-backed reading via get_physical_samples_from_epoch, by `Pragnya Khandelwal`_. (#14030)
Replace manual binary block reader _get_blocks with mffpy.Reader API in _read_mff_header, removing low-level EGI binary parsing in favour of the existing mffpy dependency, by `Pragnya Khandelwal`_. (#14043)
Remove dead placeholder keys gain, bits, and value_range from _read_header in egimff.py; these were hardcoded to zero and unused since MFF calibration is handled via CAL_SCALES, by `Pragnya Khandelwal`_. (#14047)
Move default values out of parameter type descriptions and remove optional from docstrings, by `Daria Agafonova`_. (#14100)
Decomposition-heavy operations such as mne.preprocessing.maxwell_filter, mne.compute_covariance and mne.preprocessing.ICA.fit now limit how many BLAS threads they use, which is often much faster; see faq_cpu to control this yourself, by `Eric Larson`_. (#14103)
Add a build script and make target that produce the MNE wheel the JupyterLite browser kernel installs, by `Natneal B`_. (#14135)
Speed up mne.io.read_raw_egi for MFF files by preserving the idx slice in _read_segment_file, avoiding a costly np.take copy on large data buffers (~60% reduction in read time for large recordings with preload=True). By `Pragnya Khandelwal`_ (14137). (#14137)
Add an EGI section to the ex-io-impedances gallery example demonstrating how to read per-channel GCAL/ICAL calibration data from an MFF info1.xml file via mffpy and visualize impedances on a topographic map. By `Pragnya Khandelwal`_ (14143). (#14143)
The ex-rsa example is now built and rendered in the documentation instead of being skipped, by `Eric Larson`_. (#14196)
Add categories to the related-python-packages list, by `Laetitia Grabot`_, `Daniel McCloy`_. (#14232)
Alejandro Santos Mayo+
Aman Srivastava
Amirali Moradniaei+
Aniket Singh Yadav
Anton Karpov+
Antonio Elias Sánchez Soto+
Apoorva Verma+
Athish M+
Ayushi Satodiya+
Baris Talar+
Beliz Sertcan Gökmen+
Ben Tang+
Bhargav Kowshik+
Bruno Aristimunha
Carina Forster
Cedric Conday+
Chetan Gohil
Christian Brodbeck
Clemens Brunner
Daniel McCloy
Daria Agafonova+
Deep Kaur+
Deepesh Sonar+
Emma Bailey
Eric Larson
Erica Peterson
Famous Raj Bhat+
Farzah11+
Frankie Robertson+
Hamza Abdelhedi
Himanshu Mahor
Jacob Woessner
John Griffiths+
Jonas Mago+
Julien Dubois+
Kalle Mäkelä
Laetitia Grabot
Lifeng Qiu Lin+
Luca Kaemmer+
Marcus Campbell+
Marijn van Vliet
Martin Oberg
Mathias Sablé-Meyer+
Mathieu Scheltienne
Michael Straube
Mingjian He
Natneal B
Nikolai Kapralov
Pavel Popov+
Payam Sadeghi-Shabestari+
Peter Molfese
Piotr Durka+
Pragnya Khandelwal
Qian Chu
Raphaël Bordas+
Robert Luke
Samarth D N+
Scott Huberty
Seth Bashford+
Seyed Yahya Shirazi
Sharif Haason+
Sina Esmaeili+
Stefan Appelhoff
TIM ANDERSON
Thomas Binns
Théo Castillo+
Tom Ma
Varun Kasyap Pentamaraju+
Vincent Gao+
Virginie van Wassenhove+
Zahra M. Aghajan+
sametseckın+
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Nothing published for this version
Fix bug preventing reading of mne.time_frequency.Spectrum and mne.time_frequency.BaseTFR objects created in MNE<1.8 using the deprecated subject info…
Updated minimums for:
Core dependency scipy >= 1.13
Optional dependency pandas >= 2.2
Optional dependency scikit-learn >= 1.4
Changes implemented via CI action created by `Thomas Binns`_. (#13611)
Preserve kit_system_id in forward-solution Info, by Melih Yayli. (#13520)
Fix axis limits in mne.preprocessing.eyetracking.Calibration.plot to use screen resolution if available, by Gnaneswar Lopinti. (#13558)
Fix bug where mne.viz.plot_raw would access incorrect matplotlib attributes, by Thomas A Caswell. (#13606)
Allow reading alternative nasion label ("Nz") in SNIRF files when parsing landmarkPos3D, by Aniket Singh Yadav. (#13672)
Change default-pick 'data' for "eyegaze" to false, following existing documentation. by Benedikt Ehinger. (#13723)
Fix bug in when reading EDF/GDF files where non-positive lowpass values were not handled correctly, now mapping them to the Nyquist frequency to prevent errors during plotting, by Hansuja Budhiraja. (#13769)
Clearer error message when no ECG events are found in ~mne.preprocessing.find_ecg_events, by Hansuja Budhiraja. (#13771)
Fix bug in 3D overlay compositing that could produce NaN RGBA values when the resulting alpha is zero, by `Pragnya Khandelwal`_. (#13714)
Make ~mne.io.Raw.interpolate_bads method flexible (ignore, warn, raise) about how to handle interpolation of channels with invalid positions, by Himanshu Mahor. (#13518)
Fix bug where outdated seghead.mgz files were reused in mne.bem.make_scalp_surfaces. Add a new parameter reuse_seghead to control whether to reuse existing seghead.mgz files, by `Victor Férat`_. (#13024)
When interpolating from axial to planar gradiometers, set info fields "chs", "ch_names", and "nchan", according to the interpolated data, reset info fields "device_info", "helium_info", "gantry_angle", "ctf_head_t", "dev_ctf_t", "bads", "projs", and "comps" to [] or None, and preserve all remaining info fields. by Christoph Huber-Huber. (#13759)
Clarified an internal forward-model invariant in mne.forward._lead_dots by asserting that rref is None on the current code path, by Pragnya Khandelwal. (#13764)
Fix bug preventing mne.time_frequency.read_spectrum from reading saved mne.time_frequency.Spectrum objects created from mne.time_frequency.EpochsSpectrum.average, by `Thomas Binns`_. (#13521)
Fix bug where mne.chpi.refit_hpi did not take gof_limit into account when fitting HPI order, by `Eric Larson`_ (#13525)
Fix bug preventing reading of mne.time_frequency.Spectrum and mne.time_frequency.BaseTFR objects created in MNE<1.8 using the deprecated subject info birthday tuple format, by `Thomas Binns`_. (#13526)
Fix bug where invalid date formats passed to mne.Info.set_meas_date were not caught, by `Thomas Binns`_. (#13528)
Fix bug with mne coreg where interactively altered MRI fiducials were not used when scaling a surrogate subject, by `Eric Larson`_. (#13539)
Fix bug with mne.viz.plot_evoked where channels were plotted above axis spines, by `Michael Straube`_. (#13549)
Fix bug with montage test error message checking, by `Eric Larson`_. (#13579)
Fix bug where mne.viz.plot_evoked_white did not accept a single "meg" rank value like those returned from mne.compute_rank, by `Eric Larson`_. (#13595)
Fix bug with mne.make_forward_solution when no MEG channels are present where dev_head_t was errantly set, by `Eric Larson`_. (#13619)
Fix mne.io.read_raw_snirf raising TypeError when landmarkLabels is empty or scalar, by `Bruno Aristimunha`_. (#13628)
Fix bug with mne.datasets.somato.data_path where the archive couldn't be extracted due to an absolute path issue, by `Eric Larson`_. (#13630)
Fix bug in mne.Epochs.plot where clicking on the scrollbar would not scroll to the last epoch, by `Clemens Brunner`_. (#13654)
Expose mne.bem namespace, which was inadverdently removed in MNE version 1.5. As an example, users can once again use the mne.bem.make_watershed_bem API entrypoint, by `Scott Huberty`_. (#13669)
Fix sensor name ordering in ~mne.viz.plot_topomap when passing an ~mne.Info object as pos with names argument, by `Famous Raj Bhat`_. (#13686)
Fix bug in ~mne.compute_source_morph where the spacing attribute was set incorrectly when src_to is provided, by `Famous Raj Bhat`_. (#13687)
Avoid raising an error when setting montage on a ~mne.channels.DigMontage of MEG+EEG recordings, when EEG reference positions were set to the placeholder value [1, 0, 0] (i.e., digitization was not performed), by `Famous Raj Bhat`_. (#13700)
Fix annotation removal logic in matplotlib based figures to correctly handle non-contiguous visible annotations, by `Johannes Herforth`_. (#13703)
Support mixed-type concatenation of mne.Annotations and mne.HEDAnnotations, preserving HED strings in extras["HED"], by `Bruno Aristimunha`_. (#13736)
Improved handling of dropped epochs in mne.viz.plot_ica_properties and mne.preprocessing.ICA.plot_properties, allowing plots to be generated even with many bad annotations, by `Clemens Brunner`_. (#13746)
Avoid some unnecessary computations when n_jobs=None is equivalent to n_jobs=1, by `Simon Kern`_. (#13777)
Fix clipped annotations and x-axis label in mne.io.Raw.plot, by `Clemens Brunner`_. (#13787)
Fix bug with reading large CNT files by adding recompute_n_samples to mne.io.read_raw_cnt with stricter data_format handling by `Teon Brooks`_ and `Eric Larson`_. (#13548)
Add ICA source timecourse plots to mne.Report.add_ica, by Aniket Singh Yadav (#13697)
Add mne.HEDAnnotations for attaching HED (Hierarchical Event Descriptors) tags to annotations, by Kay Robbins, `Bruno Aristimunha`_, and `Daniel McCloy`_. (#13059)
Add support for mne.io.Raw.interpolate_to and related methods (and mne.channels.read_meg_canonical_info) for interpolating MEG data across systems, by Konstantinos Tsilimparis. (#13196)
Add support for multi-wavelength NIRS processing to mne.preprocessing.nirs.beer_lambert_law, mne.preprocessing.nirs.scalp_coupling_index, and SNIRF reader mne.io.read_raw_snirf, by Tamas Fehervari. (#13408)
Add an optional show_channel_names parameter to mne.viz.plot_alignment to overlay channel labels at sensor locations in the 3D alignment view, by Aman Srivastava. (#13570)
Add support for reading BCI2000 .dat files via mne.io.read_raw_bci2k, and an example examples/io/read_bci2k.py for downloading and visualizing BCI2000 data, by Hansuja Budhiraja. (#13699)
Add support for scalar or per-vertex alpha (shape (n_vertices,)) in distributed overlays, including validation/errors for invalid shapes, tests, and a visualization example in examples/visualization/brain.py using mne.viz.Brain.add_data, by Pragnya Khandelwal. (#13706)
Added cmap parameter to Evoked.animate_topomap to allow user-specified colormaps., by Hansuja Budhiraja. (#13756)
Allow per-channel color overrides in mne.viz.plot_raw via channel name keys in the color dict, by Hansuja Budhiraja. (#13765)
Add example showing how to interoperate with R using rpy2, by Aman Srivastava. (#13729)
Added a font_file parameter to mne.viz.Brain.add_text to support rendering glyphs not available in the default font, by Pragnya Khandelwal. (#13778)
Improve memory usage and runtime of mne.time_frequency.csd_fourier, mne.time_frequency.csd_multitaper, mne.time_frequency.csd_array_fourier, and mne.time_frequency.csd_array_multitaper by avoiding unnecessary full-matrix CSD construction, by Pragnya Khandelwal. (#13719)
Add mne.io.read_raw_mef for reading MEF3 files, supporting BIDS iEEG data formats, by `Bruno Aristimunha`_. (#13610)
Add finer-grained control to mne.io.anonymize_info and the related methods mne.io.Raw.anonymize, mne.Epochs.anonymize, and mne.Evoked.anonymize by allowing keep_his to accept one or more strings; keep_his=True remains unchanged (retaining "his_id", "sex", and "hand" from anonymization), but individual fields can now also be retained (the default keep_his=False also remains unchanged and still anonymizes all fields), by `Clemens Brunner`_. (#13647)
Created a quality control report tutorial tut-qc-report, by Srivarsha Chivukula. (#13532)
Improved docs for mne.io.read_raw_nirx, by Natneal B. (#13541)
Refactor f-strings in mne/tests/test_import_nesting.py, by Shruti Bhale. (#13551)
Remove legacy Python-version compatibility checks in mne.utils.misc._empty_hash now that usedforsecurity=False is always supported, by Varun Kasyap Pentamaraju. (#13566)
Add optional low-variance ("hat") regularization to mne.stats.f_oneway via new sigma and method parameters, by Aniket Singh Yadav. (#13698)
Improve documentation of return values to clarify that methods typically return the original instance type for chaining purposes, by Aniket Singh Yadav. (#13674)
Examples Using <some-method> section quirk fix in documentation, by Himanshu Mahor. (#13596)
Document the behavior of first_samp after ~mne.io.Raw.crop and add reset_first_samp parameter to reset it to 0 after cropping, by Famous Raj Bhat. (#13685)
Add a note to mne.Epochs.drop describing a potential mismatch between the indices expected by ~mne.Epochs.drop and those found in the selection attribute when epochs have been automatically dropped, by Famous Raj Bhat. (#13688)
Extended support for visualising cross-spectral densities in mne.viz.plot_csd and mne.time_frequency.CrossSpectralDensity.plot to all types of data channels, by Aniket Singh Yadav. (#13713)
Replacing python:abc.abstractclassmethod with python:abc.abstractmethod in mne.viz.Figure3D, by Himanshu Mahor. (#13806)
Code refactor in mne.preprocessing.eyetracking.set_channel_types_eyetrack, by Himanshu Mahor. (#13602)
Fix deprecation of setting a shape on an array directly in numpy 2.5+, by `Mathieu Scheltienne`_. (#13585)
Documentation improvement for eSSS in docstring mne.preprocessing.maxwell_filter and in the MaxFilter example by `Simon Kern`_. (#13591)
make mne.sys_info work on Windows systems with Powershell version 7+, by `Marijn van Vliet`_ (#13593)
Add mne.Epochs.reset_index, which replaces the legacy mne.Epochs.reset_drop_log_selection (the new name better reflects the method's purpose), by `Clemens Brunner`_. (#13675)
Add native save and read functionality for mne.decoding.SSD, mne.decoding.CSP, mne.decoding.SPoC, and mne.decoding.XdawnTransformer objects, by `Aniket Singh Yadav`_. (#13718)
Remove from __future__ import annotations as it is only needed for Python ≤ 3.9 by `Aniket Singh Yadav`_. (#13749)
Improved internal functions for inspecting MATLAB v7.3 (HDF5) files in mne.io.read_raw_eeglab, by `Bruno Aristimunha`_. (#13753)
Akhilesh S. Yadav+
Aman Srivastava+
Aniket Singh Yadav+
Benedikt Ehinger+
Bruno Aristimunha
Carina Forster
Christoph Huber-Huber+
Clemens Brunner
Daniel McCloy
Eric Larson
Erica Peterson
Famous Raj Bhat+
Gnaneswar Lopinti+
Hamza Abdelhedi
Hansuja Budhiraja+
Himanshu Mahor+
Johannes Herforth
Kay Robbins+
Konstantinos Tsilimparis+
Marijn van Vliet
Mathieu Scheltienne
Melih Yayli+
Michael Straube
Natneal B+
Pragnya Khandelwal+
Scott Huberty
Shruti Bhale+
Simon Kern
Srivarsha Chivukula
Stefan Appelhoff
Tamas Fehervari+
Teemu Taivainen+
Teon Brooks
Thomas A Caswell+
Thomas S. Binns
Varun Kasyap Pentamaraju+
Victor Férat
New reader for Neuroscan Curry files, using the curry-python-reader module, by Dominik Welke_. (#13176 __)
New reader for Neuroscan Curry files, using the curry-python-reader module, by `Dominik Welke`_. (#13176)
Handle scenario where an Eyelink recording switched from binocular to monocular mode during a trial by `Scott Huberty`_ (#12847)
Fixed ICA getting sources for concatenated raw instances, by Beige Jerry Jin. (#13068)
Fix reading annotations with mne.read_annotations from .csv files containing nanoseconds in times, and drop nanoseconds from times returned from mne.Annotations.to_data_frame and saved in .csv files by mne.Annotations.save, by `Thomas Binns`_. (#13109)
Fix bug with mne.io.read_raw_egi where info["dev_head_t"] was an identity matrix instead of None, by `Eric Larson`_. (#13112)
Read Nihon Kohden annotation file accurately (using sublog parsing), by `Tom Ma`_. (#13251)
Fix bug with mne.open_report not working with old saved files, by `Eric Larson`_. (#13341)
Restore clipping=3 in ~mne.io.Raw.plot (which was mistakenly changed to 1.5) to reduce excessive clipping of raw data, by `Clemens Brunner`_. (#13354)
Make ~mne.io.read_raw_eyelink work with ASCII files collected with Eye Event Mode set to "HREF" by `Scott Huberty`_. (#13357)
model parameter of mne.decoding.LinearModel will not be modified, use model_ attribute to access the fitted model. To be compatible with all MNE-Python versions you can use getattr(clf, "model_", getattr(clf, "model")) The provided model is expected to be a supervised predictor, i.e. classifier or regressor (or sklearn.multiclass.OneVsRestClassifier), otherwise an error will be raised. by `Gennadiy Belonosov`_. (#13361)
Fix the check in mne.make_forward_solution that all MEG sensors are outside a spherical BEM model, by `Marijn van Vliet`_ (#13371)
Fix bug with mne.grand_average not working with mne.time_frequency.Spectrum objects, by `Thomas Binns`_. (#13375)
Ensure auto-computed plot scalings are always non-zero, by `Daniel McCloy`_. (#13376)
Fix ~mne.viz.plot_evoked_joint docstring to correctly document exclude parameter default as 'bads' instead of None, by Tharupahan Jayawardana. (#13391)
Make decoding classes sklearn-compliant, by `Gennadiy Belonosov`_. (#13393)
Fix loading problems caused by attempting to iterate floats in ~mne.read_epochs_eeglab for specific EEGLab data, by Emrecan Çelik. (#13395)
Fix bug with mne.make_forward_solution where sources were not checked to make sure they're inside the inner skull for spherical BEMs, by `Eric Larson`_. (#13407)
Preserve event-to-epoch mapping when exporting EEGLAB .set files by `Scott Huberty`_ (#13428)
Fix and update osf.io links to new format, by Johannes Herforth. (#13440)
Fix bug with mne.add_reference_channels not working correctly when passing more than one channel name, by `Michael Straube`_. (#13466)
Correctly set the calibration factor in Nihon Kohden reader (which affects channel amplitudes), by `Tom Ma`_. (#13468)
Make mne.preprocessing.eyetracking.read_eyelink_calibration robust to files with blank lines, by `Scott Huberty`_. (#13469)
Fix bug with mne.viz.plot_topomap that caused unexpected channel name plotting when using a mask, by `Michael Straube`_. (#13470)
Fix bug with mne.preprocessing.ICA.apply not working when the ICA instance was fitted including marked bad channels, by `Michael Straube`_. (#13478)
Fix bug with mne.viz.plot_evoked when using gfp="only" or gfp=True, by `Michael Straube`_. (#13481)
Improved error message when non-finite values (NaN/Inf) are detected in calls to inst.compute_psd(method="welch") or ICA.fit(), by Emma Zhang. (#13486)
Fix bug where mne.channels.DigMontage.plot would error when axes was passed by `Christian O'Reilly`_. (#13494)
Fixed a bug where mne.io.read_raw_gdf failed with NumPy ≥1.24 due to the removal of np.fromstring binary mode. Replaced with np.frombuffer for compatibility, by Dev Parikh. (#13497)
Add on_few_samples parameter to mne.compute_covariance and mne.compute_raw_covariance for controlling behavior when there are fewer samples than channels, which can lead to inaccurate covariance estimates, by Emmanuel Ferdman. (#13350)
The default for mne.make_field_map will change to "auto" in MNE-Python 1.12 (from (0., 0., 0.04)), changes by Paul Anders. (#13398)
Add encoding parameter to mne.io.read_raw_nihon for better handling of annotation decoding, by `Tom Ma`_. (#13458)
Support for preloading=False when reading .set files, by `Bruno Aristimunha`_. (#13096)
Added support for file like objects in read_raw_bdf, read_raw_edf and read_raw_gdf, by Santi Martínez. (#13156)
Read impedances and montage from Neuroscan Curry files, by `Dominik Welke`_. (#13176)
Implement GEDTransformer superclass that generalizes mne.decoding.CSP, mne.decoding.SPoC, mne.decoding.XdawnTransformer, mne.decoding.SSD and fix related bugs and inconsistencies, by `Gennadiy Belonosov`_. (#13259)
Added on_inside="raise" parameter to mne.make_forward_solution and mne.make_forward_dipole to control behavior when MEG sensors are inside the outer skin surface. This is useful for forward solutions that are computed with sensors just inside the outer skin surface (e.g., with some OPM coregistrations), by `Eric Larson`_. (#13307)
Implement mne.decoding.SpatialFilter class returned by mne.decoding.get_spatial_filter_from_estimator for visualisation of filters and patterns for mne.decoding.LinearModel and additionally eigenvalues for GED-based transformers such as mne.decoding.XdawnTransformer, mne.decoding.CSP, by `Gennadiy Belonosov`_. (#13332)
Add more options for the sphere parameter of mne.viz.plot_sensors, by `Marijn van Vliet`_ (#13400)
Add support for BDF export in mne.export.export_raw, by `Clemens Brunner`_ (#13435)
Improve precision of fiducial clicking in mne coreg, by `Eric Larson`_. (#13445)
Add support for Nihon Kohden EEG-1200A V01.00, by `Eric Larson`_. (#13448)
The rename_channels method now has an on_missing parameter to control behavior on channel mismatch, by `Stefan Appelhoff`_. (#13456)
Added the annotation_regex parameter to mne.viz.plot_raw and mne.viz.plot_ica_sources, allowing automatic hiding of annotations that do not match the specified regular expression. The same functionality is available via mne.io.Raw.plot and mne.preprocessing.ICA.plot_sources. Contributed by `Johannes Herforth`_. (#13460)
The combine_channels method now has an on_missing parameter to control behavior on missing event ids, by Michael Straube. (#13463)
Add ability to refit HPI order and device-to-head transform via mne.chpi.refit_hpi and compute distances between transforms with mne.transforms.angle_distance_between_rigid by `Eric Larson`_. (#13484)
Added mne.Info.to_json_dict and mne.Info.from_json_dict methods to enable JSON serialization and deserialization of mne.Info objects, preserving all data types including numpy arrays, datetime objects, and special MNE types, by `Bruno Aristimunha`_. (#13489)
Added support for parsing Eyelink BUTTON events (i.e. external controller button presses) to ~mne.io.read_raw_eyelink by Wouter Kroot (#13499)
Changed "enhancement" to "new feature" in the contributing guide as enhancement is not a recognized change type, by `Shristi Baral`_ (#13373)
Add a SPEC0-like policy in which minimum-supported versions for select dependencies are set to the latest minor release that was available 2 years prior, by `Thomas Binns`_ (#13451)
Removed development dependencies from user-visible "extras"; they're now dependency groups only visible to developers (and can be installed for example via pip install --group dev with pip version 25.1 or later), by `Richard Höchenberger`_ (#13452)
Beige Jerry Jin+
Bruno Aristimunha
Christian O'Reilly
Christodoulos Kechris
Clemens Brunner
Daniel McCloy
Dev Parikh+
Dominik Welke
Emma Zhang+
Emmanuel Ferdman+
Emrecan Çelik+
Eric Larson
Gennadiy Belonosov
Johannes Herforth+
Marijn van Vliet
Michael Straube+
Paul Anders+
Richard Höchenberger
Santi Martínez+
Scott Huberty
Shristi Baral
Stefan Appelhoff
Tharupahan Jayawardana*
Thomas S. Binns
Tom Ma
Wouter Kroot+
Young Truong
<!-- Release notes generated using configuration in .github/release.yaml at maint/1.10 -->
<!-- Release notes generated using configuration in .github/release.yaml at maint/1.10 -->
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.10.1...v1.10.2
<!-- Release notes generated using configuration in .github/release.yaml at maint/1.10 -->
<!-- Release notes generated using configuration in .github/release.yaml at maint/1.10 -->
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.10.0...v1.10.1
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.9.0...v1.10.0
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.9.0...v1.10.0
Fixed behavior of mne.viz.plot_source_estimates where the title was not displayed properly, by Shristi Baral. (#12828)
Return events when requested even when current matches the desired sfreq in mne.io.Raw.resample by Roy Eric Wieske. (#13070)
Fix bug in mne.io.read_raw_gdf, by Rongfei Jin. (#13113)
Fixed CTF cHPI coil location detection in mne.chpi.extract_chpi_locs_ctf by Shresth Keshari. (#13123)
Fix bug with sampling frequency estimation in snirf files, by `Daniel McCloy`_ and Yixiao Shen. (#13184)
Fix bug where mne.gui.coregistration would emit an error for some CTF datasets, by Wei Xu. (#13218)
Improved the configuration json to handle with parallel access with file lock configuration by Bruno Aristimunha. (#13241)
Update mne.viz.plot_alignment and related functions to support PyVista deprecation of positional arguments by user27182. (#13277)
Fixed bug where mne.preprocessing.maxwell_filter_prepare_emptyroom would not reliably identify meg channel types for matching bads across emptyroom and task, by Harrison Ritz. (#13280)
Fixed bug where saving FIFF files failed when info["subject_info"]["birthday"] was a pandas.Timestamp instead of datetime.date, by Laurent Le Mentec. (#13284)
Fixed almost-white (barely visible) channel traces when using spatial_colors=True in mne.io.Raw.plot_psd, mne.Epochs.plot_psd, and related PSD-plot helpers, by Mojackhak. (#13286)
Fix bug where mne.export.export_raw does not correct for recording start time (raw.first_time) when exporting Raw instances to EDF or EEGLAB formats, by `Qian Chu`_. (#12656)
Fix epoch indexing in mne.time_frequency.EpochsTFRArray when initialising the class with the default drop_log parameter, by `Thomas Binns`_. (#13028)
Fix loading and saving of ~mne.time_frequency.EpochsSpectrum objects that contain slash-separators in their condition names, by `Daniel McCloy`_. (#13042)
Fix input boxes for the max value not showing when plotting fieldlines with ~mne.viz.plot_evoked_field when show_density=False, by `Marijn van Vliet`_. (#13048)
Fix bug with saving of anonymized data when helium info is present in measurement info, by `Eric Larson`_. (#13056)
Fix computation of time intervals in mne.preprocessing.compute_fine_calibration by `Eric Larson`_. (#13062)
Fix bug in the colorbars created by mne.viz.plot_evoked_topomap by `Santeri Ruuskanen`_. (#13063)
Improved sklearn class compatibility and compliance, which resulted in some parameters of classes having an underscore appended to their name during fit, such as:
mne.decoding.FilterEstimator parameter picks passed to the initializer is set as est.picks_
mne.decoding.UnsupervisedSpatialFilter parameter estimator passed to the initializer is set as est.estimator_
Unused verbose class parameters (that had no effect) were removed from ~mne.decoding.PSDEstimator, ~mne.decoding.TemporalFilter, and ~mne.decoding.FilterEstimator as well. Changes by `Eric Larson`_. (#13065)
Fix bug where taper weights were not correctly applied when computing multitaper power with mne.Epochs.compute_tfr and mne.time_frequency.tfr_array_multitaper, by `Thomas Binns`_. (#13067)
Fix bug cause by unnecessary assertion when loading mixed frequency EDFs without preloading mne.io.read_raw_edf by `Simon Kern`_. (#13069)
Fix bug with automated Mesa 3D detection for proper 3D option setting on systems with software rendering, by `Eric Larson`_. (#13082)
Fix bug with reading digitization points from digitization strings with newer MEGIN systems, by `Eric Larson`_. (#13083)
Fix bug when loading certain EEGLAB files that do not contain a nodatchans field, by `Clemens Brunner`_. (#13097)
Do not convert the first "New Segment" marker in a BrainVision file to an annotation, as it only contains the recording date (which is already available in info["meas_date"]), by `Clemens Brunner`_. (#13100)
Take units (m or mm) into account when drawing ~mne.viz.plot_evoked_field on top of ~mne.viz.Brain, by `Marijn van Vliet`_. (#13101)
Improved the handling of problematic MFF files in mne.io.read_raw_egi by `Scott Huberty`_. (#13145)
Fix bug in mne.bem.make_watershed_bem where function would fail if talairach_with_skull.lta did not exist due to changes in FreeSurfer by `Peter Molfese`_. (#13172)
Fix bug where mne.export.export_raw might allocate huge intermediate arrays unnecessarily, when padding data blocks during export to EDF format, by `Daniel McCloy`_. (#13174)
Fix bug with least-squares fitting of head origin using digitization points in mne.preprocessing.maxwell_filter, by `Eric Larson`_. (#13178)
Fix bug with mne.viz.plot_alignment where eeg="projected" was not plotted, by `Eric Larson`_. (#13179)
Fixed bug with filter padding type in mne.io.Raw.plot and related functions to reduce edge ringing during data display, by `Eric Larson`_. (#13183)
Handle channels with potential electrode location in ~mne.preprocessing.maxwell_filter_prepare_emptyroom, by `Mathieu Scheltienne`_. (#13208)
Fixed bug where the file_id is not set when the file contains a directory at the end of the file, by `Théodore Papadopoulo`_. (#13268)
Fix bug with mne.simulation.simulate_raw and mne.simulation.SourceSimulator where using different head positions with head_pos and a BEM would raise an error, by `Eric Larson`_. (#13276)
Fix y-axis label in PSD plot when dB=True to show a more conventional label (i.e., dB/Hz or dB/√Hz), by `Clemens Brunner`_. (#13298)
Fix bug in mne.sys_info where calling it in Windows could lead to a an error while trying to get the amount of available memory, by `Eric Larson`_. (#13310)
Change default pupil unit scalings from micrometrs to millimeters by `Scott Huberty`_ (#13314)
Fix mne.channels.DigMontage.rename_channels so that the changed montage is returned instead of None, by `Stefan Appelhoff`_. (#13320)
The backward-compatible defaults in mne.preprocessing.maxwell_filter of st_overlap=False and `mc_interp=None will change to their smooth variants True and "hann", respectively, in 1.11, by `Eric Larson`_. (#13080)
Add PCA-OBS preprocessing for the removal of heart-artefacts from EEG or ESG datasets via mne.preprocessing.apply_pca_obs, by Emma Bailey and Steinn Hauser Magnússon. (#13037)
Add mne.Evoked.interpolate_to to allow interpolating EEG data to other montages, by Antoine Collas. (#13044)
Allow for topomap plotting of optically pumped MEG (OPM) sensors with overlapping channel locations. When channel locations overlap, plot the most radially oriented channel. By Harrison Ritz. (#13144)
Improved error message in mne.io.Raw.save when attempting to overwrite a file, by Sebastian Jentschke (#13233)
Add new select parameter to mne.viz.plot_evoked_topo and mne.Evoked.plot_topo to toggle lasso selection of sensors, by `Marijn van Vliet`_. (#12071)
Add source space(s) visualization(s) in mne.Report.add_forward, by `Victor Férat`_. (#12848)
Added the option to return taper weights from mne.time_frequency.tfr_array_multitaper, and taper weights are now stored in the mne.time_frequency.BaseTFR objects, by `Thomas Binns`_. (#12910)
Add fig.mne container for Colorbar in plot_connectivity_circle to allow users to access it directly, by `Santeri Ruuskanen`_. (#13019)
Added mne.time_frequency.combine_tfr to allow combining TFRs across tapers, by `Thomas Binns`_. (#13054)
Add the function mne.time_frequency.combine_spectrum for combining data across mne.time_frequency.Spectrum objects, and allow mne.grand_average to operate on mne.time_frequency.Spectrum objects, by `Thomas Binns`_. (#13058)
Add smooth processing of tSSS windows (using overlap-add) and movement compensation (using smooth interpolation of head positions) in mne.preprocessing.maxwell_filter via st_overlap and `mc_interp options, respectively, by `Eric Larson`_. (#13080)
The mne.Info.save method now has an overwrite and a verbose parameter, by `Stefan Appelhoff`_. (#13107)
Add upsampling option to mne.make_field_map to allow upsampling MEG helmet surfaces for plotting, by `Eric Larson`_. (#13179)
New argument sfreq to mne.io.read_raw_snirf, to allow overriding the sampling frequency estimated from (possibly jittered) sampling periods in the file, by `Daniel McCloy`_. (#13184)
Add an extras attribute to mne.Annotations for storing arbitrary metadata, by `Pierre Guetschel`_. (#13228)
mne.Report.add_trans now accepts "auto" and "fsaverage" as arguments for the trans parameter, by `Stefan Appelhoff`_. (#13232)
Add a new parameter plot_kwargs to mne.Report.add_trans, to control low level properties of the visualization, by `Stefan Appelhoff`_. (#13234)
~mne.channel_indices_by_type now has an exclude parameter, by `Stefan Appelhoff`_. (#13293)
Add test analytics functionality to track and analyze test performance, by Katia Al-Amir. (#13225)
Alexandre Gramfort
Antoine Collas+
Britta Westner
Bruno Aristimunha+
Clemens Brunner
Daniel McCloy
Dominik Welke
Emma Bailey+
Eric Larson
Harrison Ritz+
Jona Sassenhagen
Katia Al-Amir+
Laurent Le Mentec+
Marijn van Vliet
Mathieu Scheltienne
Mojackhak+
Peter J. Molfese
Pierre Guetschel
Qian Chu
Richard Höchenberger
Rongfei Jin+
Roy Eric Wieske
Santeri Ruuskanen
Scott Huberty
Sebastian Jentschke+
Shresth Keshari+
Shristi Baral+
Simon Kern
Stefan Appelhoff
Steinn Hauser Magnússon+
Teon L Brooks
Theodore Papadopoulo
Thomas S. Binns
Victor Férat
Wei Xu+
Yixiao Shen+
user27182+
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.8.0...v1.9.0
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.8.0...v1.9.0
Minimum supported dependencies were updated in accordance with SPEC0, most notably Python 3.10+ is now required. (#12798)
Importing from mne.decoding now explicitly requires scikit-learn to be installed, by `Eric Larson`_. (#12834)
Compatibility improved for Python 3.13, by `Eric Larson`_. (#13021)
Fix typos in the Spatio-Spectral Decomposition example, by Simon M. Hofmann. (#12924)
Fix duration calculation for the textual (__repr__) and html (_repr_html_, used by e.g. Jupyter) display of mne.io.Raw instances. For example a duration of 1h is now displayed as 00:01:00 rather than 00:59:60. By Leonardo Rochael Almeida. (#12955)
Fix IndexError when loading CNT file does not have annotations, by Ziyi ZENG. (#12986)
Fix handling of MRI file-path in mne.SourceSpaces and safeguard saving of pathlib.Path with h5io by casting to str, by `Mathieu Scheltienne`_. (#12803)
Cast fwd["info"] to ~mne.Info and fwd["src"] to ~mne.SourceSpaces when loading a forward solution from an HDF5 file, by `Mathieu Scheltienne`_. (#12804)
Fix bug where mne.Epochs.compute_tfr could not be used with the multitaper method and complex or phase outputs, by `Thomas Binns`_. (#12842)
Fixed a bug where split FIF files that were read and then appended to other mne.io.Raw instances had their BAD boundary annotations incorrectly offset in samples by the number of split files, by `Eric Larson`_. (#12843)
Enforce SI units for Eyetracking data (eyegaze data should be radians of visual angle, not pixels. Pupil size data should be meters). Updated tutorials so demonstrate how to convert data to SI units before analyses, by `Scott Huberty`_. (#12846)
Prevent the colorbar parameter being ignored in topomap plots such as mne.time_frequency.Spectrum.plot_topomap, by `Thomas Binns`_. (#12853)
Fix bug where invalid data types (e.g., np.ndarray``s) could be used in some mne.io.Info fields like ``info["subject_info"]["weight"], by `Eric Larson`_. (#12875)
When creating a ~mne.time_frequency.SpectrumArray, the array shape check now compares against the total of both 'good' and 'bad' channels in the provided ~mne.Info (previously only good channels were checked), by `Mathieu Scheltienne`_. (#12877)
Fix bug where mne coreg would always show MEG channels even if the "MEG Sensors" checkbox was disabled, by `Eric Larson`_. (#12884)
mne.Report HDF5 files are now written in mode='a' (append) to allow users to store other data in the HDF5 files, by `Eric Larson`_. (#12901)
Fix bug in mne.io.read_raw_gdf when NumPy >= 2 is used, by `Clemens Brunner`_. (#12909)
Allow exporting edf where a channel contains only constant values, by `Florian Hofer`_. (#12911)
Fix a bug in mne.epochs.make_metadata, where missing values in the columns generated for keep_first and keep_last events were represented by empty strings, while it should have been NA values, by `Richard Höchenberger`_. (#12931)
Fix decimal places of float mne.Evoked.nave in mne.Evoked.plot and mne.Evoked.plot_image, by `Gennadiy Belonosov`_. (#12936)
Fix displayed units in representations of classes such as mne.io.Raw to correctly use KiB, MiB, GiB, and so on, by `Clemens Brunner`_. (#12962)
Gracefully handle invalid patient info when reading EDF files by `Scott Huberty`_. (#12968)
Correct mne.io.read_raw_cnt to read responses and fix exceptions by `Jacob Woessner`_. (#13007)
Fix errant detection of software-rendered vs hardware-rendered MESA GL contexts in 3D rendering on Linux, by `Eric Larson`_. (#13012)
Fix plot scaling for Spectrum.plot(dB=True, amplitude=True), by `Daniel McCloy`_. (#13036)
Deprecate average parameter in plot_filters and plot_patterns methods of the mne.decoding.CSP and mne.decoding.SPoC classes, by `Thomas Binns`_. (#12829)
Deprecate subject parameter in favor of subjects in mne.datasets.eegbci.load_data, by `Stefan Appelhoff`_. (#12918)
Added support for sensor_scales to mne.viz.Brain.add_sensors and mne.viz.plot_alignment, by Alex Lepauvre. (#12805)
Add convenience mne.io.Raw.duration property to centralize duration calculation for the textual (__repr__) and html (_repr_html_, used by e.g. Jupyter) display of mne.io.Raw instances, by Leonardo Rochael Almeida. (#12955)
Add option to mne.preprocessing.fix_stim_artifact to use baseline average to flatten TMS pulse artifact by `Fahimeh Mamashli`_ and `Padma Sundaram`_ and `Mohammad Daneshzand`_. (#6915)
Add support for dict type argument ref_channels to mne.set_eeg_reference, to allow flexible re-referencing (e.g. raw.set_eeg_reference(ref_channels={'A1': ['A2', 'A3']}) will set the new A1 data to be A1 - mean(A2, A3)), by `Alex Lepauvre`_ and `Qian Chu`_ and `Daniel McCloy`_. (#12366)
Add reader for ANT Neuro files in the *.cnt format with ~mne.io.read_raw_ant, by `Mathieu Scheltienne`_, `Eric Larson`_ and `Proloy Das`_. (#12792)
Add support for a mne.transforms.Transform in the argument trans of the coregistration GUI called with mne.gui.coregistration, by `Mathieu Scheltienne`_. (#12801)
~mne.io.Raw and ~mne.Epochs.save now return the path to the saved file(s), by `Victor Férat`_. (#12811)
mne.channels.read_custom_montage may now read a newer version of the .elc ASA Electrode file format, by `Stefan Appelhoff`_. (#12830)
Added the title argument to mne.viz.create_3d_figure, and color and position arguments to mne.viz.set_3d_title, by `Eric Larson`_. (#12871)
Improved reporting and plotting options:
mne.Report.add_projs can now plot with mne.viz.plot_projs_joint rather than mne.viz.plot_projs_topomap
mne.Report now has attributes img_max_width and img_max_res that can be used to control image scaling.
mne.Report now has an attribute collapse that allows collapsing sections and/or subsections by default.
mne.viz.plot_head_positions now has a totals=True option to show the total distance and angle of the head.
Changes by `Eric Larson`_. (#12901)
Added the psd_args argument to mne.viz.plot_ica_sources and mne.preprocessing.ICA.plot_sources, by `Richard Scholz`_. (#12912)
Add ability to use mne.preprocessing.compute_fine_calibration with non-Neuromag-style systems, as well as options to control the bad-angle and error tolerances, by `Eric Larson`_. (#12966)
Add support for uint16_codec argument in mne.io.read_raw_eeglab when pymatreader (which already supported this argument previously) is not installed, by `Clemens Brunner`_. (#12971)
Added support for saving and loading channel names from FIF in mne.channels.DigMontage.save and mne.channels.read_dig_fif and added the convention that they should be saved as -dig.fif, by `Eric Larson`_. (#13003)
Add new Raw.rescale method to rescale the data in place, by `Clemens Brunner`_. (#13018)
Fix a mistake in tut-artifact-regression where the wrong regression coefficients were applied, by Jacob Phelan. (#12978)
Use custom code in mne.sys_info to get the amount of physical memory and a more informative CPU name instead of using the psutil package, by `Clemens Brunner`_. (#12787)
Improve documentation clarity of fit_transform methods for mne.decoding.SSD, mne.decoding.CSP, and mne.decoding.SPoC classes, by `Thomas Binns`_. (#12827)
Improve handling of filenames in raw.filenames by using ~pathlib.Path instead of str, by `Mathieu Scheltienne`_. (#12843)
Improve automatic figure scaling of mne.viz.plot_events, and event_id and count overview legend when a high amount of unique events is supplied, by `Stefan Appelhoff`_. (#12844)
mne.preprocessing.ICA.find_bads_muscle can now be run when passing an inst without sensor positions. However, it will just use the first of three criteria (slope) to find muscle-related ICA components, by `Stefan Appelhoff`_. (#12862)
Update governance model, by `Daniel McCloy`_. (#12896)
Improve the tut-autogenerate-metadata, by `Clemens Brunner`_ and `Richard Höchenberger`_. (#12931)
Mention some gotchas that arise from the fact that by default, we pool across dipole orientations when performing source estimation, by `Marijn van Vliet`_ (#12960)
Repository CI security is now audited using zizmor, by `Eric Larson`_. (#13011)
Alex Lepauvre+
Britta Westner
Clemens Brunner
Daniel McCloy
Eric Larson
Fahimeh Mamashli
Florian Hofer
Gennadiy Belonosov
Jacob Phelan
Jacob Woessner
Leonardo Rochael Almeida+
Mainak Jas
Marijn van Vliet
Mathieu Scheltienne
Proloy Das
Qian Chu
Richard Höchenberger
Richard Scholz
Santeri Ruuskanen
Scott Huberty
Simon M. Hofmann+
Stefan Appelhoff
Thomas Grainger
Thomas S. Binns
Victor Férat
Ziyi ZENG+
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.7.0...v1.8.0
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.7.0...v1.8.0
Minimum versions for dependencies were bumped to those ~2 years old at the time of release (by `Eric Larson`_), including:
NumPy ≥ 1.23
SciPy ≥ 1.9
Matplotlib ≥ 3.6
scikit-learn ≥ 1.1 (#12554)
Official support for PySide2 has been dropped in this release (though it might continue to work), by `Eric Larson`_. (#12742)
Fix bug where an event that occurred only once was excluded in mne.io.read_raw_egi, by Ping-Keng Jao. (#12300)
Fix bug where mne.stats.permutation_cluster_test (and related functions) uses excessive amount of memory for large 2D data when TFCE method is selected, by Nicolas Fourcaud-Trocmé. (#12609)
Assure that blink times are handled correctly mne.preprocessing.eyetracking.interpolate_blinks, even when the raw object is cropped by `Scott Huberty`_ and Sammi Chekroud. (#12759)
Fix check for dropping all channels in mne.io.Raw.drop_channels and related methods, by Farzin Negahbani. (#12763)
Fix scrolling behavior in ~mne.Report when clicking on a TOC entry multiple times, by `Richard Höchenberger`_. (#12561)
Fix bug where mne.decoding.get_coef did not work properly with mne.decoding.CSP, by `Eric Larson`_. (#12562)
The color scaling of Evoked topomaps added to reports via mne.Report.add_evokeds was sometimes sub-optimal if bad channels were present in the data. This has now been fixed and should be more consistent with the topomaps shown in the joint plots, by `Richard Höchenberger`_. (#12578)
Fix error causing mne.Epochs.interpolate_bads not to work for seeg channels and fix a single contact on neighboring shafts sometimes being included in interpolation, by `Alex Rockhill`_ (#12593)
Fix bug where mne.io.read_raw_fil could not assign bad channels on import, by `George O'Neill`_. (#12597)
Fixed a bug where mne.Evoked.animate_topomap did not work with mne.preprocessing.compute_current_source_density - modified data, by `Michal Žák`_. (#12605)
Fix overflow when plotting source estimates where data is all zero (or close to zero), and fix the range of allowed values for the colorbar sliders, by `Marijn van Vliet`_. (#12612)
Fix adding channels to ~mne.time_frequency.EpochsTFR objects, by `Clemens Brunner`_. (#12616)
Fix for new sklearn metadata routing protocol in decoding search_light, by `Alex Gramfort`_ (#12620)
Fix bug where mne.time_frequency.csd_multitaper, mne.time_frequency.csd_fourier, mne.time_frequency.csd_array_multitaper, and mne.time_frequency.csd_array_fourier would return cross-spectral densities with the fmin and fmax frequencies missing, by `Thomas Binns`_ (12633)
Output types of sparse arrays were changed from matrix to array in ~mne.channels.read_ch_adjacency, ~mne.channels.find_ch_adjacency, ~mne.stats.combine_adjacency, ~mne.spatio_temporal_src_adjacency, and related functions to comply with the pending deprecation of np.matrix. The returned objects now behave like standard ~numpy.ndarray objects, and in particular * now operates element-wise instead of performing matrix multiplication. You can use @ as a backward compatible matrix multiplication for both np.matrix and np.ndarray objects, and if a matrix is desired the outputs can be cast directly, for example as scipy.sparse.csr_matrix(out). Changed by `Eric Larson`_. (#12646)
Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (12661)
In mne.export.export_raw (fmt='edf'), when padding data to create equal-length data blocks, edge-padding is favored over zero-padding in order to avoid accidentally enlarging physical range, by `Qian Chu`_. (#12676)
In mne.io.read_raw_eyelink, gracefully handle missing datetime in file by `Scott Huberty`_. (#12687)
Fix regression with mne.decoding.CSP where using rank="full" errantly raised an error, by `Eric Larson`_. (#12694)
Fix in-memory anonymization of data read with mne.io.read_raw_edf by `Eric Larson`_. (#12720)
Fix bug with overplotting of butterfly labels in mne.viz.plot_raw and related functions and methods, by `Eric Larson`_. (#12721)
Fix a bug where the ylim parameter would sometimes apply to the wrong channel types in mne.viz.plot_evoked_topo, by `Marijn van Vliet`_. (#12724)
Fix bug where ad-hoc regularization of a covariance with mne.cov.regularize did not properly account for bad channels in rank calculations, by `Eric Larson`_. (#12727)
Fix bug when reading NIRX files saved in a non-western encoding, by `Daniel McCloy`_. (#12730)
~mne.set_log_file and ~mne.set_log_level can now be correctly detected by static analysis tools like Pylance, by `Richard Höchenberger`_. (#12735)
Safeguard loading of meas_date in mne.io.read_raw_edf, by `Mathieu Scheltienne`_. (#12754)
Fix bug in ~mne.preprocessing.maxwell_filter_prepare_emptyroom where a difference in sampling frequencies between data and emptyroom files was ignored, by `Daniel McCloy`_. (#12760)
A new argument events_as_annotations has been added to mne.io.read_raw_egi with a default value of False that will change to True in version 1.9, by `Scott Huberty`_ and `Eric Larson`_. (#12300)
mne.Info.ch_names will now return an empty list instead of raising a KeyError if no channels are present, by `Richard Höchenberger`_. (#12583)
Documented that ~mne.match_channel_orders can also work on Epochs, and Evoked objects. Reflecting this, deprecated the raws parameter in favor of an insts parameter, by `Stefan Appelhoff`_. (#12699)
The block argument to mne.viz.Brain is deprecated and will be removed in 1.9, use matplotlib.pyplot.show with block=True instead, by `Eric Larson`_. (#12719)
mne.datasets.fetch_fsaverage now returns a python:pathlib.Path object rather than a string. Support for string concatenation with plus (+) is thus deprecated and will be removed in 1.9, use the forward-slash / operator instead, by `Eric Larson`_. (#12771)
Added internals to allow modifying single-channel annotations in the Qt raw browser, by Noah Markowitz. (#12669)
Adding mne.channels.Layout.copy and mne.channels.Layout.pick to copy and select channels from a mne.channels.Layout object. Plotting 2D topographies of evoked responses with mne.viz.plot_evoked_topo with both arguments layout and exclude now ignores excluded channels from the mne.channels.Layout. By `Mathieu Scheltienne`_. (#12338)
In ~mne.Report you can now easily navigate through images and figures connected to a slider with the left and right arrow keys. Clicking on the slider or respective image will focus the slider, enabling keyboard navigation, by `Richard Höchenberger`_ (#12556)
When plotting EOG and ECG artifact scores for ICA in mne.Report.add_ica, the channel names used for artifact detection are now displayed in the titles of each respective subplot, by `Richard Höchenberger`_. (#12573)
Use aseg='auto' for mne.viz.Brain.add_volume_labels and mne.get_montage_volume_labels to use aparc+aseg by default or if not present use wmparc because FreeSurfer uses wmparc in the latest version, by `Alex Rockhill`_. (#12576)
The HTML representations of ~mne.io.Raw, ~mne.Epochs, and ~mne.Evoked (which you will see e.g. when working with Jupyter Notebooks or ~mne.Report) have been updated to be more consistent and contain slightly more information, by `Richard Höchenberger`_. (12624) (#12583)
When adding ~mne.Evoked data to a ~mne.Report via ~mne.Report.add_evokeds, we now also include an "Info" section with some basic summary info, as has already been the case for raw and epochs data, by `Richard Höchenberger`_. (#12584)
We added new installation variants for a full installation with the PySide6 Qt binding ("mne[full-pyside6]"), with the PyQt6 binding ("mne[full-pyqt6]", equivalent to "mne[full]"), and without any Qt binding ("mne[full-no-qt]"), which may be useful in certain situations by `Richard Höchenberger`_. (#12628)
Adding argument 'random' to ~mne.epochs.equalize_epoch_counts and to ~mne.Epochs.equalize_event_counts to randomly select epochs or events. By `Mathieu Scheltienne`_. (#12649)
Add new parameter ignore_marker_types to ~mne.io.read_raw_brainvision to ignore marker types (and only use marker descriptions) when reading BrainVision files, by `Clemens Brunner`_. (#12652)
Added support for passing axes to mne.viz.plot_head_positions when mode='field', by `Eric Larson`_. (#12655)
The HTML representation of ~mne.Epochs (visible e.g. in Jupyter or in ~mne.Report) now indicates whether metadata is attached to the epochs, by `Richard Höchenberger`_. (#12686)
Montage plots created with ~mne.channels.DigMontage.plot now scale both the channel dots and channel names with the new scale parameter. The default is scale=1 (factors less than 1 will scale down, whereas factors greater than 1 will scale up). The previous scale_factor parameter only affected marker size, and this parameter is now deprecated. By `Clemens Brunner`_. (#12703)
Add ~mne.stats.erp.compute_sme to compute the analytical standardized measurement error (SME) as a data quality measure for ERP studies, by `Clemens Brunner`_. (#12707)
Use python:datetime.date for info["subject_info"]["birthday"] rather than a tuple of (year, month, day) by `Eric Larson`_. (#12720)
Add default spatial_colors="auto" to mne.viz.plot_evoked_white and mne.Evoked.plot_white to enable spatial colors by default, by `Eric Larson`_. (#12725)
mne.minimum_norm.make_inverse_operator and related functions now more robustly warn if the whitener computed from the noise covariance has an incorrect rank, by `Eric Larson`_. (#12727)
When indexing ~mne.Epochs (e.g. by doing epochs[0]), static code analysis tools like Pylance should now be able to infer that the returned object is an epoch, too, and provide editor support like automated code completions, by `Richard Höchenberger`_. (#12733)
When using the data_path() in any dataset included in mne.datasets, static analysis tools like Pylance will now correctly infer that a pathlib.Path will be returned and provide editor support like automated code completions, by `Richard Höchenberger`_. (#12734)
Add support for storing Fourier coefficients in mne.time_frequency.Spectrum, mne.time_frequency.EpochsSpectrum, mne.time_frequency.SpectrumArray, and mne.time_frequency.EpochsSpectrumArray objects, by `Thomas Binns`_. (#12747)
Fixed issue template links by Michal Žák (#12600)
Enhance documentation on decimation filtering to prevent aliasing, by Xabier de Zuazo. (#12650)
Added vulture as a pre-commit hook and removed related dead code, by `Eric Larson`_. (#12569)
Add link to BEst-Python in the list of related software. by `Ilian Azz`_. (#12659)
Improved clarity of parameter documentation for mne.decoding.SSD.fit, by `Thomas Binns`_. (#12664)
Disable the "Back to top" button in the documentation, by `Richard Höchenberger`_. (#12688)
Improve argument ylim documentation through ~mne.Evoked plotting function and validate type to dict or None to prevent misuage, by `Mathieu Scheltienne`_. (#12697)
Code contributions are now measured using PRs and reported on the contributors page, by `Eric Larson`_. (#12774)
Authorship headers in MNE-Python code have been standardized, by `Eric Larson`_. (#12781)
Alex Rockhill
Alexandre Gramfort
Clemens Brunner
Daniel McCloy
Dimitri Papadopoulos Orfanos
Eric Larson
Farzin Negahbani+
George O'Neill
Ilian AZZ
Marijn van Vliet
Mathieu Scheltienne
Michal Žák+
Nabil Alibou
Nicolas Fourcaud-Trocmé+
Noah Markowitz+
Ping-Keng Jao+
Qian Chu
Richard Höchenberger
Sammi Chekroud+
Scott Huberty
Stefan Appelhoff
Thomas S. Binns
Xabier de Zuazo+
Backport PR #12633 on branch maint/1.7 ([BUG] Cross-spectral density missing frequencies) by @meeseeksmachine in https://github.com/mne-tools/mne-pyth
v1.7.1
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.7.0...v1.7.1
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.6.0...v1.7.0
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.6.0...v1.7.0
Fix bug where mne.time_frequency.csd_multitaper, mne.time_frequency.csd_fourier, mne.time_frequency.csd_array_multitaper, and mne.time_frequency.csd_array_fourier would return cross-spectral densities with the fmin and fmax frequencies missing, by `Thomas Binns`_ (12633)
Fix incorrect RuntimeWarning (different channel filter settings) in EDF/BDF import, by `Clemens Brunner`_. (12661)
Clemens Brunner
Thomas Binns
In this version, we started adding type hints (also known as "type annotations") to select parts of the codebase. This meta information will be used by development environments (IDEs) like VS Code and PyCharm automatically to provide better assistance such as tab completion or error detection even before running your code.
So far, we've only added return type hints to mne.io.read_raw, mne.read_epochs, mne.read_evokeds and all format-specific read_raw_*() and read_epochs_*() functions. Now your editors will know: these functions return evoked and raw data, respectively. We are planning add type hints to more functions after careful evaluation in the future.
You don't need to do anything to benefit from these changes – your editor will pick them up automatically and provide the enhanced experience if it supports it! (#12250)
defusedxml is now an optional (rather than required) dependency and needed when reading EGI-MFF data, NEDF data, and BrainVision montages, by `Eric Larson`_. (#12264)
For developers, pytest>=8.0 is now required for running unit tests, by `Eric Larson`_. (#12376)
pytest-harvest is no longer used as a test dependency, by `Eric Larson`_. (#12451)
The minimum supported version of Qt bindings is 5.15, by `Eric Larson`_. (#12491)
Fix bug where section parameter in mne.Report.add_html was not being utilized resulting in improper formatting, by Martin Oberg. (#12319)
Fix bug in mne.preprocessing.maxwell_filter where calibration was incorrectly applied during virtual sensor reconstruction, by `Eric Larson`_ and Motofumi Fushimi. (#12348)
Reformats channel and detector lookup in mne.io.read_raw_snirf from array based to dictionary based. Removes incorrect assertions that every detector and source must have data associated with every registered optode position, by Alexander Kiefer. (#12430)
Remove FDT file format check for strings in EEGLAB's EEG.data in mne.io.read_raw_eeglab and related functions by Seyed Yahya Shirazi (#12523)
Fixes to interactivity in time-frequency objects: the rectangle selector now works on TFR image plots of gradiometer data; and in TFR.plot_joint() plots, the colormap limits of interactively-generated topomaps match the colormap limits of the main plot. By `Daniel McCloy`_. (#11282)
Allow mne.viz.plot_compare_evokeds to plot eyetracking channels, and improve error handling, y `Scott Huberty`_. (#12190)
Fix bug in mne.Epochs.apply_function where data was handed down incorrectly in parallel processing, by `Dominik Welke`_. (#12206)
Remove incorrect type hints in mne.io.read_raw_neuralynx, by `Richard Höchenberger`_. (#12236)
Fix bug with accessing the last data sample using raw[:, -1] where an empty array was returned, by `Eric Larson`_. (#12248)
Correctly handle temporal gaps in Neuralynx .ncs files via mne.io.read_raw_neuralynx, by `Kristijan Armeni`_ and `Eric Larson`_. (#12279)
Fix bug where parent directory existence was not checked properly in mne.io.Raw.save, by `Eric Larson`_. (#12282)
Add tol parameter to mne.events_from_annotations so that the user can specify the tolerance to ignore rounding errors of event onsets when using chunk_duration is not None (default is 1e-8), by `Michiru Kaneda`_ (#12324)
Allow mne.io.Raw.interpolate_bads and mne.Epochs.interpolate_bads to work on ecog and seeg data; for seeg data a spline is fit to neighboring electrode contacts on the same shaft, by `Alex Rockhill`_ (#12336)
Fix clicking on an axis of mne.viz.plot_evoked_topo when multiple vertical lines vlines are used, by `Mathieu Scheltienne`_. (#12345)
Fix bug in mne.viz.EvokedField.set_vmax that prevented setting the color limits of the MEG magnetic field density, by `Marijn van Vliet`_ (#12354)
Fix faulty indexing in mne.io.read_raw_neuralynx when picking a single channel, by `Kristijan Armeni`_. (#12357)
Fix bug where mne.preprocessing.compute_proj_ecg and mne.preprocessing.compute_proj_eog could modify the default reject and flat arguments on multiple calls based on channel types present, by `Eric Larson`_. (#12380)
Fix bad channels not handled properly in mne.stc_near_sensors by `Alex Rockhill`_. (#12382)
Fix bug where mne.preprocessing.regress_artifact projection check was not specific to the channels being processed, by `Eric Larson`_. (#12389)
Change how samples are read when using data_format='auto' in mne.io.read_raw_cnt, by `Jacob Woessner`_. (#12393)
Fix bugs with mne.Report CSS where TOC items could disappear at the bottom of the page, by `Eric Larson`_. (#12399)
In ~mne.viz.plot_compare_evokeds, actually plot GFP (not RMS amplitude) for EEG channels when global field power is requested by `Daniel McCloy`_. (#12410)
Fix tut-working-with-seeg use of mne.stc_near_sensors to use the mne.VolSourceEstimate positions and not the pial surface, by `Alex Rockhill`_ (#12436)
Fix prefiltering information management for EDF/BDF, by `Michiru Kaneda`_ (#12441)
Fix validation of ch_type in mne.preprocessing.annotate_muscle_zscore, by `Mathieu Scheltienne`_. (#12444)
Fix errant redundant use of BIDSPath.split when writing split raw and epochs data, by `Eric Larson`_. (#12451)
Disable config parser interpolation when reading BrainVision files, which allows using the percent sign as a regular character in channel units, by `Clemens Brunner`_. (#12456)
Fix the default color of mne.viz.Brain.add_text to properly contrast with the figure background color, by `Marijn van Vliet`_. (#12470)
Changed default ECoG and sEEG electrode sizes in brain plots to better reflect real world sizes, by `Liberty Hamilton`_ (#12474)
Fixed bugs with handling of rank in mne.decoding.CSP, by `Eric Larson`_. (#12476)
Fix reading segmented recordings with mne.io.read_raw_eyelink by `Dominik Welke`_. (#12481)
Improve compatibility with other Qt-based GUIs by handling theme icons better, by `Eric Larson`_. (#12483)
Fix problem caused by onsets with NaN values using mne.io.read_raw_eeglab by `Jacob Woessner`_ (#12484)
Fix cleaning of channel names for non vectorview or CTF dataset including whitespaces or dash in their channel names, by `Mathieu Scheltienne`_. (#12489)
Fix bug with mne.preprocessing.ICA.plot_sources for evoked data where the legend contained too many entries, by `Eric Larson`_. (#12498)
Fix bug where using phase="minimum" in filtering functions like mne.io.Raw.filter constructed a filter half the desired length with compromised attenuation. Now phase="minimum" has the same length and comparable suppression as phase="zero", and the old (incorrect) behavior can be achieved with phase="minimum-half", by `Eric Larson`_. (#12507)
Correct reading of info["subject_info"]["his_id"] in mne.io.read_raw_snirf, by `Eric Larson`_. (#12526)
Calling ~mne.io.Raw.compute_psd with method="multitaper" is now expressly disallowed when reject_by_annotation=True and bad_* annotations are present (previously this was nominally allowed but resulted in nan values in the PSD). By `Daniel McCloy`_. (#12535)
~mne.io.Raw.compute_psd and ~mne.time_frequency.psd_array_welch will now use FFT windows aligned to the onsets of good data spans when bad_* annotations are present. By `Daniel McCloy`_. (#12536)
Fix bug in loading of complex/phase TFRs. By `Daniel McCloy`_. (#12537)
Fix bug with mne.SourceSpaces.export_volume where the img.affine was not set properly, by `Eric Larson`_. (#12544)
The default value of the zero_mean parameter of mne.time_frequency.tfr_array_morlet will change from False to True in version 1.8, for consistency with related functions. By `Daniel McCloy`_. (#11282)
The parameter for providing data to mne.time_frequency.tfr_array_morlet and mne.time_frequency.tfr_array_multitaper has been switched from epoch_data to data. Only use the data parameter to avoid a warning. Changes by `Thomas Binns`_. (#12308)
Change mne.stc_near_sensors surface default from the 'pial' surface to the surface in src if src is not None in version 1.8, by `Alex Rockhill`_. (#12382)
Detecting Bad EEG/MEG channels using the local outlier factor (LOF) algorithm in mne.preprocessing.find_bad_channels_lof, by Velu Prabhakar Kumaravel. (#11234)
Inform the user about channel discrepancy between provided info, forward operator, and/or covariance matrices in mne.beamformer.make_lcmv, by Nikolai Kapralov. (#12238)
Support partial pathlength factors for each wavelength in mne.preprocessing.nirs.beer_lambert_law, by Richard Scholz. (#12446)
Add picks parameter to mne.io.Raw.plot, allowing users to select which channels to plot. This makes makes the raw data plotting API consistent with mne.Epochs.plot and mne.Evoked.plot, by Ivo de Jong. (#12467)
New class mne.time_frequency.RawTFR and new methods mne.io.Raw.compute_tfr, mne.Epochs.compute_tfr, and mne.Evoked.compute_tfr. These new methods supersede functions mne.time_frequency.tfr_morlet, and mne.time_frequency.tfr_multitaper, and mne.time_frequency.tfr_stockwell, which are now considered "legacy" functions. By `Daniel McCloy`_. (#11282)
Add ability reject mne.Epochs using callables, by `Jacob Woessner`_. (#12195)
Custom functions applied via mne.io.Raw.apply_function, mne.Epochs.apply_function or mne.Evoked.apply_function can now use ch_idx or ch_name to get access to the currently processed channel during channel wise processing.
mne.Evoked.apply_function can now also work on full data array instead of just channel wise, analogous to mne.io.Raw.apply_function and mne.Epochs.apply_function, by `Dominik Welke`_. (#12206)
Allow mne.time_frequency.EpochsTFR as input to mne.epochs.equalize_epoch_counts, by `Carina Forster`_. (#12207)
Speed up export to .edf in mne.export.export_raw by using edfio instead of EDFlib-Python. (#12218)
Added a helper function mne.preprocessing.eyetracking.convert_units to convert eyegaze data from pixel-on-screen values to radians of visual angle. Also added a helper function mne.preprocessing.eyetracking.get_screen_visual_angle to get the visual angle that the participant screen subtends, by `Scott Huberty`_. (#12237)
We added type hints for the return values of mne.read_evokeds and mne.io.read_raw. Development environments like VS Code or PyCharm will now provide more help when using these functions in your code. By `Richard Höchenberger`_ and `Eric Larson`_. (12297) (#12250)
Add method="polyphase" to mne.io.Raw.resample and related functions to allow resampling using scipy.signal.upfirdn, by `Eric Larson`_. (#12268)
The package build backend was switched from setuptools to hatchling. This will only affect users who build and install MNE-Python from source. By `Richard Höchenberger`_. (12281) (#12269)
mne.Annotations.to_data_frame can now output different formats for the onset column: seconds, milliseconds, datetime objects, and timedelta objects. By `Daniel McCloy`_. (#12289)
Add method mne.SourceEstimate.save_as_surface to allow saving GIFTI files from surface source estimates, by `Peter Molfese`_. (#12309)
mne.Epochs can now be constructed using mne.Annotations stored in the raw object, by specifying events=None. By `Alex Rockhill`_. (#12311)
Add ~mne.SourceEstimate.savgol_filter, ~mne.SourceEstimate.filter, ~mne.SourceEstimate.apply_hilbert, and ~mne.SourceEstimate.apply_function methods to mne.SourceEstimate and related classes, by `Hamza Abdelhedi`_. (#12323)
Add ability to export STIM channels to EDF in mne.io.Raw.export, by `Clemens Brunner`_. (#12332)
Speed up raw FIF reading when using small buffer sizes by `Eric Larson`_. (#12343)
Speed up mne.io.read_raw_neuralynx on large datasets with many gaps, by `Kristijan Armeni`_. (#12371)
Add ability to detect minima peaks found in mne.Evoked if data is all positive and maxima if data is all negative. (#12383)
Add ability to remove bad marker coils in mne.io.read_raw_kit, by `Judy D Zhu`_. (#12394)
Add option to pass image_kwargs to mne.Report.add_epochs to allow adjusting e.g. vmin and vmax of the epochs image in the report, by `Sophie Herbst`_. (#12443)
Add support for multiple raw instances in mne.preprocessing.compute_average_dev_head_t by `Eric Larson`_. (#12445)
Completing PR 12453. Add option to pass image_kwargs per channel type to mne.Report.add_epochs. (#12454)
mne.epochs.make_metadata now accepts strings as tmin and tmax parameter values, simplifying metadata creation based on time-varying events such as responses to a stimulus, by `Richard Höchenberger`_. (#12462)
Include date of acquisition and filter parameters in raw.info for mne.io.read_raw_neuralynx by `Kristijan Armeni`_. (#12463)
Add physical_range="channelwise" to mne.io.Raw.export for exporting to EDF, which can improve amplitude resolution if individual channels vary greatly in their offsets, by `Clemens Brunner`_. (#12510)
Added the ability to reorder report contents via mne.Report.reorder (with helper to get contents with mne.Report.get_contents), by `Eric Larson`_. (#12513)
Add exclude_after_unique option to mne.io.read_raw_edf and mne.io.read_raw_edf to search for exclude channels after making channels names unique, by `Michiru Kaneda`_ (#12518)
Updated the text in the preprocessing tutorial to use mne.io.Raw.pick instead of the legacy mne.io.Raw.pick_types, by btkcodedev. (#12326)
Clarify in the EEG referencing tutorial that an average reference projector ready is required for inverse modeling, by Nabil Alibou (#12420)
Fix dead links in README.rst documentation by Will Turner. (#12461)
Replacing percent format with f-strings format specifiers , by Hasrat Ali Arzoo. (#12464)
Adopted towncrier_ for changelog entries, by `Eric Larson`_. (#12299)
Automate adding of PR number to towncrier stubs, by `Eric Larson`_. (#12318)
Refresh code base to use Python 3.9 syntax using Ruff UP rules (pyupgrade), by `Clemens Brunner`_. (#12358)
Move private data preparation functions for BrainVision export from pybv to mne, by `Clemens Brunner`_. (#12450)
Update the list of sensor types in docstrings, tutorials and the glossary by `Nabil Alibou`_. (#12509)
Alex Rockhill
Alexander Kiefer+
Alexandre Gramfort
Britta Westner
Carina Forster
Clemens Brunner
Daniel McCloy
Dominik Welke
Eric Larson
Erkka Heinila
Florian Hofer
Hamza Abdelhedi
Hasrat Ali Arzoo+
Ivo de Jong+
Jacob Woessner
Judy D Zhu
Kristijan Armeni
Liberty Hamilton
Marijn van Vliet
Martin Oberg+
Mathieu Scheltienne
Michiru Kaneda
Motofumi Fushimi+
Nabil Alibou+
Nikolai Kapralov+
Peter J. Molfese
Richard Höchenberger
Richard Scholz+
Scott Huberty
Seyed (Yahya) Shirazi+
Sophie Herbst
Stefan Appelhoff
Thomas Donoghue
Thomas Samuel Binns
Tristan Stenner
Velu Prabhakar Kumaravel+
Will Turner+
btkcodedev+
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.6.0...v1.6.1
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.6.0...v1.6.1
mne.preprocessing.apply_maxfilter and mne maxfilter have been deprecated and will be removed in 1.7. Use mne.preprocessing.maxwell_filter (see this tu…
Add support for Neuralynx data files with mne.io.read_raw_neuralynx (11969 by Kristijan Armeni and Ivan Skelin)
Improve tests for saving splits with mne.Epochs (11884 by `Dmitrii Altukhov`_)
Added functionality for linking interactive figures together, such that changing one figure will affect another, see tut-ui-events and mne.viz.ui_events. Current figures implementing UI events are mne.viz.plot_topomap and mne.viz.plot_source_estimates (11685 11891 by `Marijn van Vliet`_)
HTML anchors for mne.Report now reflect the section-title of the report items rather than using a global incrementor global-N (11890 by `Eric Larson`_)
Added public mne.io.write_info to complement mne.io.read_info (11918 by `Eric Larson`_)
Added option remove_dc to to Raw.compute_psd(), Epochs.compute_psd(), and Evoked.compute_psd(), to allow skipping DC removal when computing Welch or multitaper spectra (11769 by `Nikolai Chapochnikov`_)
Add the possibility to provide a float between 0 and 1 as n_grad, n_mag and n_eeg in ~mne.compute_proj_raw, ~mne.compute_proj_epochs and ~mne.compute_proj_evoked to select the number of vectors based on the cumulative explained variance (11919 by `Mathieu Scheltienne`_)
Add extracting all time courses in a label using mne.extract_label_time_course without applying an aggregation function (like mean) (12001 by `Hamza Abdelhedi`_)
Added support for Artinis fNIRS data files to mne.io.read_raw_snirf (11926 by `Robert Luke`_)
Add helpful error messages when using methods on empty mne.Epochs-objects (11306 by `Martin Schulz`_)
Add support for passing a python:dict as sensor_color to specify per-channel-type colors in mne.viz.plot_alignment (12067 by `Eric Larson`_)
Add inferring EEGLAB files' montage unit automatically based on estimated head radius using read_raw_eeglab(..., montage_units="auto") (11925 by `Jack Zhang`_, 11951 by `Eric Larson`_)
Add ~mne.time_frequency.EpochsSpectrumArray and ~mne.time_frequency.SpectrumArray to support creating power spectra from NumPy array data (11803 by `Alex Rockhill`_)
Add support for writing forward solutions to HDF5 and convenience function mne.Forward.save (12036 by `Eric Larson`_)
Refactored internals of mne.read_annotations (11964 by `Paul Roujansky`_)
Add support for drawing MEG sensors in mne coreg (12098 by `Eric Larson`_)
Improve string representation of mne.Covariance (12181 by `Eric Larson`_)
Add check_version=True to mne sys_info to check for a new release on GitHub (12146 by `Eric Larson`_)
Bad channels are now colored gray in addition to being dashed when spatial colors are used in mne.viz.plot_evoked and related functions (12142 by `Eric Larson`_)
By default MNE-Python creates matplotlib figures with layout='constrained' rather than the default layout='tight' (12050, 12103 by `Mathieu Scheltienne`_ and `Eric Larson`_)
Enhance ~mne.viz.plot_evoked_field with a GUI that has controls for time, colormap, and contour lines (11942 by `Marijn van Vliet`_)
Add mne.viz.ui_events.UIEvent linking for interactive colorbars, allowing users to link figures and change the colormap and limits interactively. This supports ~mne.viz.plot_evoked_topomap, ~mne.viz.plot_ica_components, ~mne.viz.plot_tfr_topomap, ~mne.viz.plot_projs_topomap, ~mne.Evoked.plot_image, and ~mne.Epochs.plot_image (12057 by `Santeri Ruuskanen`_)
Add example KIT phantom dataset in mne.datasets.phantom_kit.data_path and tut-phantom-kit (12105 by `Judy D Zhu`_ and `Eric Larson`_)
~mne.epochs.make_metadata now accepts tmin=None and tmax=None, which will bound the time window used for metadata generation by event names (instead of a fixed time). That way, you can now for example generate metadata spanning from one cue or fixation cross to the next, even if trial durations vary throughout the recording (12118 by `Richard Höchenberger`_)
Add support for passing multiple labels to mne.minimum_norm.source_induced_power (12026 by `Erica Peterson`_, `Eric Larson`_, and `Daniel McCloy`_ )
Added documentation to mne.io.Raw.set_montage and mne.add_reference_channels to specify that montages should be set after adding reference channels (12160 by `Jacob Woessner`_)
Add argument splash to the function using the qt browser backend to allow enabling/disabling the splash screen (12185 by `Mathieu Scheltienne`_)
~mne.preprocessing.ICA's HTML representation (displayed in Jupyter notebooks and mne.Report) now includes all optional fit parameters (e.g., max. number of iterations) (12194, by `Richard Höchenberger`_)
Fix bug where mne.io.read_raw_gdf would fail due to improper usage of np.clip (12168 by Rasmus Aagaard)
Fix bugs with mne.preprocessing.realign_raw where the start of other was incorrectly cropped; and onsets and durations in other.annotations were left unsynced with the resampled data (11950 by Qian Chu)
Fix bug where encoding argument was ignored when reading annotations from an EDF file (11958 by Andrew Gilbert)
Mark tests test_adjacency_matches_ft and test_fetch_uncompressed_file as network tests (12041 by Maksym Balatsko)
Fix bug with mne.channels.read_ch_adjacency (11608 by Ivan Zubarev)
Fix bug where epochs.get_data(..., scalings=...) would errantly modify the preloaded data (12121 by Pablo Mainar and `Eric Larson`_)
Fix bugs with saving splits for ~mne.Epochs (11876 by `Dmitrii Altukhov`_)
Fix bug with multi-plot 3D rendering where only one plot was updated (11896 by `Eric Larson`_)
Fix bug where verbose level was not respected inside parallel jobs (12154 by `Eric Larson`_)
Fix bug where subject birthdays were not correctly read by mne.io.read_raw_snirf (11912 by `Eric Larson`_)
Fix bug where warnings were emitted when computing spectra for channels marked as bad (12186 by `Eric Larson`_)
Fix bug with mne.chpi.compute_head_pos for CTF data where digitization points were modified in-place, producing an incorrect result during a save-load round-trip (11934 by `Eric Larson`_)
Fix bug where non-compliant stimulus data streams were not ignored by mne.io.read_raw_snirf (11915 by `Johann Benerradi`_)
Fix bug with pca=False in mne.minimum_norm.compute_source_psd (11927 by `Alex Gramfort`_)
Fix bug with notebooks when using PyVista 0.42 by implementing trame backend support (11956 by `Eric Larson`_)
Removed preload parameter from mne.io.read_raw_eyelink, because data are always preloaded no matter what preload is set to (11910 by `Scott Huberty`_)
Fix bug with mne.viz.Brain.get_view where calling ~mne.viz.Brain.show_view with returned parameters would change the view (12000 by `Eric Larson`_)
Fix bug with mne.viz.Brain.show_view where distance=None would change the view distance (12000 by `Eric Larson`_)
Fix bug with ~mne.viz.Brain.add_annotation when reading an annotation from a file with both hemispheres shown (11946 by `Marijn van Vliet`_)
Fix bug with reported component number and errant reporting of PCA explained variance as ICA explained variance in mne.Report.add_ica (12155, 12167 by `Eric Larson`_ and `Richard Höchenberger`_)
Fix bug with axis clip box boundaries in mne.viz.plot_evoked_topo and related functions (11999 by `Eric Larson`_)
Fix bug with subject_info when loading data from and exporting to EDF file (11952 by `Paul Roujansky`_)
Fix bug where mne.Info HTML representations listed all channel counts instead of good channel counts under the heading "Good channels" (12145 by `Eric Larson`_)
Fix rendering glitches when plotting Neuromag/TRIUX sensors in mne.viz.plot_alignment and related functions (12098 by `Eric Larson`_)
Fix bug with delayed checking of info["bads"] (12038 by `Eric Larson`_)
Fix bug with mne coreg where points inside the head surface were not shown (12147, 12164 by `Eric Larson`_)
Fix bug with mne.viz.plot_alignment where sensor_colors were not handled properly on a per-channel-type basis (12067 by `Eric Larson`_)
Fix handling of channel information in annotations when loading data from and exporting to EDF file (11960 12017 12044 by `Paul Roujansky`_)
Add missing overwrite and verbose parameters to Transform.save() (12004 by `Marijn van Vliet`_)
Fix parsing of eye-link ~mne.Annotations when apply_offsets=False is provided to ~mne.io.read_raw_eyelink (12003 by `Mathieu Scheltienne`_)
Correctly prune channel-specific ~mne.Annotations when creating ~mne.Epochs without the channel(s) included in the channel specific annotations (12010 by `Mathieu Scheltienne`_)
Fix ~mne.viz.plot_volume_source_estimates with ~mne.VolSourceEstimate which include a list of vertices (12025 by `Mathieu Scheltienne`_)
Add support for non-ASCII characters in Annotations, Evoked comments, etc when saving to FIFF format (12080 by `Daniel McCloy`_)
Correctly handle passing "eyegaze" or "pupil" to mne.io.Raw.pick (12019 by `Scott Huberty`_)
Fix bug with mne.time_frequency.Spectrum.plot and related functions where bad channels were not marked (12142 by `Eric Larson`_)
Fix bug with ~mne.viz.plot_raw where changing MNE_BROWSER_BACKEND via ~mne.set_config would have no effect within a Python session (12078 by `Santeri Ruuskanen`_)
Improve handling of method argument in the channel interpolation function to support str and raise helpful error messages (12113 by `Mathieu Scheltienne`_)
Fix combination of DIN event channels into a single synthetic trigger channel STI 014 by the MFF reader of mne.io.read_raw_egi (12122 by `Mathieu Scheltienne`_)
Fix bug with mne.io.read_raw_eeglab and mne.read_epochs_eeglab where automatic fiducial detection would fail for certain files (12165 by `Clemens Brunner`_)
Fix concatenation of raws with np.nan in the device to head transformation (12198 by `Mathieu Scheltienne`_)
Fix bug with mne.viz.plot_compare_evokeds where the title was not displayed when axes='topo' (12192 by `Jacob Woessner`_)
Fix bug with mne.io.read_raw_cnt where the bad channels were not properly read (12189 by `Jacob Woessner`_)
Fix bug where iterating over ~mne.io.Raw would result in an error (12205 by `Clemens Brunner`_)
The default for mne.Epochs.get_data of copy=False will change to copy=True in 1.7. Set it explicitly to avoid a warning (12121 by Pablo Mainar and `Eric Larson`_)
mne.preprocessing.apply_maxfilter and mne maxfilter have been deprecated and will be removed in 1.7. Use mne.preprocessing.maxwell_filter (see this tutorial) in Python or the command-line utility from MEGIN maxfilter and mne.bem.fit_sphere_to_headshape instead (11938 by `Eric Larson`_)
mne.io.kit.read_mrk reading pickled files is deprecated using something like np.savetxt(fid, pts, delimiter="\t", newline="\n") to save your points instead (11937 by `Eric Larson`_)
Replace legacy inst.pick_channels and inst.pick_types with inst.pick (where inst is an instance of ~mne.io.Raw, ~mne.Epochs, or ~mne.Evoked) wherever possible (11907 by `Clemens Brunner`_)
The reset_camera parameter has been removed in favor of distance="auto" in mne.viz.set_3d_view, mne.viz.Brain.show_view, and related functions (12000 by `Eric Larson`_)
Several unused parameters from mne.gui.coregistration are now deprecated: tabbed, split, scrollable, head_inside, guess_mri_subject, scale, and advanced_rendering. All arguments are also now keyword-only. (12147 by `Eric Larson`_)
Adam Li
Alex Rockhill
Alexandre Gramfort
Ana Radanovic
Andrew Gilbert+
Clemens Brunner
Daniel McCloy
Denis A. Engemann
Dimitri Papadopoulos Orfanos
Dmitrii Altukhov
Dominik Welke
Eric Larson
Erica Peterson
Gonzalo Reina
Hamza Abdelhedi
Ivan Skelin+
Ivan Zubarev+
Jack Zhang
Jacob Woessner
Johann Benerradi
John Veillette
Judy D Zhu
Kristijan Armeni+
Mainak Jas
Maksym Balatsko+
Marijn van Vliet
Martin Schulz
Mathieu Scheltienne
Nikolai Chapochnikov
Pablo Mainar+
Paul Roujansky
Qian Chu+
Rasmus Aagaard+
Richard Höchenberger
Rob Luke
Santeri Ruuskanen
Scott Huberty
Stefan Appelhoff
Nothing published for this version
Deprecated gap_description keyword argument of mne.io.read_raw_eyelink, which will be removed in mne version 1.6, in favor of using mne.Annotations.re…
Add reader for NSx files (Blackrock Microsystems Data Acquisition Systems) (11432 by Proloy Das)
Add cmap argument for the mne.viz.plot_sensors (11720 by Gennadiy Belonosov)
Return unmodified instance if new sampling frequency is identical to the original in mne.io.Raw.resample, mne.Epochs.resample, mne.Evoked.resample and mne.SourceEstimate.resample (11736 by Gennadiy Belonosov)
When failing to locate a file, we now print the full path in quotation marks to help spot accidentally added trailing spaces (11718 by `Richard Höchenberger`_)
Add standard montage lookup table for easycap-M43 (11744 by Diptyajit Das)
Added mne.preprocessing.eyetracking.Calibration to store eye-tracking calibration info, and mne.preprocessing.eyetracking.read_eyelink_calibration to read calibration data from EyeLink systems (11719 by `Scott Huberty`_)
Ocular mne.Annotations read in by mne.io.read_raw_eyelink are now channel aware. This means if the left eye blinked, the associated annotation will store this in the 'ch_names' key. (11746 by `Scott Huberty`_)
Added mne.preprocessing.eyetracking.interpolate_blinks to linear interpolate eyetrack signals during blink periods. (11740 by `Scott Huberty`_)
Added a section for combining eye-tracking and EEG data to the preprocessing tutorial "working with eye tracker data in MNE-Python" (11770 by `Scott Huberty`_)
Added a show_bytes option to mne show_fiff to show byte offsets (11800 by `Eric Larson`_)
Add mne.Annotations.count and mne.count_annotations to count unique annotations (11796 by `Clemens Brunner`_)
Split the display of mne.preprocessing.ICA.plot_overlay between sensor types and display the RMS for MEG sensors and the GFP for EEG sensors in the second panel instead of the channel average (11830 by `Mathieu Scheltienne`_)
Add mne.Info.set_channel_types, mne.Info.rename_channels, mne.Info.plot_sensors, mne.Info.anonymize, mne.Info.set_meas_date (11839 by `Alex Rockhill`_)
Curry and NEDF raw files can now also be read with the generic mne.io.read_raw function (11841 by `Richard Höchenberger`_)
Fix bug in mne.bem.convert_flash_mris to handle missing "flash5_reg.mgz" when processing "flash30" data. (11842 by Hamza Abdelhedi)
Fix bug where epochs event_id was not kept by mne.channels.combine_channels (11786 by Samuel Louviot)
Fix bug where user-provided codec was not used to read annotations when loading EEGLAB .set files (11773 by Yiping Zuo)
Fix bug that required curv.*h files to create Brain object (11704 by Aaron Earle-Richardson)
Extended test to highlight bug in mne.stats.permutation_t_test (11575 by Joshua Calder-Travis)
Fix bug that used wrong indices for line/label styles (sometimes causing an IndexError) in mne.preprocessing.ICA.plot_sources under certain conditions (11808 by Joshua Calder-Travis)
Fix bug with ~mne.io.read_raw_snirf to handle files with measurement time containing milliseconds (11804 by Daniel Tse)
Fix loading of EDF with mixed sampling frequencies with mne.io.read_raw_edf: Upsampling is now applied to the entire signal and no longer block based, significantly reducing edge artifacts (11549 by `Simon Kern`_)
Fix bug where mne.io.read_raw_cnt imports unnecessary durations (11828 by `Jacob Woessner`_)
Fix bug where mne.viz.Brain.add_volume_labels used an incorrect orientation (11730 by `Alex Rockhill`_)
Fix bug with mne.forward.restrict_forward_to_label where cortical patch information was not adjusted (11694 by `Eric Larson`_)
Fix bug with PySide6 compatibility (11721 by `Eric Larson`_)
Fix bug with mne.io.Raw, mne.SourceEstimate, and related classes where the decimate and shift_time methods were errantly added (11853 by `Eric Larson`_)
Fix hanging interpreter with matplotlib figures using mne/viz/_mpl_figure.py in spyder console and jupyter notebooks (11696 by `Mathieu Scheltienne`_)
Fix bug with overlapping text for mne.Evoked.plot (11698 by `Alex Rockhill`_)
Fix bug with mne.preprocessing.corrmap where the template iteration had non-standard map averaging (11857 by `Eric Larson`_)
For mne.io.read_raw_eyelink, the default value of the gap_description parameter is now 'BAD_ACQ_SKIP', following MNE convention (11719 by `Scott Huberty`_)
Fix bug with mne.io.read_raw_fil where datasets without sensor positions would not import (11733 by `George O'Neill`_)
Fix bug with mne.chpi.compute_chpi_snr where cHPI being off for part of the recording or bad channels being defined led to an error or incorrect behavior (11754, 11755 by `Eric Larson`_)
Allow int-like for the argument id of ~mne.make_fixed_length_events (11748 by `Mathieu Scheltienne`_)
Fix bugs with mne.decoding classes (11846 by `Eric Larson`_): - mne.decoding.ReceptiveField now sets rf.fit_intercept_ during fit() rather than overwriting rf.fit_intercept - mne.decoding.SlidingEstimator now returns the same dtype as X (usually float64) in sl.transform(X) rather than always returning int
Fix bug with mne.beamformer.make_lcmv where the source space was not checked properly when the label argument was provided (11852 by `Eric Larson`_)
Fix bug where mne.io.read_raw_egi did not properly set the EEG reference location for the reference channel itself (11822 by `Eric Larson`_)
Fix bug with legacy ~mne.io.Raw.plot_psd method where passed axes were not used (11778 by `Daniel McCloy`_)
blink mne.Annotations read in by mne.io.read_raw_eyelink now begin with 'BAD_', i.e. 'BAD_blink', because ocular data are missing during blinks. (11746 by `Scott Huberty`_)
Fix bug where mne show_fiff could fail with an ambiguous error if the file is corrupt (11800 by `Eric Larson`_)
Fix bug where annotation FIF files lacked an end block tag (11800 by `Eric Larson`_)
Fix display of ~mne.Annotations in mne.preprocessing.ICA.plot_sources when the raw has raw.first_samp != 0 and doesn't have a measurement date (11766 by `Mathieu Scheltienne`_)
Fix bug in read_raw_eyelink, where STATUS information of samples was always assumed to be in the file. Performance and memory improvements were also made. (11823 by `Scott Huberty`_)
Fix closing of a topographic map created from an interactive drag on an Evoked or PSD plot (11862 by `Mathieu Scheltienne`_)
The baseline argument can now be array-like (e.g. list, tuple, np.ndarray, ...) instead of only a tuple (11713 by `Clemens Brunner`_)
The events and event_id parameters of Epochs.plot() now accept boolean values; see docstring for details (11445 by `Daniel McCloy`_ and `Clemens Brunner`_)
Deprecated gap_description keyword argument of mne.io.read_raw_eyelink, which will be removed in mne version 1.6, in favor of using mne.Annotations.rename (11719 by `Scott Huberty`_)
Aaron Earle-Richardson+
Alex Rockhill
Alexandre Gramfort
Britta Westner
Clemens Brunner
Daniel McCloy
Daniel Tse+
Diptyajit Das+
Eric Larson
Gennadiy Belonosov+
George O'Neill
Hamza Abdelhedi+
Jacob Woessner
Joshua Calder-Travis+
Mathieu Scheltienne
Proloy Das
Richard Höchenberger
Rob Luke
Samuel Louviot+
Scott Huberty
Simon Kern
Stefan Appelhoff
Thomas Moreau
Yiping Zuo+
Nothing published for this version
Nothing published for this version
Improving compatibility with Qt6 by removing the use of deprecated AA_UseHighDpiPixmaps attribute for this Qt version (11662 by Florin Pop)
Add functionality for reading CNT spans/annotations marked bad to mne.io.read_raw_cnt (11631 by Jacob Woessner)
Add :unit: Sphinx directive to enable use of uniform non-breaking spaces throughout the documentation (11469 by Sawradip Saha)
Adjusted the algorithm used in mne.decoding.SSD to support non-full rank data (11458 by Thomas Binns)
Changed suggested type for ch_groups in mne.viz.plot_sensors from array to list of list(s) (arrays are still supported). (11465 by `Hyonyoung Shin`_)
Add support for UCL/FIL OPM data using mne.io.read_raw_fil (11366 by George O'Neill and `Robert Seymour`_)
Add harmonic field correction (HFC) for OPM sensors in mne.preprocessing.compute_proj_hfc (11536 by George O'Neill and `Eric Larson`_)
Forward argument axes from mne.viz.plot_sensors to mne.channels.DigMontage.plot (11470 by Jan Ebert and `Mathieu Scheltienne`_)
Add forward IIR filtering, using parameters method='iir', phase='forward' (11078 by Quentin Barthélemy)
Added ability to read stimulus durations from SNIRF files when using mne.io.read_raw_snirf (11397 by `Robert Luke`_)
Add mne.Info.save to save an mne.Info object to a fif file (11401 by `Alex Rockhill`_)
Improved error message when downloads are corrupted for mne.datasets.sample.data_path and related functions (11407 by `Eric Larson`_)
Improved mne.get_config("") behavior to return a dict of key-value pairs (config key and its description) rather than just a tuple of config keys (11166 by `Clemens Brunner`_, `Daniel McCloy`_, and `Eric Larson`_)
Add support for skip_by_annotation in mne.io.Raw.notch_filter (11388 by `Mainak Jas`_)
Add support for output='complex' to mne.time_frequency.psd_array_welch and when using method='welch' with mne.Epochs.compute_psd (11556 by `Eric Larson`_)
Slightly adjusted the window title for mne.Epochs.plot (11419 by `Richard Höchenberger`_ and `Daniel McCloy`_)
Add mne.count_events to count unique event types in a given event array (11430 by `Clemens Brunner`_)
Add a video to tut-freesurfer-mne of a brain inflating from the pial surface to aid in understanding the inflated brain (11440 by `Alex Rockhill`_)
Add automatic projection of sEEG contact onto the inflated surface for mne.viz.Brain.add_sensors (11436 by `Alex Rockhill`_)
Allow an image with intracranial electrode contacts (e.g. computed tomography) to be used without the FreeSurfer recon-all surfaces to locate contacts so that it doesn't have to be downsampled to FreeSurfer dimensions (for microelectrodes) and show an example ex-ieeg-micro with mne.transforms.apply_volume_registration_points added to aid this transform (11567 by `Alex Rockhill`_)
Use new dipy.align.imwarp.DiffeomorphicMap.transform_points to transform a montage of intracranial contacts more efficiently (11572 by `Alex Rockhill`_)
Improve performance of raw data browsing with many annotations (11614 by `Eric Larson`_)
Add support for mne.preprocessing.maxwell_filter with gradient-compensated CTF data, e.g., for tSSS-only mode (10554 by `Eric Larson`_)
Add support for eyetracking data using mne.io.read_raw_eyelink (11152 by `Dominik Welke`_ and `Scott Huberty`_)
mne.channels.make_1020_channel_selections gained a new parameter, return_ch_names, to allow for easy retrieval of EEG channel names corresponding to the left, right, and midline portions of the montage (11632 by `Richard Höchenberger`_)
Methods for setting the sensor types of channels (e.g., for raw data, mne.io.Raw.set_channel_types) gained a new parameter, on_unit_change, to control behavior (raise an exception, emit a warning, or do nothing) in case the measurement unit is adjusted automatically (11668 by `Richard Höchenberger`_)
mne.beamformer.trap_music implements the TRAP-MUSIC localisation algorithm with the same signature as mne.beamformer.rap_music (11679 by `Théodore Papadopoulo`_)
Improving compatibility with Qt6 by removing the use of deprecated AA_UseHighDpiPixmaps attribute for this Qt version (11662 by Florin Pop)
Fix mne.time_frequency.psd_array_multitaper docstring where argument bandwidth incorrectly reported argument as half-bandwidth and gave wrong explanation of default value (11479 by Tom Stone)
Fix bug where installation of a package depending on mne will error when done in an environment where setuptools is not present (11454 by Arne Pelzer)
Fix bug in mne.Annotations.rename where replacements were not done correctly (11666 by Timur Sokhin and `Eric Larson`_)
Fix mne.time_frequency.Spectrum.to_data_frame's docstring to reflect the correct name for the appended frequencies column (11457 by Zvi Baratz)
Fix bug with mne.io.read_raw_egi where events outside the recording window could break data reading (11505 by Niels Focke)
Fix bug where mne.preprocessing.regress_artifact and mne.preprocessing.EOGRegression incorrectly tracked picks (11366 by `Eric Larson`_)
Fix bug where channel names were not properly sanitized in mne.write_evokeds and related functions (11399 by `Eric Larson`_)
Fix bug where splash screen would not always disappear (11398 by `Eric Larson`_)
Fix bug where having a different combination of volumes loaded into freeview caused different affines to be returned by mne.read_lta for the same Linear Transform Array (LTA) (11402 by `Alex Rockhill`_)
Fix how mne.channels.DigMontage is set when using mne.gui.locate_ieeg so that mne.Info.get_montage works and does not return None (11421 by `Alex Rockhill`_)
Fix mne.io.read_raw_edf when reading EDF data with different sampling rates and a mix of data channels when using infer_types=True (11427 by `Alex Gramfort`_)
Fix how mne.channels.DigMontage is set when using mne.preprocessing.ieeg.project_sensors_onto_brain so that mne.Info.get_montage works and does not return None (11436 by `Alex Rockhill`_)
Fix configuration folder discovery on Windows, which would fail in certain edge cases; and produce a helpful error message if discovery still fails (11441 by `Richard Höchenberger`_)
Make ~mne.decoding.SlidingEstimator and ~mne.decoding.GeneralizingEstimator respect the verbose argument. Now with verbose=False, the progress bar is not shown during fitting, scoring, etc. (11450 by `Mikołaj Magnuski`_)
Fix bug with mne.gui.locate_ieeg where FreeSurfer ?h.pial.T1 was not recognized and suppress excess logging (11489 by `Alex Rockhill`_)
All functions accepting paths can now correctly handle ~pathlib.Path as input. Historically, we expected strings (instead of "proper" path objects), and only added ~pathlib.Path support in a few select places, leading to inconsistent behavior. (11473 and 11499 by `Mathieu Scheltienne`_)
Fix visualization dialog compatibility with matplotlib 3.7 (11409 by `Daniel McCloy`_ and `Eric Larson`_)
Expand tilde (user directory) in config keys (11537 by `Clemens Brunner`_)
Fix bug in mne.preprocessing.compute_maxwell_basis where using int_order=0 would raise an error (11562 by `Eric Larson`_)
In the legacy function mne.viz.plot_epochs_psd_topomap, the parameter names now works again (11563 by `Daniel McCloy`_)
Fix mne.io.read_raw for file names containing multiple dots (11521 by `Clemens Brunner`_)
Fix bug in mne.export.export_raw when exporting to EDF with a physical range set smaller than the data range (11569 by `Mathieu Scheltienne`_)
Fix bug in mne.concatenate_raws where two raws could not be merged if the order of the bad channel lists did not match (11502 by `Moritz Gerster`_)
Fix bug where mne.Evoked.plot_topomap opened an extra figure (11607 by `Alex Rockhill`_)
Fix bug where mne.transforms.apply_volume_registration_points modified info in place (11612 by `Alex Rockhill`_)
Fix bug where Maxwell-filtered data rank was not handled properly in mne.beamformer.make_lcmv (11664 by `Eric Larson`_)
In ~mne.Report, custom figures now show up correctly when image_format='svg' is requested (11623 by `Richard Höchenberger`_)
Fix bug where providing axes in mne.preprocessing.ICA.plot_components would fail (11654 by `Mathieu Scheltienne`_)
Fix deprecation of title, vmin and vmax in ~mne.viz.plot_tfr_topomap called from interactive mne.time_frequency.AverageTFR.plot_topo (11683 by `Mathieu Scheltienne`_)
Deprecate mne.gui.locate_ieeg in favor of mne-gui-addons:mne_gui_addons.locate_ieeg (11616 by `Alex Rockhill`_)
Deprecate arguments kind and path from mne.channels.read_layout in favor of a common argument fname (11500 by `Mathieu Scheltienne`_)
Change aligned_ct positional argument in mne.gui.locate_ieeg to base_image to reflect that this can now be used with unaligned images (11567 by `Alex Rockhill`_)
mne.warp_montage_volume was deprecated in favor of mne.preprocessing.ieeg.warp_montage (acts directly on points instead of using an intermediate volume) and mne.preprocessing.ieeg.make_montage_volume (which makes a volume of ieeg contact locations which can still be useful) (11572 by `Alex Rockhill`_)
Deprecate mne.pick_channels_evoked in favor of evoked.copy().pick(...) (11665 by `Eric Larson`_)
Set instance methods inst.pick_types and inst.pick_channels as legacy in favor of inst.pick(...) (11665 by `Eric Larson`_)
The default of inst.pick_channels(..., ordered=False) will change to ordered=True in 1.5 to avoid silent bugs (11665 by `Eric Larson`_)
Alex Rockhill
Alexandre Gramfort
Arne Pelzer+
Britta Westner
Carlos de la Torre-Ortiz
Clemens Brunner
Daniel Hasegan
Daniel McCloy
Denis A. Engemann
Dimitri Papadopoulos Orfanos
Dinara Issagaliyeva
Dominik Welke
Enzo Altamiranda
Eric Brayet
Eric Larson
Erkka Heinila
Felix Klotzsche
Florin Pop+
George O'Neill+
Giulio
Hakimeh Aslsardroud
Hyonyoung Shin+
Jacob Woessner+
Jan Ebert+
Jennifer Behnke
Jevri Hanna
Lukas Hecker
Mainak Jas
Mark Alexander Henney
Mathieu Scheltienne
Mauricio Cespedes Tenorio
Michiru Kaneda
Mikołaj Magnuski
Moritz Gerster
Niels Focke+
Omer Shubi
Pavel Navratil
Quentin Barthélemy+
Richard Höchenberger
Rob Luke
Robert Seymour+
Santeri Ruuskanen
Sawradip Saha+
Scott Huberty
Stefan Appelhoff
Theodore Papadopoulo
Thomas Samuel Binns+
Timon Merk
Timur Sokhin+
Tom Ma
Tom Stone+
Toomas Erik Anijärv
Zvi Baratz+
Nothing published for this version
In mne.time_frequency.dpss_windows, interpolating is deprecated (nowadays SciPy's computations are fast enough for large N without interpolation). Thi…
Improve default line width used in mne.viz.plot_filter (11333 by Toomas Erik Anijärv)
Add the argument max_iter to ~mne.time_frequency.psd_array_multitaper and to ~mne.time_frequency.csd_array_multitaper to increase the maximum number of iterations to reach convergence when using adaptive=True (11237 by `Mathieu Scheltienne`_)
Add a warning to the docstring of mne.channels.find_ch_adjacency to encourage users to validate their outputs (11236 by `Felix Klotzsche`_ and `Eric Larson`_)
Mixed, cortical + discrete source spaces with fixed orientations are now allowed. (11241 by `Jevri Hanna`_)
Add size information to the repr of mne.Report (11357 by `Eric Larson`_)
Add support for image_format='webp' to mne.Report when using Matplotlib 3.6+, which can reduce file sizes by up to 50% compared to 'png'. The new default image_format='auto' will automatically use this format if it's available on the system (11359 by `Eric Larson`_)
Add mne.beamformer.apply_dics_tfr_epochs to apply a DICS beamformer to time-frequency resolved epochs (11096 by `Alex Rockhill`_)
Add mne.time_frequency.fwhm to determine the full-width half maximum for mne.time_frequency.morlet (11353 by `Britta Westner`_, `Daniel McCloy`_, and `Eric Larson`_)
Check whether head radius (estimated from channel positions) is correct when reading EEGLAB data with ~mne.io.read_raw_eeglab and ~mne.read_epochs_eeglab. If head radius is not within likely values, warn informing about possible units mismatch and the new montage_units argument (11283 by `Mikołaj Magnuski`_).
Add support for a callable passed in combine for mne.time_frequency.AverageTFR.plot and mne.time_frequency.AverageTFR.plot_joint (11329 by `Mathieu Scheltienne`_)
Fix bug in mne.export.export_raw when exporting raw to EDF with EDFLib when subject sex is missing (11375 by Mark Alexander Henney)
Fix bugs in documentation of mne.time_frequency.tfr_array_multitaper and related functions/methods (11310 by Santeri Ruuskanen)
Fix bug to be able to customize legends when using mne.viz.Brain.add_volume_labels (11289 by Mauricio Cespedes Tenorio)
Fix bug in documentation of mne.channels.make_dig_montage (11235 by Daniel Hasegan)
Add support for bad channel handling in mne.set_bipolar_reference (11245 by `Moritz Gerster`_, Dinara Issagaliyeva, Jennifer Behnke, Hakimeh Aslsardroud, and Pavel Navratil)
Fix X coordinates of ear_left and ear_right in head outlines dict (11255 by Tom Ma)
Add type checking for tmin and tmax arguments for crop (11263 by Carlos de la Torre-Ortiz).
Fix bug where trying to setup projection without an EEG average reference projector would fail (11351 by Enzo Altamiranda)
Fix bug where ica.reject_ was not saved to disk, and the ica.reject_ property was not inherited from Epochs when doing ICA.fit(epochs) (11244 by `Eric Larson`_)
Fix bug in automatic MESA detection for disabling advanced 3D options (11271 by `Eric Larson`_)
Fix bug in mne.head_to_mri when unscale=True (11303 by `Eric Larson`_)
Fix bug in set_montage('mgh60') and related functions where the 'mgh60' sensor positions were incorrectly ordered (11290 by `Eric Larson`_)
Fix bug in the .compute_psd() methods where the number of unaggregated Welch segments was wrongly computed for some inputs, leading to an assertion error when computing the PSD (11248 by `Daniel McCloy`_)
Fix bug in the ~mne.viz.plot_evoked_topo and ~mne.Evoked.plot_topo, where legend colors where shown incorrectly on newer matplotlib versions (11258 by `Erkka Heinila`_)
Fix bug where EEGLAB channel positions were read as meters, while they are commonly in millimeters, leading to head outlies of the size of one channel when plotting topomaps. Now montage_units argument has been added to ~mne.io.read_raw_eeglab and ~mne.read_epochs_eeglab to control in what units EEGLAB channel positions are read. The default is millimeters, 'mm' (11283 by `Mikołaj Magnuski`_)
Fix bug where computing PSD with welch's method with more jobs than channels would fail (11298 by `Mathieu Scheltienne`_)
Fix bug where the default FFT length changed for spectrum plots (11345 by `Daniel McCloy`_)
Fix bug with mne.decoding.cross_val_multiscore where progress bars were not displayed correctly (11311 by `Eric Larson`_)
Fix channel selection edge-cases in ~mne.preprocessing.ICA.find_bads_muscle (11300 by `Mathieu Scheltienne`_)
Fix bug with mne.io.read_raw_curry where a dot in the parent folders prevented files from being read (11340 by `Eric Larson`_)
Fix bug with mne.Report with replace=True where the wrong content was replaced and section was not respected (11318, 11346 by `Eric Larson`_)
Fix bug with unit conversion when setting reference MEG as the channel type in mne.io.Raw.set_channel_types and related methods (11344 by `Eric Larson`_)
Fix bug where reference MEG channels could not be plotted using mne.viz.plot_epochs_image (11344 by `Eric Larson`_)
Fix bug where image_format='gif' was errantly documented as being supported by mne.Report, it is now only supported in mne.Report.add_image (11347 by `Eric Larson`_)
Multitaper spectral estimation now uses periodic (rather than symmetric) taper windows. This also necessitated changing the default max_iter of our cross-spectral density functions from 150 to 250. (11293 by `Daniel McCloy`_)
Fix mne.Epochs.plot_image and mne.viz.plot_epochs_image when using EMG signals (11322 by `Alex Gramfort`_)
Fix selection of ICA components in mne.viz.plot_ica_components and mne.preprocessing.ICA.plot_components (11369 by `Mathieu Scheltienne`_)
Fix bug where a FreeSurfer reconstruction run with both a T1 and a T2 caused mne.viz.Brain not to initialize pial surfaces properly (11361 by `Alex Rockhill`_)
In mne.time_frequency.dpss_windows, interpolating is deprecated (nowadays SciPy's computations are fast enough for large N without interpolation). This affects parameters interp_from and interp_kind. Two new parameters of the underlying SciPy ~scipy.signal.windows.dpss function are also exposed: sym (for choosing symmetric vs. periodic windows) and norm (window normalization method). (11293 by `Daniel McCloy`_)
In mne.decoding.CSP.plot_patterns, mne.decoding.CSP.plot_filters, mne.preprocessing.ICA.plot_components, and mne.viz.plot_ica_components, the parameters vmin and vmax are deprecated in favor of vlim, for consistency with other topomap-plotting functions and methods (11371 by `Daniel McCloy`_)
In mne.decoding.CSP.plot_patterns and mne.decoding.CSP.plot_filters the title parameter is deprecated and will be removed in version 1.4 (11371 by `Daniel McCloy`_)
The APIs of mne.preprocessing.ICA.plot_components and mne.viz.plot_ica_components gained new parameters show_names, extrapolate, border, size, cnorm, cbar_fmt, axes, nrows, ncols, for consistency with other topomap-plotting functions and methods (11371 by `Daniel McCloy`_)
The APIs of mne.decoding.CSP.plot_patterns and mne.decoding.CSP.plot_filters gained new parameters extrapolate, border, cnorm, axes, nrows, ncols, for consistency with other topomap-plotting functions and methods (11371 by `Daniel McCloy`_)
Alex Rockhill
Alexandre Gramfort
Britta Westner
Carlos de la Torre-Ortiz+
Daniel Hasegan+
Daniel McCloy
Dinara Issagaliyeva+
Enzo Altamiranda+
Eric Brayet+
Eric Larson
Erkka Heinila
Felix Klotzsche
Hakimeh Aslsardroud+
Jennifer Behnke+
Jevri Hanna
Lukas Hecker
Mark Alexander Henney+
Mathieu Scheltienne
Mauricio Cespedes Tenorio+
Mikołaj Magnuski
Moritz Gerster
Omer Shubi+
Pavel Navratil+
Richard Höchenberger
Santeri Ruuskanen+
Stefan Appelhoff
Timon Merk
Tom Ma+
Toomas Erik Anijärv+
Nothing published for this version
Nothing published for this version
Nothing published for this version
Starting with this release we now follow the Python convention of using FutureWarning instead of DeprecationWarning to signal user-facing changes to o…
Add vmin and vmax parameters to mne.Evoked.animate_topomap (11073 by Mats van Es)
Enable common average reference projection for ECoG, sEEG, and DBS data (optionally jointly with joint=True) in ~mne.io.Raw.set_eeg_reference and related functions/methods (10656 by Moritz Gerster and `Eric Larson`_)
The trans parameter in mne.make_field_map now accepts a ~pathlib.Path object, and uses standardised loading logic (10784 by Andrew Quinn)
Add support for computing forward solutions using OpenMEEG_ (11011 by `Alex Gramfort`_ and `Eric Larson`_)
EEGLAB files (saved as MAT versions less than v7.3) can now be imported with mne.io.read_raw_eeglab without the optional dependency pymatreader (11006 by `Clemens Brunner`_)
Add eight source estimate comparison metrics to new submodule mne.simulation.metrics (6233 by `Kostiantyn Maksymenko`_ and `Alex Gramfort`_)
Add mne.time_frequency.csd_tfr to compute cross-spectral density from mne.time_frequency.EpochsTFR (10986 by `Alex Rockhill`_)
Improve repr() for mne.minimum_norm.InverseOperator when loose orientation is used (11048 by `Eric Larson`_)
Add support for vector and volume source estimates in mne.minimum_norm.get_point_spread and mne.minimum_norm.get_cross_talk (8639, 11083 by `Olaf Hauk`_, `Marijn van Vliet`_, `Alex Gramfort`_, and `Eric Larson`_)
mne.Epochs.plot_psd_topomap now suppresses redundant colorbars when vlim='joint' (11051 by `Daniel McCloy`_)
Add starting_affine keyword argument to mne.transforms.compute_volume_registration to initialize an alignment with an affine (11020 by `Alex Rockhill`_)
Add HTML representation for ~mne.Evoked in Jupyter Notebooks (11075 by `Valerii Chirkov`_ and `Andrew Quinn`_)
Add support for temperature and gsr (galvanic skin response, i.e., electrodermal activity) channel types (11090, 11108 by `Eric Larson`_ and `Richard Höchenberger`_)
Allow mne.beamformer.make_dics to take pick_ori='vector' to compute vector source estimates (10980 by `Alex Rockhill`_)
Add units parameter to mne.io.read_raw_edf in case units are missing from the file (11099 by `Alex Gramfort`_)
Add on_missing functionality to all of our classes that have a drop_channels method, to control what happens when channel names are not in the object (11077 by `Andrew Quinn`_)
Improve interpolation of bridged electrodes with ~mne.preprocessing.interpolate_bridged_electrodes (11094 by `Mathieu Scheltienne`_)
Add mne.minimum_norm.apply_inverse_tfr_epochs to apply inverse methods to time-frequency resolved epochs (11095 by `Alex Rockhill`_)
Add support for multiple probes via multiple CSV files passed to mne.io.read_raw_hitachi (11186 by `Eric Larson`_)
Add mne.chpi.get_active_chpi to retrieve the number of active hpi coils for each time point (11122 by `Eduard Ort`_)
Add example of how to obtain time-frequency decomposition using narrow bandpass Hilbert transforms to ex-tfr-comparison (11116 by `Alex Rockhill`_)
Add == and != comparison between mne.Projection objects (11147 by `Mathieu Scheltienne`_)
Parse automatically temperature channel with mne.io.read_raw_edf (11150 by `Eric Larson`_ and `Alex Gramfort`_)
Add unscale option to mne.head_to_mri to facilitate working with surrogate MRI data (11185 by `Eric Larson`_)
Add encoding parameter to mne.io.read_raw_edf and mne.io.read_raw_bdf to support custom (non-UTF8) annotation channel encodings (11154 by `Clemens Brunner`_)
mne.preprocessing.ICA gained a new method, ~mne.preprocessing.ICA.get_explained_variance_ratio, that allows the retrieval of the proportion of variance explained by ICA components (11141 by `Richard Höchenberger`_)
Add on_baseline to mne.preprocessing.ICA.apply, mne.preprocessing.ICA.plot_overlay, and mne.viz.plot_ica_overlay to allow reapplying baseline correction after applying ICA (11232 by `Eric Larson`_)
Add config option MNE_REPR_HTML to disable HTML repr in notebook environments (11159 by `Clemens Brunner`_)
Fix bug in mne.io.Raw.crop where argument include_tmax was not considered in checking tmax in bounds (11196 by `Lukas Gemein`_)
Fix bug in mne.io.read_raw_eeglab where unlabeled fiducials caused reading errors (11074 by Sebastiaan Mathot)
Fix bug in mne.time_frequency.read_csd that returned projs as a list of dict instead of mne.Projection (11072 by Chetan Gohil)
Fix bug in mne.decoding.TimeFrequency that prevented cloning if constructor arguments were modified (11004 by Daniel Carlström Schad)
Fix bug in repr of decoding estimator classes (e.g., mne.decoding.SlidingEstimator) where the parameters where not stored in the result string but instead just printed to sys.stdout (11190 by Dominik Wetzel)
Document height and weight keys of subject_info entry in mne.Info (11019 by Sena Er)
Fix bug in mne.viz.Brain constructor where the first argument was named subject_id instead of subject (11049 by `Eric Larson`_)
Fix bug in mne coreg where the MEG helmet position was not updated during ICP fitting (11084 by `Eric Larson`_)
Fix bug in ~mne.io.read_raw_curry, and ~mne.io.read_raw_cnt where digitization points were not read properly (11145 by `Eric Larson`_)
Fix bug in mne.minimum_norm.apply_inverse_epochs where the average EEG projector was not checked properly (11182 by `Eric Larson`_)
Fix bug in mne.viz.plot_filter when plotting filters created using output='ba' mode with compensation turned on. (11040 by `Marian Dovgialo`_)
Fix bugs in documentation of surface ~mne.SourceSpaces (11171 by `Eric Larson`_)
Fix bug in mne.viz.plot_compare_evokeds where automatic legend labels could be excessively long; they are now abbreviated with ... when necessary (11181 by `Eric Larson`_)
Fix bugs with verbose='error' not being used properly and allowing warnings through (11193 by `Eric Larson`_)
Fix bug in mne.io.read_raw_bti where EEG, EMG, and H/VEOG channels were not detected properly, and many non-ECG channels were called ECG. The logic has been improved, and any channels of unknown type are now labeled as misc (11102 by `Eric Larson`_)
Fix bug in mne.viz.plot_topomap when providing sphere="eeglab" (11081 by `Mathieu Scheltienne`_)
Fix bug in mne.Dipole.to_mri where MRI RAS rather than MRI surface RAS was returned (11185 by `Eric Larson`_)
Fix bug in epochs.save where the verbose parameter defaulted to True instead of None (11191 by `Eric Larson`_)
The string and HTML representation of mne.preprocessing.ICA reported incorrect values for the explained variance. This information has been removed from the representations, and should instead be retrieved via the new ~mne.preprocessing.ICA.get_explained_variance_ratio method (11141 by `Richard Höchenberger`_)
Fix bug in mne.Evoked.plot and related methods where a np.nan location value in any channel causes spatial colours to fail (6870 by `Simeon Wong`_)
Fix bug in mne.preprocessing.ICA.find_bads_muscle where epochs caused an error when passed as the inst (11197 by `Alex Rockhill`_)
Fix bug in readers where EEG coordinates were assumed to be in head coordinates but no fiducial points were present. Estimated fiducial locations will now be added automatically to reflect the assumption of locations being in the head coordinate frame (11212 by `Stefan Appelhoff`_ and `Eric Larson`_)
The duration of raw data sometimes wasn't displayed correctly in Jupyter notebooks by omitting fractions of a second. We now always round up to the next full second so a duration of less than 1 second will not be displayed as a duration of zero anymore (11203 by `Richard Höchenberger`_)
Fix bug in mne.Report.add_ica and where baselines were not reapplied to the data when inst is Epochs or Evoked (11232 by `Eric Larson`_)
In mne.Evoked.plot, the default value of the spatial_colors parameter has been changed to 'auto', which will use spatial colors if channel locations are available (11201 by Hüseyin Orkun Elmas and `Daniel McCloy`_)
Starting with this release we now follow the Python convention of using FutureWarning instead of DeprecationWarning to signal user-facing changes to our API (11120 by `Daniel McCloy`_)
The names parameter of mne.viz.plot_arrowmap and mne.viz.plot_regression_weights has been deprecated; sensor names will be automatically drawn from the info_from or model parameter (respectively), and can be hidden, shown, or altered via the show_names parameter (11123 by `Daniel McCloy`_)
The bands parameter of mne.Epochs.plot_psd_topomap now accepts dict input; legacy tuple input is supported, but discouraged for new code (11050 by `Daniel McCloy`_)
The mne.head_to_mri new function parameter kind default will change from 'ras' to 'mri' (11185 by `Eric Larson`_)
The show_toolbar argument to mne.viz.Brain is being removed by deprecation (11049 by `Eric Larson`_)
New classes ~mne.time_frequency.Spectrum and ~mne.time_frequency.EpochsSpectrum, created via new methods Raw.compute_psd(), Epochs.compute_psd(), and Evoked.compute_psd() (10184 by `Daniel McCloy`_)
Functions/methods for plotting topomaps now have more consistent signatures; most have gained parameters for finer control of the topomap image and/or colorbar. See docstrings for details (11123 by `Daniel McCloy`_)
In mne.viz.plot_topomap, passing axes=None will now create a new ~matplotlib.figure.Figure instead of plotting into the current axes (11123 by `Daniel McCloy`_)
In mne.viz.plot_topomap, the parameter show_names has been deprecated, use the names parameter instead (11123 by `Daniel McCloy`_)
In mne.viz.plot_topomap, ~mne.viz.plot_tfr_topomap, ~mne.viz.plot_evoked_topomap, and related class methods mne.Covariance.plot_topomap, mne.Evoked.plot_topomap, and mne.time_frequency.AverageTFR.plot_topomap: the parameters vmin and vmax are deprecated in favor of vlim, for consistency with other plot_topomap functions and methods (11123 by `Daniel McCloy`_)
In mne.viz.plot_tfr_topomap, ~mne.viz.plot_evoked_topomap, and related class methods mne.Covariance.plot_topomap, mne.Evoked.plot_topomap, and mne.time_frequency.AverageTFR.plot_topomap: the title parameter has been deprecated; use matplotlib's fig.suptitle() instead (11123 by `Daniel McCloy`_)
In functions/methods for plotting topomaps, the outlines='skirt' option is deprecated; use sphere='eeglab' for similar functionality (11123 by `Daniel McCloy`_)
The mne.epochs.add_channels_epochs function has been deprecated in favor of epochs.add_channels (11180 by `Eric Larson`_)
The PSD functions that operate on Raw/Epochs/Evoked instances (mne.time_frequency.psd_welch and mne.time_frequency.psd_multitaper) are deprecated; for equivalent functionality create ~mne.time_frequency.Spectrum or ~mne.time_frequency.EpochsSpectrum objects instead and then run spectrum.get_data(return_freqs=True) (10184 by `Daniel McCloy`_)
Added new class mne.preprocessing.EOGRegression to allow more flexibility when using regression to reduce EOG artifacts (11046 by `Marijn van Vliet`_)
New parameter exclude added to mne.preprocessing.regress_artifact to prevent regression from being applied to certain channels (11046 by `Marijn van Vliet`_)
Alex Rockhill
Alexandre Gramfort
Andrew Quinn+
Chetan Gohil+
Christian Brodbeck
Clemens Brunner
Daniel Carlström Schad+
Daniel McCloy
Dominik Wetzel+
Eduard Ort
Eric Larson
Hüseyin Orkun Elmas+
Jack Zhang
Joan Massich
Julius Welzel+
Kostiantyn Maksymenko
Lukas Gemein
Marian Dovgialo
Marijn van Vliet
Mathieu Scheltienne
Mats van Es+
Moritz Gerster+
Olaf Hauk
Richard Höchenberger
Sebastiaan Mathot+
Sena Er+
Simeon Wong
Stefan Appelhoff
Valerii Chirkov
luzpaz+
Nothing published for this version
…accept list of file names or nibabel images. One breaking change is that now the flash files are looked for as mef05_*.mgz and mef30_*.mgz in mri/flas…
Added new built-in montage R-Net 128 Ch (Brain Products) (10974 by Ilias Machairas)
~mne.channels.DigMontage objects can now be checked for equality via == (10942 by Tziona NessAiver)
Add a note to clarify the inclusion of average referencing gain matrix during whitening (10922 by Mingjian He)
Add time axis scale bar for mne.Epochs.plot using matplotlib backend (10736 by Jordan Drew)
Add mne.bem.distance_to_bem to find depth of source positions (10632 by Matt Courtemanche)
Add support for ahdr files in mne.io.read_raw_brainvision (10515 by Alessandro Tonin)
Add support for reading data from Gowerlabs devices to mne.io.read_raw_snirf (10555 by Samuel Powell and `Robert Luke`_)
Add built-in sensor layout files for Geodesic Head Web 130 and 280 devices (10627 by `Evan Hathaway`_)
Add mne-icalabel to mne.sys_info (10615 by `Adam Li`_)
Add support for overview_mode in raw.plot() and related functions/methods (10501 by `Eric Larson`_)
Add mne.io.Raw.crop_by_annotations method to get chunks of Raw data based on mne.Annotations. (10460 by `Alex Gramfort`_)
The pick_channels method gained a verbose parameter, allowing e.g. to suppress messages about removed projectors (10544 by `Richard Höchenberger`_)
Add mne.viz.plot_projs_joint for joint plotting of projectors and Evoked (10720 by `Eric Larson`_)
The mne.make_forward_dipole function can now take a list of dipoles to make a multi-dipole forward models (10464 by `Marijn van Vliet`_)
Add mode='outlines' support to mne.Dipole.plot_locations and mne.viz.plot_dipole_locations (10699 by `Eric Larson`_)
Add mne.preprocessing.ICA.find_bads_muscle to find muscle-related ICA components with an example, ex-muscle-ica (10534 by `Alex Rockhill`_)
Add example of Xfit-style ECD modeling using multiple dipoles (10464 by `Marijn van Vliet`_)
Add head_source argument to mne.make_field_map to allow selecting which head source to use (10568 by `Eric Larson`_)
Add support for n_jobs=None to support joblib:joblib.parallel_backend for more precise control over parallelization (10567 by `Eric Larson`_)
It is now possible to compute inverse solutions with restricted source orientations using discrete forward models (10464 by `Marijn van Vliet`_)
The new function mne.preprocessing.maxwell_filter_prepare_emptyroom simplifies the preconditioning of an empty-room recording for our Maxwell filtering operations (10533 by `Richard Höchenberger`_ and `Eric Larson`_)
Add keyboard shortcuts to toggle mne.preprocessing.ICA.plot_properties topomap channel types ('t') and power spectral density log-scale ('l') (10557 by `Alex Rockhill`_)
Add --mri, and --threshold options to mne make_scalp_surfaces to improve head surface mesh extraction (10591 by `Eric Larson`_)
Add mne.preprocessing.compute_bridged_electrodes to detect EEG electrodes with shared spatial sources due to a conductive medium connecting two or more electrodes, add ex-eeg-bridging for an example and mne.viz.plot_bridged_electrodes to help visualize (10571 by `Alex Rockhill`_)
Add 'nearest' as an option for the image_interp argument in mne.viz.plot_topomap to plot a topomap without interpolation using a Voronoi parcelation (10571 by `Alex Rockhill`_)
Add mne.preprocessing.interpolate_bridged_electrodes to use the spatially smeared signal to get a better interpolation rather than dropping those channels (10587 by `Alex Rockhill`_)
Add support for hemoglobin type fNIRS data to temporal derivative distribution repair (TDDR) mne.preprocessing.nirs.temporal_derivative_distribution_repair (10125 by `Johann Benerradi`_)
mne.viz.plot_evoked_topomap and mne.Evoked.plot_topomap now display the time range the map was averaged over if average was passed (10606 by `Richard Höchenberger`_)
mne.viz.plot_evoked_topomap and mne.Evoked.plot_topomap can now average the topographic maps across different time periods for each time point. To do this, pass a list of periods via the average parameter (10610 by `Richard Höchenberger`_)
mne.viz.plot_evoked and mne.Evoked.plot gained a new parameter, highlight, to visually highlight time periods of interest (10614 by `Richard Höchenberger`_)
Added fNIRS support to mne.Info.get_montage (10611 by `Robert Luke`_)
Add mne.viz.plot_ch_adjacency to visualize and manually edit the channel adjacency matrix (10633 by `Mikołaj Magnuski`_)
Add mne.viz.Brain.get_view to get the current camera parameters such that they can be passed to mne.viz.Brain.show_view (10661 by `Alex Rockhill`_)
Added support for Aurora version 2021.9.0.6 to mne.io.read_raw_nirx (10668 by `Robert Luke`_)
Added BrainVision format (.vhdr, .vmrk, .eeg) to mne.export.export_raw (10681 by `Stefan Appelhoff`_)
Added export method to mne.Evoked (10681 by `Stefan Appelhoff`_)
Add timeformat YYYY/MM/DD to mne.io.ctf.info._convert_time (10674 by `Simon Kern`_)
mne.Report.add_figure and mne.Report.add_image gained a new parameter, section, allowing to put multiple figures or images into the same "content block". Previously, the only way to group figures and images was by means of a slider, which sometimes made content hard to discover. The slider remains available as an alternative (10694 by `Richard Höchenberger`_)
All functions and methods that plot topographic maps for EEG (2D projections of the EEG sensor locations) now accept the parameter value sphere='eeglab' to lay out the sensors with respect to the head circle in a similar way to how EEGLAB does, i.e., T7/T8 and Fpz/Oz are placed directly on the circle for template montages (10572 by `Richard Höchenberger`_)
mne.channels.get_builtin_montages gained a new parameter, descriptions, which allows to retrieve the descriptions of the montages in addition to their names (10373 by `Richard Höchenberger`_)
Add include option to mne.io.read_raw_edf, mne.io.read_raw_bdf and mne.io.read_raw_gdf. (10734 by `Michiru Kaneda`_)
mne.gui.coregistration gained a new parameter, fullscreen, to start the GUI in fullscreen mode (10284 by `Richard Höchenberger`_)
The built-in FieldTrip channel adjacency matrices, which can be read via ~mne.channels.read_ch_adjacency, have been synchronized with FieldTrip again. This means that numerous new adjacencies have been added, most notably those for standard 10-05 and 10-20 montages (10749 by `Richard Höchenberger`_)
mne.Evoked.plot_field gained a new parameter, interaction, to control the rotation axes when interacting with the head (10788 by `Richard Höchenberger`_)
Add mne.read_evoked_besa for reading evokeds from BESA .avr and .mul files. (10892 by `Marijn van Vliet`_)
Add mne.time_frequency.EpochsTFR.decimate to reduce size of time-frequency epochs objects (10940 by `Alex Rockhill`_)
Add an alias that maps EGI reference channel names (VREF or Vertex Reference) to the electrode name in the standard EGI montages (Cz). Now setting standard EGI montages with ~mne.io.Raw.set_montage with match_alias=True will avoid raising an error (10823 by `Scott Huberty`_)
Add provenance in mne.time_frequency.EpochsTFR.apply_baseline (10979 by `Alex Rockhill`_)
Fix bug in mne.surface._project_onto_surface for the condition method != 'accurate' and return_nn (10930 by `Christian O'Reilly`_)
Fix bug in mne.export.export_raw to ignore None value in filenames attribute of mne.io.RawArray (10927 by Reza Nasri)
Fix bug in mne.io.read_raw_edf to allow reading in all Hypnodyne ZMax EDFs to be read in without issues (10754 by Frederik D. Weber)
Fix bug in mne.Epochs.drop_bad where data was loaded although no rejection had to be performed (10718 by Lukas Gemein)
Pick also bad channels when selecting T1T2 magnetometers in mne.preprocessing.maxwell_filter (10639 by Matti Toivonen)
Make color parameter check in in mne.viz.plot_evoked_topo consistent (10217 by T. Wang and `Stefan Appelhoff`_)
Fix bug in mne.io.read_raw_brainvision when BrainVision data are acquired with the Brain Products "V-Amp" amplifier and disabled lowpass filter is marked with value 0 (10517 by Alessandro Tonin)
Fix bug in mne.pick_types and related methods where csd=True was not passed handled properly (10470 by Matthias Dold)
Fix bug where plots produced using the 'qt' / mne_qt_browser backend could not be added using mne.Report.add_figure (10485 by `Eric Larson`_)
Fix bug where theme was not handled properly in mne.io.Raw.plot (10487, 10500 by `Mathieu Scheltienne`_ and `Eric Larson`_)
Fix bug in raw.crop(start, stop) that would cause annotations to be erroneously shifted when start != 0 and no measurement date was set. (10491 by `Eric Larson`_)
Fix bug in mne.io.read_raw_bti where unknown electrode locations were not handled properly (10662 by `Eric Larson`_)
Fix bug in mne.io.read_raw_ctf on Windows where large files could not be read (10866 by `Eric Larson`_)
Fix bug in mne.io.read_raw_ctf where invalid measurement dates were not handled properly (10957 by `Jean-Rémi King`_ and `Eric Larson`_)
Rendering issues with recent MESA releases can be avoided by setting the new environment variable MNE_3D_OPTION_MULTI_SAMPLES=1 or using mne.viz.set_3d_options (10513 by `Eric Larson`_)
Fix behavior for the pyvista 3D renderer's quiver3D function so that default arguments plot a glyph in arrow mode (10493 by `Alex Rockhill`_)
Retain epochs metadata when using mne.channels.combine_channels (10504 by `Clemens Brunner`_)
Fix epochs indexing with metadata containing boolean type and missing values (10705 by `Clemens Brunner`_ and `Alex Gramfort`_)
Fix reading of fiducial locations in mne.io.read_raw_eeglab (10521 by `Alex Gramfort`_)
Prevent creation of montage with invalid [x, y, z] coordinates with mne.channels.make_dig_montage (10547 by `Mathieu Scheltienne`_)
Fix bug in coregistration GUI that prevented it from starting up if only a high-resolution head model was available (10543 by `Richard Höchenberger`_)
Fix bug with mne.Epochs.add_reference_channels where attributes were not updated properly so subsequent ~mne.Epochs.pick_types calls were broken (10912 by `Eric Larson`_)
Fix bug in the mne.viz.Brain tool bar that prevented the buttons to call the corresponding feature (10560 by `Guillaume Favelier`_)
Fix issue with saving epochs once ~mne.preprocessing.compute_current_source_density has been used if a rejection threshold was used first (10619 by `Alex Rockhill`_ and `Richard Höchenberger`_)
Fix bug in mne.viz.plot_evoked_image that would cause incorrect sub-titles when using group_by (10618 by `Reza Shoorangiz`_)
Reduce memory usage when loading an EDF file with preload=False (10638 by `Clemens Brunner`_)
Fix bug in mne.io.Raw.get_channel_types and related methods where unique=True would return a python:set with arbitrary order rather than a python:list that preserves the same order as inst.ch_names (10720 by `Eric Larson`_)
In mne.preprocessing.find_bad_channels_maxwell, do not re-filter the data if a low-pass filter with the requested frequency has already been applied (10664 by `Richard Höchenberger`_)
Fix a problem in mne.Evoked.get_peak, where under certain circumstances the mode parameters 'pos' and 'neg' were not honored when tmin and/or tmax were passed as well (10686 by `Richard Höchenberger`_)
mne.read_evokeds, mne.channels.read_custom_montage, mne.channels.read_dig_hpts, mne.channels.read_dig_polhemus_isotrak, and mne.channels.read_polhemus_fastscan now correctly expand ~ in the provided path to the user's home directory (10685, 10688 by `Richard Höchenberger`_)
Fix bug in mne.io.read_raw_eeglab and mne.read_epochs_eeglab, where the presence of channels without position in the .set file caused positions incorrectly assigned to all further channels (8754 by `Mikołaj Magnuski`_)
Combining channels of mne.Epochs or mne.Evoked objects now properly retains baseline information (10703 by `Clemens Brunner`_)
In mne.Report, some figures would have an undesired border added to the edges; this has now been resolved (10730 by `Richard Höchenberger`_)
Fix selection of EEG channels and selected sphere when plotting bridged electrodes with mne.viz.plot_bridged_electrodes (10753 by `Mathieu Scheltienne`_)
Fix broken links in tut-fix-meshes (10765 by `Alex Rockhill`_)
The built-in FieldTrip channel adjacency matrix for easycapM1 had a bug, where the channel PO8 was incorrectly labeled as PO6 This has been resolved by updating the adjacency matrix to the latest version provided by FieldTrip (10749 by `Richard Höchenberger`_)
Add a YouTube video tutorial for editing FreeSurfer surfaces in Blender to tut-fix-meshes (10778 by `Alex Rockhill`_)
The default interaction style of mne.Evoked.plot_field has been changed such that if behaves like ~mne.viz.plot_alignment when trying to rotate the head (10788 by `Richard Höchenberger`_)
Add a video on how to operate the intracranial electrode contact location GUI in tut-ieeg-localize (10800 by `Alex Rockhill`_)
Add a video on how to operate the coregistration GUI in tut-source-alignment (10802 by `Alex Rockhill`_)
Add show and block arguments to mne.gui.coregistration and mne.gui.locate_ieeg to pop up the GUIs and halt execution of subsequent code respectively (10802 by `Alex Rockhill`_)
Correctly report the number of available projections when printing measurement info in a Jupyter notebook (10471 by `Clemens Brunner`_)
Fix value set in raw.orig_format for readers of BrainVision (ASCII format), EGI and Artemis123 files (10851 by `Mathieu Scheltienne`_)
When reading EGI MFF files, channel names are no longer ignored and reference channel information is properly incorporated (10898 by `Scott Huberty`_ and `Daniel McCloy`_)
Fix bug in mne.time_frequency.psd_array_welch and related functions/methods where the bias was not accounted for when average='median' (10990 by `Eric Larson`_)
Fix bug in mne.decoding.TemporalFilter where filter parameters were not handled properly (10968 by `Eric Larson`_)
Fix documentation bug in ica.plot_sources to specify that picks keyword argument is for picking ICA components to plot (10936 by `Adam Li`_)
Annotations contained in EDF files are correctly read as UTF-8 according to the EDF specification (10963 by `Clemens Brunner`_)
Fix bug where complex-valued topoplots caused an error, convert to amplitude instead (10978 by `Alex Rockhill`_)
When creating BEM surfaces via mne.bem.make_watershed_bem and mne.bem.make_flash_bem, the copy parameter now defaults to True. This means that instead of creating symbolic links inside the FreeSurfer subject's bem folder, we now create "actual" files. This should avoid troubles when sharing files across different operating systems and file systems (10531 by `Richard Höchenberger`_)
The ordering of channels returned by mne.io.read_raw_nirx is now ordered by channel name, rather than the order provided by the manufacturer. This enables consistent ordering of channels across different file types (10555 by `Robert Luke`_)
For mne.viz.plot_topomap, mne.viz.plot_evoked_topomap, mne.viz.plot_arrowmap, mne.viz.plot_ica_components, mne.Covariance.plot_topomap, mne.Evoked.plot_topomap, mne.Evoked.animate_topomap, mne.decoding.CSP.plot_patterns, mne.Projection.plot_topomap and mne.preprocessing.ICA.plot_components the topomap image interpolation was previously a cubic interpolation but now can be 'linear' and 'nearest' as well. Unless image_interp='nearest' is passed mne uses a subsequent matplotlib bilinear interpolation to make the interpolated image smoother. Previously, 'image_interp' controlled this second interpolation step and, for the first interpolation, the only option was cubic. To simplify, image_interp is now responsible for the main interpolation and the subsequent matplotlib image interpolation is bilinear but can be changed afterward using im.set_interpolation (10617 by `Alex Rockhill`_)
The FLASH BEM surface generation via mne.bem.make_flash_bem or the mne flash_bem command has now been clarified in terms of expected inputs. In mne.bem.convert_flash_mris the convert parameter is now deprecated and the flash5 and flash30 now accept list of file names or nibabel images. One breaking change is that now the flash files are looked for as mef05_*.mgz and mef30_*.mgz in mri/flash folder (10715 by `Alex Gramfort`_)
~mne.viz.plot_compare_evokeds gets a new parameter time_unit which can be "s" or "ms" (10950 by `Daniel McCloy`_)
The to_data_frame methods for Raw, Epochs, Evoked, SourceEstimate, EpochsTFR, and AverageTFR all now have default time_format=None (keep time in seconds) instead of time_format='ms' (convert time to milliseconds) (10925 by `Daniel McCloy`_)
mne.Evoked.decimate now aligns to the sample at time=0 (so that the exact sample when the event occurred is preserved) to be consistent with mne.Epochs.decimate (10945 by `Alex Rockhill`_)
Adam Li
Adeline Fecker+
Alessandro Tonin+
Alex Ciok+
Alex Rockhill
Alexandre Gramfort
Archit Singhal+
Ashley Drew+
Ben Beasley+
Carina Forster+
Christian O'Reilly
Clemens Brunner
Cora Kim
Daniel McCloy
Dominik Welke
Dominique Makowski
Eric Larson
Evan Hathaway
Frederik D. Weber+
Guillaume Favelier
Hamid Maymandi+
Ilias Machairas+
Jean-Rémi King
Johann Benerradi
Jon Houck
Jona Sassenhagen
Jordan Drew+
Lukas Gemein+
Marijn van Vliet
Martin Schulz
Mathieu Scheltienne
Matt Courtemanche+
Matthias Dold+
Matti Toivonen+
Michiru Kaneda+
Mikołaj Magnuski
Mingjian He+
Naveen Srinivasan+
Phillip Alday
Reza Nasri+
Reza Shoorangiz
Richard Höchenberger
Rob Luke
Scott Huberty+
Simon Kern
Sondre Foslien+
Stefan Appelhoff
Wang+
Tziona NessAiver+
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.0.2...v1.0.3
Full Changelog: https://github.com/mne-tools/mne-python/compare/v1.0.2...v1.0.3
Nothing published for this version
Nothing published for this version
mne.Info.pick_channels has been deprecated. Use inst.pick_channels to pick channels from ~mne.io.Raw, ~mne.Epochs, and ~mne.Evoked. Use mne.pick_info…
Add use_orig_time option to mne.Annotations.crop. (10396 by Michiru Kaneda)
Speed up mne.preprocessing.annotate_muscle_zscore, mne.preprocessing.annotate_movement, and mne.preprocessing.annotate_nan through better annotation creation (10089 by Senwen Deng)
Fix some unused variables in time_frequency_erds.py example (10076 by Jan Zerfowski)
Document BAD_ACQ_SKIP annotation behavior (10054 by Etienne de Montalivet)
Add link to related MNE-ARI package (10174 by John Veillette)
mne.time_frequency.psd_array_multitaper can now return complex results per-taper when specifying output='complex' (10307 by `Mikołaj Magnuski`_)
mne.time_frequency.tfr_array_multitaper can now return results for output='phase' instead of an error (10281 by `Mikołaj Magnuski`_)
Add show local maxima toggling button to mne.gui.locate_ieeg (9952 by `Alex Rockhill`_)
Show boundaries in mne.gui.locate_ieeg (10379 by `Eric Larson`_)
Add argument cval to mne.transforms.apply_volume_registration to set interpolation values outside the image domain (10379 by `Eric Larson`_)
Improve docstring of mne.Info and add attributes that were not covered (9922 by `Mathieu Scheltienne`_)
Add an alternate, manual procedure for aligning a CT to an MR procedure to tut-ieeg-localize (9978 by `Alex Rockhill`_)
Improve docstring of export functions mne.export.export_raw, mne.export.export_epochs, mne.export.export_evokeds, mne.export.export_evokeds_mff and issue a warning when there are unapplied projectors (9994 by `Mathieu Scheltienne`_)
Add support for reading haemoglobin fNIRS data to mne.io.read_raw_snirf (9929 by `Robert Luke`_)
Add fill_hole_size keyword argument to mne.viz.Brain.add_volume_labels to close holes in the mesh (10024 by `Alex Rockhill`_)
Changed mne.Epochs and mne.Evoked to have a more concise __repr__ to improve interactive MNE usage in Python Interactive Console, IDEs, and debuggers when many events are handled. (10042 by `Jan Sosulski`_)
Improve docstring of events arguments and cross-referencing to events (10056 by `Mathieu Scheltienne`_)
Speed up repeated surface-smoothing operation (e.g., in repeated calls to stc.plot()) (10077 by `Eric Larson`_)
Add verbose parameter to mne.io.Raw.load_bad_channels and log information on how bad channels are updated (10102 by `Stefan Appelhoff`_)
Add infer_type argument to mne.io.read_raw_edf and mne.io.read_raw_bdf to automatically infer channel types from channel labels (10058 by `Clemens Brunner`_)
Reduce the time it takes to generate a mne.io.Raw, ~mne.Epochs, or ~mne.preprocessing.ICA figure if a scalings parameter is provided (10109 by `Richard Höchenberger`_ and `Eric Larson`_)
mne.Report.add_raw gained a new scalings parameter to provide custom data scalings for the butterfly plots (10109 by `Richard Höchenberger`_)
The butterfly parameter of mne.Report.add_raw now also accepts numbers to specify how many segments to plot (10115 by `Richard Höchenberger`_)
The psd parameter of mne.Report.add_epochs now also accepts numbers to specify the signal duration used for PSD calculation (10119 by `Richard Höchenberger`_)
Drastically speed up butterfly plot generation in mne.Report.add_raw. We now don't plot annotations anymore; however, we feel that the speed improvements justify this change, also considering the annotations were of limited use in the displayed one-second time slices anyway (10114, 10116 by `Richard Höchenberger`_)
In mne.Report, limit the width of automatically generated figures to a maximum of 850 pixels (450 pixels for mne.SourceEstimate plots), and the resolution to 100 DPI to reduce file size, memory consumption, and – in some cases like mne.Report.add_stc – processing time (10126, 10129, 10135, 10142 by `Richard Höchenberger`_)
~mne.Epochs metadata tables are now included in mne.Report (10166 by `Richard Höchenberger`_)
mne.get_head_surf and mne.dig_mri_distances gained a new parameter, on_defects, controlling how to handle surfaces with topological defects (10175 by `Richard Höchenberger`_)
mne.Report.add_epochs gained a new parameter, drop_log_ignore, to control which drop reasons to omit when creating the drop log plot (10182 by `Richard Höchenberger`_)
mne.Epochs.plot_drop_log now also includes the absolute number of epochs dropped in the title (10186 by `Richard Höchenberger`_)
Add a button to show the maximum intensity projection in mne.gui.locate_ieeg (10185 by `Alex Rockhill`_)
Annotations from a ~mne.io.Raw object are now preserved by the ~mne.Epochs constructor and are supported when saving Epochs (9969 and 10019 by `Adam Li`_)
Add a checkbox to show and hide the MEG helmet in the coregistration GUI (10200 by `Guillaume Favelier`_)
The coregistration GUI (instantiated via mne.gui.coregistration) gained a new attribute, coreg, to access the mne.coreg.Coregistration instance used by the GUI (10255 by `Richard Höchenberger`_)
Add marching cubes display of head if mne.bem.make_scalp_surfaces has not computed or the recon-all hasn't finished (10202 by `Alex Rockhill`_)
The default interaction style of mne.gui.coregistration and mne.viz.plot_alignment has been changed to 'terrain', which keeps one axis fixed and should make interactions with the 3D scene more predictable (9972, 10206 by `Richard Höchenberger`_)
mne.gui.coregistration now uses the proper widget style for push buttons, making for a more native feel of the application (10220 by `Richard Höchenberger`_ and `Guillaume Favelier`_)
mne.coreg.Coregistration, mne.scale_bem, and mne.scale_mri gained a new parameter, on_defects, controlling how to handle topological defects (10230, 10249 by `Richard Höchenberger`_)
mne.coreg.Coregistration gained a new attribute, fiducials, allowing for convenient retrieval of the MRI fiducial points (10243, by `Richard Höchenberger`_)
Added plotting points to represent contacts on the max intensity projection plot for mne.gui.locate_ieeg (10212 by `Alex Rockhill`_)
Add lines in 3D and on the maximum intensity projection when more than two electrode contacts are selected to aid in identifying that contact for mne.gui.locate_ieeg (10212 by `Alex Rockhill`_)
Add a block parameter to mne.viz.Brain and the UI of mne.coreg.Coregistration to prevent the windows from closing immediately when running in a non-interactive Python session (10222 by `Guillaume Favelier`_)
All methods of mne.Report with a tags parameter now also accept a single tag passed as a string (previously, you needed to pass a tuple of strings, even for a single tag) (10183, by `Richard Höchenberger`_)
mne.Report.add_trans has gained a new parameter, alpha, to control the level of opacity of the rendered head (10247, by `Richard Höchenberger`_)
The new convenience function mne.event.match_event_names allows for straightforward checking if a specific event name or a group of events is present in a collection of event names (10233 by `Richard Höchenberger`_)
Epochs.plot is now supported by the pyqtgraph-backend (10297 by `Martin Schulz`_)
The map_surface parameter of mne.viz.Brain.add_foci now works and allows you to add foci to a rendering of a brain that are positioned at the vertex of the mesh closest to the given coordinates (10299 by `Marijn van Vliet`_)
mne.preprocessing.ICA.plot_sources() is now also supported by the qt backend (10330 by `Martin Schulz`_)
Added mne.viz.Brain.add_dipole and mne.viz.Brain.add_forward to plot dipoles on a brain as well as mne.viz.Brain.remove_dipole and mne.viz.Brain.remove_forward (10373 by `Alex Rockhill`_)
Made anterior/posterior slice scrolling in mne.gui.locate_ieeg possible for users without page up and page down buttons by allowing angle bracket buttons to be used (10384 by `Alex Rockhill`_)
Add support for theme='auto' for automatic dark-mode support in raw.plot() and related functions and methods when using the 'qt' backend (10417 by `Eric Larson`_)
Add support for MNE_3D_OPTION_THEME and MNE_BROWSER_THEME to use ['light', 'dark', 'auto'] or a custom theme path in mne.viz.Brain and raw.plot() (and related functions and methods when using the 'qt' backend(), respectively (10418 by `Eric Larson`_)
Add support for passing time-frequency data to mne.stats.spatio_temporal_cluster_test and mne.stats.spatio_temporal_cluster_1samp_test and added an example to tut-cluster-spatiotemporal-sensor (10384 by `Alex Rockhill`_)
Add support for reading optical density fNIRS data to mne.io.read_raw_snirf (10408 by `Robert Luke`_)
Added mne.source_space.get_decimated_surfaces to extract subsurfaces from a SourceSpaces instance or a .fif file (10421 by `Joshua Teves`_)
Fix bug with mne.io.read_raw_nihon where latin-1 channels could not be read (10429 by Matthias Eberlein)
Fix bug with mne.io.read_raw_nihon so that it handles duplicates in channel names (10431 by Matthias Eberlein)
Fix bug in mne.io.read_raw_egi where the meas_date in a rawMFF object was incorrectly assigned. The function now converts the meas_date to UTC and provides a UTC offset key, i.e. raw.info['utc_offset']. (10304 by Scott Huberty)
Fix datetime conversion for tmin/tmax=None cases in mne.Annotations.crop. Allow the use of float and None simultaneously for mne.Annotations.crop. (10361 by Michiru Kaneda)
Add Shift_JIST mu in mne.io.read_raw_edf (10356 by Michiru Kaneda)
Teach mne.io.read_raw_bti to use its eog_ch parameter (10093 by Adina Wagner)
Fix use of arguments in numpy.loadtxt (10189 by Federico Zamberlan)
Fix documentation of options in mne.stc_near_sensors (10007 by Nikolai Chapochnikov)
mne.time_frequency.tfr_array_multitaper now returns results per taper when output='complex' (10281 by `Mikołaj Magnuski`_)
Fix default of mne.io.Raw.plot to be use_opengl=None, which will act like False unless MNE_BROWSER_USE_OPENGL=true is set in the user configuration (9957 by `Eric Larson`_)
Fix bug with mne.Report where figures were saved with bbox_inches='tight', which led to inconsistent sizes in sliders (9966 by `Eric Larson`_)
When opening a saved report and saving it to a different filename again, don't change Report.fname to avoid a regression when using ~mne.open_report as a context manager (9998 by `Marijn van Vliet`_)
Fix bug in mne.make_forward_solution where sensor-sphere geometry check was incorrect (9968 by `Eric Larson`_)
Use single char alphanumeric suffix when renaming long channel names (over 15-characters) when writing to FIF format. (10002 by `Luke Bloy`_)
Add argument overwrite to mne.export.export_raw, mne.export.export_epochs, mne.export.export_evokeds and mne.export.export_evokeds_mff (9975 by `Mathieu Scheltienne`_)
mne.gui.coregistration and the mne coreg command didn't respect the interaction parameter (9972 by `Richard Höchenberger`_)
Fix incorrect projection of source space onto white matter surface instead of pial in tut-working-with-ecog (9980 by `Alex Rockhill`_)
Fix channel type support when reading from EEGLAB .set format with mne.io.read_raw_eeglab and mne.read_epochs_eeglab (9990 by `Mathieu Scheltienne`_)
Fix suboptimal alignment using mne.transforms.compute_volume_registration (9991 by `Alex Rockhill`_)
Only warn if header is missing in BrainVision files instead of raising an error (10001 by `Clemens Brunner`_)
Add argument overwrite to mne.preprocessing.ICA.save to check for existing file (10004 by `Mathieu Scheltienne`_)
mne.Report now raises an exception if invalid tags were passed (9970 by `Richard Höchenberger`_)
Fix bug in mne.get_montage_volume_labels that set the maximum number of voxels to be included too low causing unwanted capping of the included voxel labels (10021 by `Alex Rockhill`_)
Fix annotation cropping and I/O roundtrip when there is no measurement date available (10040 by `Mathieu Scheltienne`_ and `Alex Gramfort`_).
Fix bug where raw.crop() from the beginning of the instance could break annotations and raw.first_samp (10358 by `Eric Larson`_)
~mne.sys_info output now contains the installed version of pooch, too; this output had been accidentally removed previously (10047 by `Richard Höchenberger`_)
Fix VTK version extraction in mne.sys_info (10399 by `Eric Larson`_)
Fix automatic channel type detection from channel labels in mne.io.read_raw_edf and mne.io.read_raw_bdf (and disable this functionality from mne.io.read_raw_gdf) (10058 by `Clemens Brunner`_)
Fix ~mne.stats.permutation_cluster_1samp_test to properly handle 2-dimensional data in combination with TFCE (10073 by `Richard Höchenberger`_)
Fix channel grouping error when using "butterfly mode" with mne.io.Raw.plot (10087 by `Daniel McCloy`_)
Fix inconsistent behavior of mne.preprocessing.annotate_* functions by making them all return mne.Annotations objects with the orig_time attribute set to raw.info["meas_time"] (10067 and 10118 by `Stefan Appelhoff`_, `Eric Larson`_, and `Alex Gramfort`_)
Fix bug that appears during automatic calculation of the colormap of mne.viz.Brain when data values of fmin and fmax are too close (10074 by `Guillaume Favelier`_)
We now display a scrollbar in the tags dropdown of a ~mne.Report if many tags have been added, granting access to all tags instead of "hiding" them below the bottom of the page (10082 by `Richard Höchenberger`_)
Creating mne.Epochs now provides clearer logging (less ambiguous, no duplicates) when the preload and/or metadata parameters are set (10112 by `Stefan Appelhoff`_)
Fix bug with mne.Epochs where save-load round-trip with FIF would cause mne.Epochs.apply_baseline to no longer work (10177 by `Eric Larson`_)
Fix functions by adding missing overwrite parameters: mne.write_events, mne.write_cov, mne.write_evokeds, mne.SourceEstimate.save, mne.minimum_norm.write_inverse_operator, mne.write_proj, and related methods (10127 by `Eric Larson`_)
Fix bug with mne.transforms.compute_volume_registration and mne.compute_source_morph (volumetric) where the smoothing factors were not scaled based on zooms (10132 by `Eric Larson`_)
Remove repeated logging output when overwriting an existing ~mne.io.Raw file (10095 by `Richard Höchenberger`_ and `Stefan Appelhoff`_)
In the plots generated by mne.Report.add_stc, we now only add 5 labels to the color bar to reduce the chance of overlap, which could previously cause the labels to become unreadable (10135 by `Richard Höchenberger`_)
mne.Report.add_trans now allows you to add sensor alignment plots for head surfaces that have topological defects (10175 by `Richard Höchenberger`_)
mne.Report.add_trans now also works if no digitization points are present in the data (10176 by `Jeff Stout`_)
Argument verbose is now respected by dataset fetching (10210 by `Mathieu Scheltienne`_)
Fix bug with mne.io.read_raw_hitachi where empty Comment descriptions were not handled properly (10235 by `Eric Larson`_)
Fix bug with input validation of low-level filtering functions (10267 by `Eric Larson`_)
mne.gui.coregistration now works with surfaces containing topological defects (10230, by `Richard Höchenberger`_)
Fix bug with mne.io.read_raw_nirx being unable to read measurement dates recorded on systems with German (de_DE), French (fr_FR), and Italian (it_IT) locales (10277 by `Eric Larson`_)
Fix bug with projector normalization checks that were too sensitive, and improve warning (10292 by `Eric Larson`_)
Fix bug with mne.viz.plot_alignment where head-coordinate source spaces (e.g., from a forward solution) were not properly plotted (10309 by `Eric Larson`_)
mne.read_trans and mne.io.read_fiducials now correctly expand ~ in the provided path (i.e., to the user's home directory) (10265, 10415, by `Richard Höchenberger`_)
mne.find_events now uses first_samp and not 0 for initial event when using initial_value (10289, by `Alex Gramfort`_)
Fix bug with mne.channels.make_standard_montage for 'standard*', 'mgh*', and 'artinis*' montages where the points were incorrectly scaled and fiducials incorrectly set away from the correct values for use with the fsaverage subject (10324 by `Eric Larson`_)
Fix bug with mne.Report.add_figure where figures generated externally were closed and possibly resized during render (10342 by `Eric Larson`_)
Fix bug with mne.viz.plot_sparse_source_estimates where the return value was incorrect (10347 by `Eric Larson`_)
Fix plotting bug in ex-electrode-pos-2d and make view look more natural in ex-movement-detect (10313, by `Alex Rockhill`_)
Fix bug with blank 3D rendering with MESA software rendering (10400 by `Eric Larson`_)
Fix a bug in mne.gui.locate_ieeg where 2D lines on slice plots failed to update and were shown when not in maximum projection mode (10335, by `Alex Rockhill`_)
Fix misleading color scale in tut-cluster-tfr for the plotting of cluster F-statistics (10393 by `Alex Rockhill`_)
Fix baseline removal using remove_dc=True in raw.plot() for data containing np.nan (10392 by `Clemens Brunner`_)
Fix misleading color scale in tut-timefreq-twoway-anova for plotting F-stats (10401 by `Alex Rockhill`_)
Fix misleading T_obs return name for mne.stats.spatio_temporal_cluster_test when the default returns an F-statistic (10401 by `Alex Rockhill`_)
The default browser for raw.plot(), epochs.plot(), and ica.plot_sources() has been changed to the 'qt' backend on systems where mne_qt_browser is installed. To change back to matplotlib within a session, you can use mne.viz.set_browser_backend('matplotlib'). To set it permanently on your system, you can use mne.set_config('MNE_BROWSER_BACKEND', 'matplotlib') (9960 by `Martin Schulz`_ and `Eric Larson`_)
mne.Info.pick_channels has been deprecated. Use inst.pick_channels to pick channels from ~mne.io.Raw, ~mne.Epochs, and ~mne.Evoked. Use mne.pick_info to pick channels from mne.Info (10039 by `Mathieu Scheltienne`_)
All data_path functions now return python:pathlib.Path objects rather than strings. Support for string concatenation with plus (+) is thus deprecated and will be removed in 1.2, use the forward-slash / operator instead (10348 by `Eric Larson`_)
Argument event_list has been deprecated in favor of events in mne.write_events (10056 by `Mathieu Scheltienne`_)
mne.preprocessing.annotate_flat has been deprecated in favor of mne.preprocessing.annotate_amplitude, that covers both minimum and maximum peak-to-peak variation. (10143 by `Mathieu Scheltienne`_)
The max_ori_out parameter of mne.beamformer.apply_lcmv and related functions is being removed as only signed estimates are supported. abs(stc) can be used to obtain unsigned estimates (10366 by `Eric Larson`_)
The verbose attribute of classes (e.g., mne.io.Raw, mne.Epochs, etc.) has been deprecated. Explicitly pass verbose to methods as necessary instead. (10267 by `Eric Larson`_)
In mne.viz.set_browser_backend, the mne-qt-browser-based backend is now called 'qt' rather than 'pyqtgraph' for simplicity (10323 by `Eric Larson`_)
Numerous external dependencies that used to be bundled with MNE-Python are now not shipped with the package anymore and will instead be retrieved automatically from their official sources when you install MNE-Python. This simplifies MNE-Python maintenance and keeps the package smaller. The following new dependencies have been added:
Jinja2 (replaces Tempita, which is not maintained anymore; 10211 by `Richard Höchenberger`_)
Adam Li
Adina Wagner+
Alex Rockhill
Alexandre Gramfort
Britta Westner
Clemens Brunner
Daniel McCloy
Eduard Ort
Eric Larson
Etienne de Montalivet+
Federico Zamberlan+
Guillaume Favelier
Jan Sosulski
Jan Zerfowski+
Jeff Stout
John Veillette+
Joshua Teves
Julia Guiomar Niso Galán
Luke Bloy
Marijn van Vliet
Martin Schulz
Mathieu Scheltienne
Matthias Eberlein+
Michiru Kaneda+
Mikołaj Magnuski
Nikolai Chapochnikov+
Richard Höchenberger
Robert Luke
Scott Huberty+
Senwen Deng+
Stefan Appelhoff
Steve Matindi
Thomas Hartmann
Nothing published for this version
The Mayavi 3D backend has been deprecated (9904 by Eric Larson_):
Add pooch to system information reports (9801 by Joshua Teves)
Get annotation descriptions from the name field of SNIRF stimulus groups when reading SNIRF files via mne.io.read_raw_snirf (9575 by Darin Erat Sleiter)
Add support for NIRSport and NIRSport2 devices to mne.io.read_raw_nirx (9348 and 9401 by David Julien, new contributor `Romain Derollepot`_, `Robert Luke`_, and `Eric Larson`_)
New function mne.Dipole.to_volume_labels to get atlas label for MRI coordinates. (9376 by new contributor `Marian Dovgialo`_)
Add support for SURE parameter selection in mne.inverse_sparse.mixed_norm and make alpha parameter now default to 'sure' (9430 by new contributor `Pierre-Antoine Bannier`_ and `Alex Gramfort`_)
Speed up BCD solver in mne.inverse_sparse.mixed_norm by adding Anderson acceleration (9481 by new contributor `Pierre-Antoine Bannier`_ and `Alex Gramfort`_)
Add support for list of channel types for EEG/sEEG/ECoG/DBS referencing (9637 by Mathieu Scheltienne)
Add the ability to set point size and line width in mne.viz.plot_sensors and related functions (:gH:`9872` by Dominique Makowski)
Add support for changing the default event id used by mne.make_fixed_length_epochs (9782 by Mathieu Scheltienne)
Improve documentation for arguments threshold, method and measure of ICA methods ~mne.preprocessing.ICA.find_bads_ecg, ~mne.preprocessing.ICA.find_bads_ref and ~mne.preprocessing.ICA.find_bads_eog (9858 by Mathieu Scheltienne)
Add support for more than 3 source estimates in mne.viz.plot_sparse_source_estimates (9640 by Pierre-Antoine Bannier and `Alex Gramfort`_)
Add cortical signal suppression (CSS) mne.preprocessing.cortical_signal_suppression (6888, 9892 by John Samuelsson and `Eric Larson`_)
Show all good channel types and counts when printing a mne.Info in the notebook (9725 by `Valerii Chirkov`_ and `Eric Larson`_)
Speed up point decimation in mne.io.read_raw_kit by vectorization and use of scipy.spatial.cKDTree (9568 by `Jean-Rémi King`_ and `Eric Larson`_)
Add ability to export EDF+ files using mne.export.export_raw (9643 by `Adam Li`_)
New function mne.chpi.get_chpi_info to retrieve basic information about the cHPI system used when recording MEG data (9369 by `Richard Höchenberger`_)
New namespace mne.export created to contain functions (such as mne.export.export_raw and mne.export.export_epochs) for exporting data to non-FIF formats (9427 by `Eric Larson`_)
Add support for Hitachi fNIRS devices in mne.io.read_raw_hitachi (9391 by `Eric Larson`_)
Add support for picks in mne.stc_near_sensors (9396 by `Eric Larson`_)
Add label methods mne.Label.compute_area and mne.Label.distances_to_outside (9424 by `Eric Larson`_)
Add projections when printing a mne.Info in the notebook (9403 by `Alex Gramfort`_)
Add new function mne.bem.make_scalp_surfaces to compute scalp surfaces for coregistration (9463 by `Alex Gramfort`_)
Add support for interpolating oxy and deoxyhaemoglobin data types (9431 by `Robert Luke`_)
Add support for SNIRF files in mne.Report (9443 by `Robert Luke`_)
Add support for exporting MFF evoked files using mne.export.export_evokeds and mne.export.export_evokeds_mff (9406 by `Evan Hathaway`_)
mne.concatenate_raws, mne.concatenate_epochs, and mne.write_evokeds gained a new parameter on_mismatch, which controls behavior in case not all of the supplied instances share the same device-to-head transformation (9438 by `Richard Höchenberger`_)
Add support for multiple datablocks (acquisitions with pauses) in mne.io.read_raw_nihon (9437 by `Federico Raimondo`_)
Add new function mne.preprocessing.annotate_break to automatically detect and mark "break" periods without any marked experimental events in the continuous data (9445 by `Richard Höchenberger`_)
Add "time_format" to mne.io.Raw.plot and mne.preprocessing.ICA.plot_sources to display acquisition time on x-axis (9419 by `Martin Schulz`_)
Speed up mne.decoding.TimeDelayingRidge.predict by switching to FFT-based convolution (9458 by `Ross Maddox`_)
Show multiple colors and linestyles for excluded components with mne.Evoked in mne.preprocessing.ICA.plot_sources (9444 by `Martin Schulz`_)
Add functions for aligning MRI and CT data mne.transforms.compute_volume_registration and mne.transforms.apply_volume_registration (9503 by `Alex Rockhill`_ and `Eric Larson`_)
Add tutorial for how to processes image (CT and MR) files in order to localize electrode contacts for intracranial recordings tut-ieeg-localize (9484 by `Alex Rockhill`_)
Add vertex number in source space for mne.VolSourceEstimate.plot and mne.viz.plot_volume_source_estimates (9697 by `Eric Larson`_)
Add support for colormap normalization in mne.viz.plot_topomap (9468 by `Clemens Brunner`_)
Update mne.preprocessing.realign_raw with Numpy-recommended polynomial fitting method (9514 by `Erica Peterson`_)
Add a warning to mne.preprocessing.nirs.beer_lambert_law when source-detector distances are zero (9541 by `Eric Larson`_)
Add exclude parameter to mne.io.Raw.plot_psd and mne.Epochs.plot_psd (9519 by `Clemens Brunner`_)
Add mne.Annotations.rename to rename annotation descriptions (9525 by `Robert Luke`_)
Add mne.Annotations.set_durations to set annotation durations (9529 by `Robert Luke`_)
The exclude parameter in mne.io.read_raw_edf, mne.io.read_raw_bdf, and mne.io.read_raw_gdf now also accepts a regular expression (9558 by `Clemens Brunner`_)
Add mne.Evoked.get_data method to mne.Evoked (9555 by `Stefan Appelhoff`_)
The mne.Epochs.get_data method now has a units parameter (9553 by `Stefan Appelhoff`_)
Add mne.warp_montage_volume to use an anatomical volume with channel locations at high or low insensities to apply a symmetric diffeomorphic registration to a template (e.g. fsaverage) space (9544 by `Alex Rockhill`_)
mne.io.Raw.get_data, mne.Epochs.get_data, and mne.Evoked.get_data methods now have tmin and tmax parameters to specify data window in seconds to get (9556 by `Stefan Appelhoff`_)
The mne.Evoked.get_data method now has a units parameter (9578 by `Stefan Appelhoff`_)
Add mne.chpi.compute_chpi_snr and mne.viz.plot_chpi_snr for computing and plotting the time-varying SNR of continuously-active HPI coils (9570 by `Daniel McCloy`_ and `Jussi Nurminen`_)
Add mne.get_montage_volume_labels to find the regions of interest in a FreeSurfer atlas anatomical segmentation for an intracranial electrode montage and mne.viz.plot_channel_labels_circle to plot them (9545 by `Alex Rockhill`_)
Add mne.viz.Brain.add_volume_labels to plot subcortical surfaces and other regions of interest (9540 by `Alex Rockhill`_ and `Eric Larson`_)
Add custom cortex curvature colors in mne.viz.Brain via the cortex argument (9750 by `Eric Larson`_)
Add mne.channels.DigMontage.apply_trans to apply a transform directly to a montage (9601 by `Alex Rockhill`_)
mne.preprocessing.ICA.fit now emits a warning if any of the start, stop, reject, and flat parameters are passed when performing ICA on ~mne.Epochs. These parameters only have an effect on ~mne.io.Raw data and were previously silently ignored in the case of ~mne.Epochs (9605 by `Richard Höchenberger`_)
mne.viz.plot_alignment now emits a warning (instead of aborting with an exception) if the surfaces contain topological defects (9614 by `Richard Höchenberger`_)
The coregistration GUI can now display the head surface even if there are topological defects. Previously, a low-resolution standard head unsuitable for individualized coregistration was displayed (9614 by `Richard Höchenberger`_)
New mne.coreg.Coregistration object to allow coregistration scripting without a dependency on mayavi (9516 by `Guillaume Favelier`_).
Add mne.viz.Brain.add_head to plot the head surface (9618 by `Alex Rockhill`_)
Add mne.channels.read_dig_localite to read Localite electrode location files (9658 by `Clemens Brunner`_)
Add mne.viz.Brain.add_sensors to plot sensor locations (9585 by `Alex Rockhill`_)
Add mne.coreg.estimate_head_mri_t to estimate the head->mri transform from fsaverage fiducials (9585 by `Alex Rockhill`_)
Add mne.channels.DigMontage.add_mni_fiducials to add fiducials to a montage in MNI coordinates (9682 by `Alex Rockhill`_)
Add mne.channels.DigMontage.remove_fiducials to remove fiducials under rare circumstances when the coordinate frame should not be set to "head" (9684 by `Alex Rockhill`_)
Add remove methods for mesh objects in mne.viz.Brain (9688 by `Alex Rockhill`_)
Add --show-paths and --developer options to mne sys_info (9789 by `Eric Larson`_)
Add ability to export EDF+ files using mne.export.export_raw (9643 by `Adam Li`_)
Reading EDF files via mne.io.read_raw_edf now can infer channel type from the signal label in the EDF header (9694 by `Adam Li`_)
Add mne.gui.locate_ieeg to locate intracranial electrode contacts from a CT, an MRI (with FreeSurfer recon-all) and the channel names from an mne.Info object (9586 by `Alex Rockhill`_)
All data fetching code now relies on pooch, which is an added optional requirement for dataset fetchers (9742 by `Adam Li`_ and `Daniel McCloy`_)
Add phantom FreeSurfer subject fetcher mne.datasets.fetch_phantom to allow fetching the Otaniemi phantom (9796 by `Eric Larson`_)
Add mne.datasets.fetch_dataset to allow packages to fetch datasets in a similar fashion to MNE (9763 by `Adam Li`_)
Add full ECoG dataset to MNE-misc-data and demonstrate its use in ex-electrode-pos-2d and tut-ieeg-localize (9784 by `Alex Rockhill`_)
Add options tol and accuracy to mne.fit_dipole to control optimization (9810 by `Eric Larson`_)
Completely revamp the ~mne.Report experience: new HTML layout, many new methods, more flexibility; the functionality is demonstrated in tut-report (9754, 9828, 9847, 9860, 9861, 9862, 9863, 9871, 9881, 9891, 9901 by `Richard Höchenberger`_, `Eric Larson`_, and `Alex Gramfort`_)
Add basic HTML representations of ~mne.Forward and ~mne.minimum_norm.InverseOperator instances for a nicer Jupyter experience (9754 by `Richard Höchenberger`_)
mne.io.read_raw_brainvision now handles ASCII data with comma-separated values, as may be exported from BrainVision Analyzer (9795 by `Richard Höchenberger`_)
Add mne.preprocessing.ieeg.project_sensors_onto_brain to project ECoG sensors onto the pial surface to compensate for brain shift (9800 by `Alex Rockhill`_)
Add support for data acquired with NIRx devices using Aurora software version 2021.9 (9800 by `Robert Luke`_, and `Eric Larson`_)
All functions for reading and writing files should now automatically handle ~ (the tilde character) and expand it to the user's home directory. Should you come across any function that doesn't do it, please do let us know! (9613, 9845 by `Richard Höchenberger`_)
All functions accepting a FreeSurfer subjects directory via a subjects_dir parameter can now consume pathlib.Path objects too (used to be only strings) (9613 by `Richard Höchenberger`_)
Add support for colormap normalization in mne.time_frequency.AverageTFR.plot (9851 by `Clemens Brunner`_)
Add support for BIDS-compatible filenames when splitting big epochs files via the new split_naming parameter in mne.Epochs.save (9869 by `Denis Engemann`_)
Add by_event_type parameter to mne.Epochs.average to create a list containing an mne.Evoked object for each event type (9859 by `Marijn van Vliet`_)
Add pyqtgraph as a new backend for mne.io.Raw.plot (9687 by `Martin Schulz`_)
Add mne.viz.set_browser_backend, mne.viz.use_browser_backend and mne.viz.get_browser_backend to set matplotlib or pyqtgraph as backend for mne.io.Raw.plot (9687 by `Martin Schulz`_)
Fix bug in mne.io.Raw.pick and related functions when parameter list contains channels which are not in info instance (9708 by Evgeny Goldstein)
Fix a few typos (9706 by Timothy Gates)
Fix bug with mne.Epochs.crop and mne.Evoked.crop when include_tmax=False, where the last sample was always cut off, even when tmax > epo.times[-1] (9378 by Jan Sosulski)
Fix bug with mne.io.read_raw_curry to allow reading Curry 7 and 8 event files with '.ceo' and '.cdt.ceo' extensions (9381, 9712 by new contributor `Xiaokai Xia`_, `Daniel McCloy`_, and by Reza Shoorangiz)
Fix bug with mne.compute_rank, mne.cov.compute_whitener and mne.preprocessing.ICA.fit when explicit picks including bad channels are provided (9719 by Mathieu Scheltienne)
Fix bug with mne.concatenate_epochs where the concatenated events could end up in non-chronological order. (9765 by Jan Sosulski)
Fix bug where mne.time_frequency.psd_array_welch and mne.time_frequency.psd_array_multitaper failed to handle negative integer for n_jobs argument (9849 by Riessarius Stargardsky)
Fix bug where resampling returns empty instances (9897 by Mathieu Scheltienne and `Eric Larson`_)
Fix bug with mne.io.Raw.get_montage now returning both good and bad channels in the montage. (9920 by Mathieu Scheltienne)
Fix bug with mne.io.read_raw_nihon where latin-1 annotations could not be read (9384 by `Alex Gramfort`_)
Fix bug when printing a mne.io.RawArray in the notebook (9404 by `Alex Gramfort`_)
Fix bug when computing rank from info for SSS data with only gradiometers or magnetometers (9435 by `Alex Gramfort`_)
Fix bug with mne.preprocessing.find_bad_channels_maxwell where all-flat segments could lead to an error (9531 by `Eric Larson`_)
Fix bug with mne.io.Raw.set_montage and related functions where the channel coordinate frame was not properly set to head (9447 by `Eric Larson`_)
Fix bug with mne.io.read_raw_fieldtrip and mne.read_epochs_fieldtrip where channel positions were not set properly (9447 by `Eric Larson`_)
Fix bug with mne.io.read_raw_kit where omitting HPI coils could lead to an python:AssertionError on reading (9612 by `Eric Larson`_)
Fix bug with mne.io.read_raw_edf where reading only stimulus channels would lead to an error (9831 by `Eric Larson`_)
Fix bug with mne.preprocessing.nirs.optical_density where protection against zero values was not guaranteed (9522 by `Eric Larson`_)
mne.concatenate_raws now raises an exception if raw.info['dev_head_t'] differs between files. This behavior can be controlled using the new on_mismatch parameter (9438 by `Richard Höchenberger`_)
Fixed bug in mne.Epochs.drop_bad where subsequent rejections failed if they only specified thresholds for a subset of the channel types used in a previous rejection (9485 by `Richard Höchenberger`_).
Fix bug with mne.simulation.simulate_evoked, mne.apply_forward, and mne.apply_forward_raw where systems with EEG channels that come before MEG channels would have them mixed up in the output evoked or raw object (#9513 by `Eric Larson`_)
In mne.viz.plot_ica_scores and mne.preprocessing.ICA.plot_scores, the figure and axis titles no longer overlap when plotting only a single EOG or ECG channel (9489 by `Richard Höchenberger`_).
Ensure mne.io.Raw.get_montage works with SNIRF data (9524 by `Robert Luke`_)
Fix bug in mne.setup_volume_source_space where non-finite positions could be used in a discrete source space (9603 by `Eric Larson`_)
Fix bug in mne.viz.plot_topomap (and related methods like mne.Evoked.plot_topomap) where large distances between electrodes (higher than head radius) would lead to an error (9528 by `Mikołaj Magnuski`_).
Fix bug in mne.viz.plot_topomap (and related methods) where passing axes that are part of a matplotlib figure that uses a constrained layout would emit warnings (9558 by `Eric Larson`_)
Fix bug in mne.make_forward_solution where impossible sensor-BEM geometries were not checked (9893 by `Eric Larson`_)
Fix bug in mne.concatenate_epochs when concatenating mne.Epochs objects with 0 events (9535 by `Marijn van Vliet`_)
Fix bug in mne.viz.Brain.screenshot where the RGBA mode was not supported (9564 by `Guillaume Favelier`_).
Fix bug in mne.io.read_raw_egi where reading data from a data segment that is part of an acquisition skip would lead to an error (9565 by `Eric Larson`_)
Prevent mne.io.Raw.plot windows from spawning at sizes too small to properly render (9629 by `Daniel McCloy`_)
Fix bug where mne.io.Raw.plot raised an error when plotting raw dipole data (9771 by `Eric Larson`_)
Fix bug in mne.preprocessing.ICA.find_bads_ecg where passing start and stop lead to erroneous data windows depending on the combination of Raw, Epochs, Evoked, and the type (int, float, None) of start and stop (9556 by `Stefan Appelhoff`_)
Fix bug in mne.viz.set_3d_backend and mne.viz.get_3d_backend where the PyVistaQt-based backend was ambiguously named 'pyvista' instead of 'pyvistaqt'; use set_3d_backend('pyvistaqt') and expect 'pyvistaqt' as the output of mne.viz.get_3d_backend instead of 'pyvista', and consider using get_3d_backend().startswith('pyvista') for example for backward-compatible conditionals (9607 by `Guillaume Favelier`_)
Fix bug in mne.viz.plot_compare_evokeds where confidence bands were not drawn if only one condition was plotted (9663 by `Daniel McCloy`_)
Fix bug where setting of a montage with fNIRS data got set to "unknown" coordinate frame when it should have been in "head" (9630 by `Alex Rockhill`_)
Fix bug where "seeg", "ecog", "dbs" and "fnirs" data had coordinate frame unknown upon loading from a file when it should have been in "head" (9580 by `Alex Rockhill`_)
Raise error when no trans is provided to mne.viz.plot_alignment when required instead of assuming identity head->mri transform (9585 by `Alex Rockhill`_)
Fix bug where mne.Epochs.equalize_event_counts failed when only one good epoch existed for one of the event types (9758 by `Daniel McCloy`_)
Fix bug where channels with a dollar sign ($) were not being labeled "misc" in mne.io.read_raw_nihon (9695 by `Adam Li`_)
Fix bug where mne.io.read_raw_persyst was lower-casing events it found in the .lay file (9746 by `Adam Li`_)
Fix bug with Qhull when plotting OPM sensors in mne.viz.plot_alignment (9799 and 9804 by `Eric Larson`_)
Fix bug where mne.io.read_raw_snirf was including the landmark index as a spatial coordinate (9777 by `Robert luke`_)
Fix bug where mne.Annotations were not appending channel names when being added together (9780 by `Adam Li`_)
mne.viz.plot_evoked_joint now correctly handles a times='peaks' parameter value (9754 by `Richard Höchenberger`_)
In mne.viz.plot_compare_evokeds, slightly adjust the x-axis limit calculation to avoid drawing an axis that is too short (9754 by `Richard Höchenberger`_)
Fix a bug with mne.viz.snapshot_brain_montage with the Mayavi backend where electrodes were shown in the wrong positions, and with the PyVista backend where the snapshot always contained the electrodes but could be missing a hemisphere (9933 by `Eric Larson`_)
In mne.io.Raw.plot_psd and mne.Epochs.plot_psd, avoid overlap between subplot titles and x-axis tick labels (9864 by `Richard Höchenberger`_)
In mne.Epochs.plot_psd_topomap, the data is now scaled to match the output of mne.Epochs.plot_psd (9873 by `Richard Höchenberger`_)
Fix channel locations with NaN values causing all channel locations not to be plotted in mne.viz.Brain.add_sensors (9911 by `Alex Rockhill`_)
Fix infinite loop bug in mne.get_montage_volume_labels (9940 by `Alex Rockhill`_)
The mne.Info class is now more strictly checked when attributes are set. Setting most attributes directly will lead to an error in the next release. See the docstring of mne.Info for more information (9867 by Mathieu Scheltienne)
The Mayavi 3D backend has been deprecated (9904 by `Eric Larson`_):
In 3D plotting functions, use PyVista-based backends ('pyvistaqt' and 'notebook') as PySurfer/Mayavi will be removed in the next version
To use the mne kit2fiff command-line GUI for fiducial markers, install the separate mne-kit-gui module, which can still be launched via $ mne kit2fiff
The mne.gui.fiducials GUI has been deprecated, use mne coreg or mne_kit_gui.fiducials() to set MRI fiducials instead
In mne.compute_source_morph, the niter_affine and niter_sdr parameters have been replaced by niter and pipeline parameters for more consistent and finer-grained control of registration/warping steps and iteration (9505 by `Alex Rockhill`_ and `Eric Larson`_)
Split mne.viz.Brain.show_view argument view into azimuth, elevation and focalpoint for clearer view setting and make the default for row and col apply to all rows and columns (9596 by `Alex Rockhill`_)
Deprecate solver='prox' in mne.inverse_sparse.mixed_norm in favor of solver='cd' and solver='bcd' as coordinate descent solvers consistently outperform proximal gradient descent (9608 by `Pierre-Antoine Bannier`_)
All mne.connectivity functions have moved to the mne-connectivity package; they are deprecated in MNE-Python and will be removed in version 0.25 (9493 by `Adam Li`_).
mne.inverse_sparse.mixed_norm now simply warns when source estimates contain no dipole, e.g. if data are too noisy and alpha is based on SURE (9685 by `Alex Gramfort`_)
Deprecate functions mne.datasets.{DATASET_NAME}.has_{DATASET_NAME}_data() for these datasets: epilepsy_ecog, fnirs_motor, multimodal, opm, phantom_4dbti, refmeg_noise, sample, somato, and ssvep. Use the generic mne.datasets.has_dataset instead (9781 by `Daniel McCloy`_ and `Adam Li`_)
mne.Report modernization has led to multiple deprecations (9754 by `Richard Höchenberger`_):
mne.Report.add_figs_to_section and mne.Report.add_slider_to_section have been deprecated in favor of mne.Report.add_figure
mne.Report.add_images_to_section has been deprecated in favor of mne.Report.add_image
mne.Report.add_bem_to_section has been deprecated in favor of mne.Report.add_bem
mne.Report.add_htmls_to_section has been deprecated in favor of mne.Report.add_html
In mne.Report.parse_folder, the sort_sections parameter has been deprecated in favor of sort_content
In mne.Report.remove, the caption and section parameters have been deprecated in favor of title and tags, respectively
The mne.Report.sections attribute has been deprecated in favor of mne.Report.tags
The mne.Report.fnames attribute has been deprecated without replacement
mne.Epochs.plot and mne.viz.plot_epochs gained parameter show_scalebars analogous to mne.viz.plot_raw (9815 by `Daniel McCloy`_)
The output folder name for HF_SEF datasets is now hf_sef instead of HF_SEF (9763 by `Adam Li`_)
Deprecate mne.viz.utils.center_cmap (9851 by `Clemens Brunner`_)
The default partial pathlength factor of mne.preprocessing.nirs.beer_lambert_law will change from 0.1 in 0.24 to 6.0 in the next release (9843 by `Robert Luke`_)
mne.preprocessing.ICA.detect_artifacts has been deprecated. Please use ~mne.preprocessing.ICA.find_bads_eog and ~mne.preprocessing.ICA.find_bads_ecg instead (9909 by `Richard Höchenberger`_)
People who contributed to this release in alphabetical order (people with a + are first time contributors):
Adam Li
Alex Rockhill
Alexandre Gramfort
Britta Westner
Clemens Brunner
Daniel McCloy
Darin Erat Sleiter+
David Julien+
Denis A. Engemann
Dominique Makowski+
Eric Larson
Erica Peterson
Evan Hathaway
Evgeny Goldstein+
Fede Raimondo
Gansheng Tan+
Guillaume Favelier
Hubert Banville
Jan Sosulski+
Jean-Rémi King
Jeff Stout
Johann Benerradi
John Samuelsson+
Josh Koen+
Joshua Teves+
Lukas Hecker+
Luke Bloy
Marian Dovgialo+
Marijn van Vliet
Martin Schulz
Mathieu Scheltienne+
Mikołaj Magnuski
Pierre-Antoine Bannier+
Reza Shoorangiz+
Richard Höchenberger
Riessarius Stargardsky+
Robert Luke
Romain Derollepot+
Ross Maddox
Ryan Law+
Stefan Appelhoff
Steve Matindi+
Timothy Gates+
Valerii Chirkov
Xiaokai Xia+
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
mne.read_selection has been deprecated in favor of mne.read_vectorview_selection. mne.read_selection will be removed in MNE-Python 0.24 (8870 by Richa…
Add support for exporting to EEGLAB's set format with eeglabio with new methods mne.io.Raw.export and mne.Epochs.export. (9192 by Jack Zhang)
mne.viz.plot_evoked_topo now uses a Minimum/Maximum of peaks for each channel type to calculate ylim when input param is None (9285 by Ram Pari)
Add exclude parameter to mne.viz.plot_evoked_topo (9278 by Ram Pari)
Add mne.time_frequency.EpochsTFR.to_data_frame and mne.time_frequency.AverageTFR.to_data_frame methods (9124 by Felix Klotzsche)
Add selection and drop_log to mne.time_frequency.EpochsTFR (9124 by Felix Klotzsche)
Add CSV, TSV, and XYZ support to mne.channels.read_custom_montage (9203 by Jack Zhang)
Add HTML representation for ~mne.Epochs in Jupyter Notebooks (9174 by Valerii Chirkov)
Speed up mne.viz.plot_ica_properties by refactoring (9174 by Valerii Chirkov)
Add apply_function method to epochs and evoked objects (9088 by Erica Peterson and `Victoria Peterson`_)
New tutorial for function mne.make_fixed_length_epochs (9156 by Erica Peterson)
Add different colors for each volume source space in mne.viz.plot_alignment (9043 by Valerii Chirkov)
Add overlap parameter to mne.make_fixed_length_epochs to allow creating overlapping fixed length epochs (9096 by Silvia Cotroneo)
Add mne.Dipole.to_mni for more convenient dipole.pos to MNI conversion (9043 by Valerii Chirkov)
Update citations in maxwell.py (9043 by Valerii Chirkov)
New Tutorial for analyzing frequency-tagging data (8867 by Dominik Welke and `Evgenii Kalenkovich`_)
Add dbs as new channel type for deep brain stimulation (DBS) recordings (8739 by Richard M. Köhler)
Add some preprocessing functions to the EEGLAB migration guide (9169 by Apoorva Karekal)
Add mne.chpi.extract_chpi_locs_kit to read cHPI coil locations from KIT/Yokogawa data (8813 by Matt Sanderson, `Robert Seymour`_, and `Eric Larson`_)
Add match_alias parameter to mne.io.Raw.set_montage and related functions to match unrecognized channel location names to known aliases (8799 by Zhi Zhang)
Update the notebook 3d backend to use ipyvtk_simple for a better integration within Jupyter (8503 by `Guillaume Favelier`_)
Remove the 15-character limitation for channel names when writing to FIF format. If you need the old 15-character names, you can use something like raw.rename_channels({n: n[:13] for n in raw.ch_names}, allow_duplicates=True), by `Eric Larson`_ (8346)
Add channel-specific annotation support to mne.Annotations via ch_names parameter (8896 by `Eric Larson`_)
Add toggle-all button to mne.Report HTML and width argument to mne.Report.add_bem_to_section (8723 by `Eric Larson`_)
Add infant template MRI dataset downloader mne.datasets.fetch_infant_template (8738 by `Eric Larson`_ and `Christian O'Reilly`_)
Add digitizer information to mne.io.read_raw_egi (8789 by `Christian Brodbeck`_)
Add support for reading some incomplete raw FIF files in mne.io.read_raw_fif (9268 by `Eric Larson`_)
Allow reading digitization from files other than *.fif in the coregistration GUI (8790 by `Christian Brodbeck`_)
Speed up mne.inverse_sparse.tf_mixed_norm using STFT/ISTFT linearity (8697 by `Eric Larson`_)
Reduce memory consumption of mne.io.Raw and speed up epoching when thousands of events are present for mne.Epochs (8801 by `Eric Larson`_)
Speed up import mne by reducing function creation overhead (8829 by `Eric Larson`_)
mne.Report.parse_folder now processes supported non-FIFF files by default, too (8744 by `Richard Höchenberger`_)
mne.Report has gained the new methods ~mne.Report.add_custom_js and ~mne.Report.add_custom_css for adding user-defined JavaScript and styles (8762, 9037 by `Richard Höchenberger`_)
Add option to control appearance of opaque inside surface of the head to mne coreg (8793 by `Eric Larson`_)
Add option to disable projection using --projoff in mne browse_raw (9262 by `Eric Larson`_)
Add keypress to toggle projection using shift+j in mne.io.Raw.plot and mne browse_raw (9262 by `Eric Larson`_)
Add support for non-FIF files in mne browse_raw using mne.io.read_raw (8806 by `Eric Larson`_)
Add mne.io.read_raw_nedf for reading StarStim / enobio NEDF files (8734 by `Tristan Stenner`_)
Add raw.describe() to display (or return) descriptive statistics for each channel (8760 by `Clemens Brunner`_)
Add annotations.to_data_frame() to return annotations as a pandas dataframe (8783 by `Robert Luke`_)
Add mne.preprocessing.compute_maxwell_basis to compute the SSS basis function (8822 by `Eric Larson`_)
Add the silhouette parameter to mne.viz.Brain to display sharp edges and improve perception (8771 by `Guillaume Favelier`_)
Add warning to mne.cov.compute_whitener when an explicit rank parameter leads to a large increase in condition number (8805 by `Eric Larson`_)
Add parameter align=True to mne.viz.Brain.show_view to make views relative to the closest canonical (MNI) axes rather than the native MRI surface RAS coordinates (8794 by `Eric Larson`_)
Add auto_close to mne.Report.add_figs_to_section and mne.Report.add_slider_to_section to manage closing figures (8730 by `Guillaume Favelier`_)
Add mne.write_head_bem to support writing head surface files (8841 by `Yu-Han Luo`_)
The signal of resp (respiratory) channels is now assumed to be in the unit Volt (8858 by `Richard Höchenberger`_)
Static type checkers like Pylance (comes with VS Code) now display the parameters of many more functions correctly, largely improving overall usability for VS Code users (8862 by `Richard Höchenberger`_)
Support new EEGLAB file format (8874 by `Clemens Brunner`_)
Reading and writing FIFF files whose filenames end with _meg.fif.gz, _eeg.fif(.gz), and _ieeg.fif(.gz) doesn't emit a warning anymore; this improves interobaility with BIDS-formatted datasets (8868 by `Richard Höchenberger`_)
On macOS, we now set the environment variable QT_MAC_WANTS_LAYER to "1" if it hasn't been set explicitly by the user, in order to ensure that ~mne.SourceEstimate plots work on macOS 11 with older versions of Qt and PyQt (8959 by `Richard Höchenberger`_)
mne.time_frequency.EpochsTFR.average now allows different ways of averaging, such as "median", or callable functions (8879 by `Adam Li`_)
~mne.Epochs metadata can now be generated automatically from events using mne.epochs.make_metadata (8834 by `Richard Höchenberger`_)
Interactions with sliders in mne.Report will now continuously update the linked content (it was updated only on mouse button release before) (9023 by `Richard Höchenberger`_)
mne.viz.plot_drop_log and mne.Epochs.plot_drop_log now omit displaying the subject name in the title if subject=None is passed (9015 by `Richard Höchenberger`_)
Plot ECoG tutorial now uses a real epilepsy seizure dataset and visualizes the seizure onset (9087 by `Eric Larson`_, `Adam Li`_, `Alex Rockhill`_ and `Liberty Hamilton`_)
Improve documentation of Report-Class (9113 by `Martin Schulz`_)
Add mne.channels.DigMontage.add_estimated_fiducials which will add LPA, RPA and Nasion fiducial points to the DigMontage object in mri coordinate frame (9118 by `Adam Li`_)
mne.io.anonymize_info now anonymizes also sex and hand fields when keep_his is False (9103, 9175 by Rotem Falach and `Richard Höchenberger`_)
Add parameter theme to mne.viz.Brain for optional Dark-Mode (9149 by `Martin Schulz`_, `Guillaume Favelier`_)
Add first_samp support for raw simulations with mne.simulation.simulate_raw and mne.simulation.SourceSimulator (9166 by `Steven Bierer`_)
~mne.Evoked gained a baseline attribute that is automatically assembled based on the baseline of the averaged ~mne.Epochs (9210 by `Richard Höchenberger`_)
Add units parameter to mne.io.Raw.get_data to return data in the desired unit (9136 by `Johann Benerradi`_ and `Stefan Appelhoff`_)
Add mne.preprocessing.equalize_bads to interpolate bad channels in a list of ~mne.Evoked, ~mne.Epochs or ~mne.io.Raw having different sets of bad channels (9241 by `Alex Gramfort`_)
mne.Epochs.equalize_event_counts can now be called without providing a list of event names, and will equalize the counts of all event types present in the ~mne.Epochs (9261 by `Richard Höchenberger`_)
mne.preprocessing.find_eog_events and mne.preprocessing.create_eog_epochs now accept a list of channel names, allowing you to specify multiple EOG channels at once (9269 by `Richard Höchenberger`_)
Improve performance of mne.set_bipolar_reference (9270 by `Martin Schulz`_)
Add support for setting montages on fNIRS data, with built in standard montages for Artinis OctaMon and Artinis Brite23 devices (9141 by `Johann Benerradi`_, `Robert Luke`_ and `Eric Larson`_)
Enable support for reading SNIRF files with 2D optode positions (9347 `Robert Luke`_)
Fix bug with mne.time_frequency.tfr where plot misbehaved. Plot now always returns a list of figures instead of a single figure handle (8013 by Eduard Ort)
Fix bug with mne.viz.plot_evoked_topo where set ylim parameters gets swapped across channel types. (9207 by Ram Pari)
Fix bug with mne.io.read_raw_edf where µV was not correctly recognized (9187 by Sumalyo Datta)
Fix bug with mne.viz.plot_compare_evokeds did not check type of combine. (9151 by Matteo Anelli)
Fix bug with mne.viz.plot_evoked_topo where ylim was only being applied to the first channel in the dataset (9162 by Ram Pari )
Fix bug with mne.Epochs.plot_image allowing interactive zoom to work properly (9152 by Maggie Clarke and `Daniel McCloy`_)
Fix bug with mne.Epochs.plot_image where the x_label was different depending on the evoked parameter (9115 by Matteo Anelli)
Fix bug with restricting mne.io.Raw.save saving options to .fif and .fif.gz extensions (9062 by Valerii Chirkov)
Fix bug with mne.io.read_raw_kit where missing marker coils were not handled (8989 by Judy D Zhu)
Fix bug with mne.connectivity.spectral_connectivity where time axis in Epochs data object was dropped. (8839 by Anna Padee)
Fix bug with mne.io.Raw.resample to allow passing stim_picks='misc' (8844 by Enrico Varano and `Eric Larson`_)
Fix bugs with mne.io.read_raw_persyst where multiple Comments with the same name are allowed, and Comments with a "," character are now allowed (8311 and 8806 by Andres Rodriguez and `Adam Li`_)
Fix zen mode and scalebar toggling for raw.plot() when using the macosx matplotlib backend (8688 by `Daniel McCloy`_)
Fix bug with mne.viz.snapshot_brain_montage where the positions were incorrect (8983 by `Eric Larson`_)
Fix bug with mne.preprocessing.maxwell_filter where the eSSS basis had to exactly match the good channels instead of being a superset (8675 by `Eric Larson`_)
Fix bug with mne.Report.add_bem_to_section where n_jobs != 1 would cause n_jobs subsets of MRI images in some orientations to be flipped (8713 by `Eric Larson`_)
Fix bug with raw.plot() where annotations didn't immediately appear when changing window duration (8689 by `Daniel McCloy`_)
Fix bug with raw.plot() where scalings='auto' did not compute scalings using the full range of data (8806 by `Eric Larson`_)
Fix bug with raw.plot() where setting a lowpass could lead to non-data-channels not plotting (8954 by `Eric Larson`_)
Fix bug with mne.io.Raw.load_data and mne.Epochs.drop_bad where verbose logging was not handled properly (8884 by `Eric Larson`_)
Fix bug with mne.io.read_raw_nicolet where header type values such as num_sample and duration_in_sec where not parsed properly (8712 by `Alex Gramfort`_)
Fix bug with mne.preprocessing.read_ica_eeglab when reading decompositions using PCA dimensionality reduction (8780 by `Alex Gramfort`_ and `Eric Larson`_)
Fix bug with mne.minimum_norm.make_inverse_operator where depth was errantly restricted to be less than or equal to 1. (8804 by `Eric Larson`_)
Fix bug with mne.stats.permutation_cluster_1samp_test and related clustering functions when adjacency=None and out_type='indices' (#8842 by `Eric Larson`_)
Fix bug with mne.viz.plot_alignment where plotting a sphere model could ignore the brain argument (8857 by `Eric Larson`_)
Fix bug with mne.SourceEstimate.plot where flatmaps were not positioned properly when using hemi='both' (9315 by `Eric Larson`_)
Fix bug with mne.Annotations.save where files could be overwritten accidentally, it can now be controlled via the overwrite argument (8896 by `Eric Larson`_)
Fix bug with replace argument of mne.Report.add_bem_to_section and mne.Report.add_slider_to_section (8723 by `Eric Larson`_)
Fix bug with mne.chpi.compute_chpi_locs where all cHPI coils being off would lead to an empty array of the wrong dimensionality (8956 by `Eric Larson`_)
Fix bug with mne.extract_label_time_course where labels, STCs, and the source space were not checked for compatible subject attributes (9284 by `Eric Larson`_)
Fix bug with mne.grow_labels where overlap=False could run forever or raise an error (9317 by `Eric Larson`_)
Fix compatibility bugs with mne_realtime (8845 by `Eric Larson`_)
Fix bug with mne.viz.Brain where non-inflated surfaces had an X-offset imposed by default (8794 by `Eric Larson`_)
Fix bug with mne coreg where nasion values were not updated when clicking (8793 by `Eric Larson`_)
Fix bug with matplotlib-based 3D plotting where Axes3D were not properly initialized in mne.viz.plot_source_estimates (8811 by `Chris Bailey`_)
Allow sEEG channel types in mne.Evoked.plot_joint (8736 by `Daniel McCloy`_)
Fix bug where hidden annotations could be deleted interactively in mne.io.Raw.plot windows (8831 by `Daniel McCloy`_)
Function mne.set_bipolar_reference was not working when passing Epochs constructed with some picks (8728 by `Alex Gramfort`_)
Fix anonymization issue of FIF files after IO round trip (8731 by `Alex Gramfort`_)
Fix bug in mne.preprocessing.ICA.plot_sources where right-clicking component names could yield ~mne.preprocessing.ICA.plot_properties windows for the wrong component if picks had been specified (8996 by `Daniel McCloy`_)
Fix title not shown in mne.viz.plot_montage (8752 by `Clemens Brunner`_)
mne.io.read_raw_egi now correctly handles pathlib.Path filenames (8759 by `Richard Höchenberger`_)
mne.viz.plot_evoked and mne.Evoked.plot now correctly plot global field power (GFP) for EEG data when gfp=True or gfp='only' is passed (used to plot RMS). For MEG data, we continue to plot the RMS, but now label it correctly as such (8775 by `Richard Höchenberger`_)
Fix bug with mne make_scalp_surfaces where --overwrite was not functional (8800 by `Yu-Han Luo`_)
Fix bug with mne.viz.plot_topomap when plotting gradiometers with a missing channel in a pair (8817 by `Alex Gramfort`_)
epochs.crop() now also adjusts the reject_tmin and reject_tmax attributes if necessary (8821 by `Richard Höchenberger`_)
When creating ~mne.Epochs, we now ensure that reject_tmin and reject_tmax cannot fall outside of the epochs' time interval anymore (8821 by `Richard Höchenberger`_)
~mne.io.read_raw_bti erroneously treated response channels as respiratory channels (8856 by `Richard Höchenberger`_)
The RMS trace shown in the time viewer of ~mne.SourceEstimate plots is now correctly labeled as RMS (was GFP before) (8965 by `Richard Höchenberger`_)
Fix bug with mne.SourceEstimate.plot and related functions where the scalars were not interactively updated properly (8985 by `Eric Larson`_)
Fix bug with mne.channels.find_ch_adjacency() returning wrong adjacency for Neuromag122-Data (8891 by `Martin Schulz`_)
Fix mne.read_dipole yielding mne.Dipole objects that could not be indexed (8963 by `Marijn van Vliet`_)
Fix bug when setting n_jobs > 1 in mne.Report.parse_folder (9109 by `Martin Schulz`_)
Fix bug with mne.Evoked.plot_image where an incorrect clim parameter did not raise any error (9115 by Matteo Anelli)
Fix bug with mne.io.Raw.pick where incorrect fnirs types were returned (9178 by `Robert Luke`_)
Fix bug when passing both axes and picks to mne.viz.plot_compare_evokeds (9252 by `Daniel McCloy`_)
Improved string representation of ~mne.Epochs containing multiple event types; improved (and more mathematically correct) evoked.comment in the mne.combine_evoked output; and better (and often more concise) legend labels in the figures created via ~mne.viz.plot_compare_evokeds (9027 by `Richard Höchenberger`_)
mne.preprocessing.find_ecg_events now correctly handles situation where no ECG activity could be detected, and correctly returns an empty array of ECG events (9236 by `Richard Höchenberger`_)
Fix bug with picks attribute for ~mne.Epochs after calling mne.Epochs.add_channels (9246 by `Alex Gramfort`_)
Fix bug where backend='notebook' could not be used in mne.SourceEstimate.plot (9305 by `Jean-Rémi King`_)
mne.preprocessing.compute_proj_eog and mne.preprocessing.compute_proj_ecg now return empty lists if no EOG or ECG events, respectively, could be found. Previously, we'd return None in these situations, which does not match the documented behavior of returning a list of projectors (9277 by `Richard Höchenberger`_)
Introduced new 'auto' settings for ICA.max_iter. The old default max_iter=200 will be removed in MNE-Python 0.24 (9099 by Cora Kim)
mne.viz.plot_sensors_connectivity now allows setting the colorbar label via the cbar_label parameter (9248 by `Daniel McCloy`_)
mne.read_selection has been deprecated in favor of mne.read_vectorview_selection. mne.read_selection will be removed in MNE-Python 0.24 (8870 by `Richard Höchenberger`_)
mne.beamformer.tf_dics has been deprecated and will be removed in MNE-Python 0.24 (9122 by `Britta Westner`_)
Fitting ~mne.preprocessing.ICA on baseline-corrected ~mne.Epochs, and / or applying it on baseline-corrected ~mne.Epochs or ~mne.Evoked data will now display a warning. Users are advised to only baseline correct their data after cleaning is completed (9033 by `Richard Höchenberger`_)
Supplying multiple channel names to mne.preprocessing.find_eog_events or mne.preprocessing.compute_proj_eog as a string of comma-separated channel names has been deprecated; please pass a list of channel names instead. Support for comma-separated strings will be removed in MNE-Python 0.24 (9269 by `Richard Höchenberger`_)
The default in mne.beamformer.make_dics of real_filter=False will change to real_filter=True in 0.24 (9340 by `Britta Westner`_)
People who contributed to this release in alphabetical order (people with a + are first time contributors):
Adam Li
Alex Rockhill
Alexandre Gramfort
Ana Radanovic
Andres Rodriguez+
Anna Padee+
Apoorva Karekal+
Britta Westner
Catalina Magalvan
Christian Brodbeck
Christian Mista
Christian O'Reilly
Christina Zhao
Christopher J. Bailey
Clemens Brunner
Cora Kim+
Daniel McCloy
Denis A. Engemann
Dominik Welke+
Eduard Ort
Enrico Varano+
Eric Larson
Erica Peterson+
Evgenii Kalenkovich
Felix Klotzsche+
Giorgio Marinato
Guillaume Favelier
Jack Zhang+
Jean-Rémi King
Johann Benerradi
Joris Van den Bossche
Judy D Zhu+
Liberty Hamilton
Luke Bloy
Maggie Clarke+
Mainak Jas
Manorama Kadwani
Marijn van Vliet
Martin Schulz
Matt Sanderson+
Matteo Anelli+
Nicolas Gensollen
Ram Pari+
Richard Höchenberger
Richard Koehler+
Robert Luke
Rotem Falach+
Sebastien Treguer
Silvia Cotroneo+
Stefan Appelhoff
Steven Bierer
Sumalyo Datta+
Timon Merk
Tristan Stenner
Valerii Chirkov+
Victoria Peterson
Yu-Han Luo
Zhi Zhang+
Nothing published for this version
The max_pca_components argument of ~mne.preprocessing.ICA has been deprecated, use n_components during initialization and n_pca_components in ~mne.pre…
Add mne.read_evokeds_mff to read averaged MFFs (requires mffpy >= 0.5.7) by Evan Hathaway (8354)
Add mne.decoding.SSD for spatial filtering with spatio-spectral-decomposition (7070 by Victoria Peterson and `Denis Engemann`_)
Add reader for optical imaging data recorded using ISS Imgagent I/II hardware and BOXY recording software in mne.io.read_raw_boxy (7717 by Jonathan Kuziek and `Kyle Mathewson`_)
Add options to use labels in mne.minimum_norm.get_point_spread and mne.minimum_norm.get_cross_talk (8275 by `Olaf Hauk`_)
Update surfaces argument in mne.viz.plot_alignment to allow dict for transparency values, and set default for sEEG data to have transparency (8445 by `Keith Doelling`_)
Add support for mri_fiducials='estimated' in mne.viz.plot_alignment to allow estimating MRI fiducial locations using mne.coreg.get_mni_fiducials (8553 by `Eric Larson`_)
Update default values in mne coreg and mne.viz.plot_alignment for clearer representation of MRI and digitized fiducial points (8553 by `Alex Gramfort`_ and `Eric Larson`_)
Add n_pca_components argument to mne.viz.plot_ica_overlay (8351 by `Eric Larson`_)
Add mne.stc_near_sensors to facilitate plotting ECoG data (8190 by `Eric Larson`_)
Add proj argument to mne.make_fixed_length_epochs (8351 by `Eric Larson`_)
Add mne.preprocessing.realign_raw to realign simultaneous raw recordings in the presence of clock drift (8539 by `Eric Larson`_)
Reduce memory usage of volume source spaces (8379 by `Eric Larson`_)
Speed up heavy use of mne.SourceMorph.apply for volumetric source spaces by use of the method mne.SourceMorph.compute_vol_morph_mat (8366 by `Eric Larson`_)
Add support for non-uniform zooms (e.g., when using a surrogate MRI via mne.scale_mri) in volumetric morphing (8642 by `Eric Larson`_)
In mne.compute_source_morph zooms are no longer required to match the spacing of src_to, which is useful to ensure the morphing is accurate when the src_to spacing is large (e.g., 1 cm) (8642 by `Eric Larson`_)
Add volumetric source space support to mne.labels_to_stc (8447 by `Eric Larson`_)
Speed up mne.decoding.TimeDelayingRidge with edge correction using Numba (8323 by `Eric Larson`_)
Add mne.Epochs.reset_drop_log_selection to facilitate writing epochs with many ignored entries in their drop log (8449 by `Eric Larson`_)
Add sEEG source visualization using mne.stc_near_sensors and sEEG working tutorial (8402 by `Eric Larson`_ and `Adam Li`_)
Add mne.channels.DigMontage.get_positions, which will return a dictionary of channel positions, coordinate frame and fiducial locations (8460 by `Adam Li`_)
Add support for writing digitization points in a coordinate frame other than head in mne.channels.DigMontage.save (8532 by `Eric Larson`_)
Add picks parameter to mne.preprocessing.fix_stim_artifact to specify which channel needs to be fixed (8482 by `Alex Gramfort`_)
Add progress bar support to mne.time_frequency.csd_morlet (8608 by `Eric Larson`_)
Further improved documentation building instructions and execution on Windows (8502 by `Evgenii Kalenkovich`_ and `Eric Larson`_)
Add option to disable TQDM entirely with MNE_TQDM='off' (8515 by `Eric Larson`_)
Add option on_header_missing to mne.channels.read_polhemus_fastscan (8622 by `Eric Larson`_)
Add option window to mne.time_frequency.psd_welch and related functions (8862 by `Eric Larson`_)
mne.preprocessing.ICA.plot_sources now displays an mne.preprocessing.ICA.plot_properties window when right-clicking on component names on the y-axis (8381 by `Daniel McCloy`_)
mne.io.read_raw_edf, mne.io.read_raw_bdf, and mne.io.read_raw_gdf now detect and handle invalid highpass/lowpass filter settings (8584 by `Clemens Brunner`_)
If a baseline tuple containing one or two None values – e.g. (None, 0), (0, None), or (None, None) – is passed to ~mne.Epochs or ~mne.Epochs.apply_baseline, the None value(s) will be replaced with the actual time (i.e., ~mne.Epochs.tmin and ~mne.Epochs.tmax, respectively) when populating Epochs.baseline (8442 by `Richard Höchenberger`_)
~mne.Epochs will now retain the information about an applied baseline correction, even if the baseline period is partially or completely removed through cropping later on (8442 by `Richard Höchenberger`_)
Add mne.source_space.compute_distance_to_sensors to compute distances between vertices and sensors (8534 by `Olaf Hauk`_ and `Marijn van Vliet`_)
Annotations can now be shown/hidden interactively in raw plots (8624 by `Daniel McCloy`_)
Added argument colors to mne.grow_labels (8519 by `Olaf Hauk`_)
Added mne.SourceEstimate.apply_baseline method for baseline-correction of source estimates (8452 by `Olaf Hauk`_)
New mne.viz.Brain.set_time method to set the displayed time in seconds (8415 by `Daniel McCloy`_)
Update the backend parameter of mne.viz.plot_source_estimates to integrate pyvista (8395 by `Guillaume Favelier`_)
Add group_by parameter to mne.viz.plot_epochs and mne.Epochs.plot to allow displaying channel data by sensor position (8381 by `Daniel McCloy`_)
Fix orthogonalization of power envelopes in mne.connectivity.envelope_correlation (8658 by Qianliang Li and `Eric Larson`_)
Fix data overwrite of cascading simulation operations :mne.simulation.simulate_raw (8633 by Jeff Stout)
Fix a transpose issue of mne.decoding.CSP.plot_filters (8580 by Hongjiang Ye)
Fix mne.io.read_raw_curry to deal with Curry datasets that have channels that are listed in the labels file, but which are absent from the saved data file (e.g. 'Ref' channel). Also now populates info['meas_date'] if possible (8400 by Tod Flak)
Fix bug with mne.io.egi.tests/test_egi.py where it mandatorily downloaded testing data when it was not necessary (8474 by Aniket Pradhan)
Fix bug with reading split files that have dashes in the filename (8339 by Eduard Ort)
Fix bug with parsing EDF dates and date integers (8558 by Austin Hurst and `Eric Larson`_)
Fix bug with reading EDF and KIT files on big endian architectures such as s390x (8618 by `Eric Larson`_)
Fix bug with mne.beamformer.make_dics where the rank parameter was not properly handled (8594 by `Marijn van Vliet`_ and `Eric Larson`_)
Fix bug with mne.beamformer.apply_dics where the whitener was not properly applied (8610 by `Eric Larson`_)
Fix bug with ~mne.viz.plot_epochs_image when order is supplied and multiple conditions are plotted (8377 by `Daniel McCloy`_ )
Fix bug with mne.viz.plot_source_estimates when using the PyVista backend where singleton time points were not handled properly (8285 by `Eric Larson`_)
Fix bug when passing axes to plotting functions, matplotlib.pyplot.tight_layout will not be called when the figure was created using a constrained layout (8344 by `Eric Larson`_)
Fix bug with compensated CTF data when picking channels without preload (8318 by `Eric Larson`_)
Fix bug with plotting MEG topographies where the wrong extrapolation made was used in ICA (8637 by `Eric Larson`_)
Fix bug when merging fNIRS channels in mne.viz.plot_evoked_topomap and related functions (8306 by `Robert Luke`_)
Fix bug where events could overflow when writing to FIF (8448 by `Eric Larson`_)
mne.io.read_raw_edf now supports EDF files with invalid recording dates (8283 by `Clemens Brunner`_)
Fix bug with mne.io.Raw.save when using split_naming='bids' where non-split files would still be named name_split-01_meg.fif instead of the requested name_meg.fif (8464 by `Alex Gramfort`_ and `Eric Larson`_)
Fix bug with mne.preprocessing.ICA where n_pca_components as a python:float would give the number of components that explained less than or equal to the given variance. It now gives greater than the given number for better usability and consistency with sklearn.decomposition.PCA. Generally this will mean that one more component will be included (8326 by `Eric Larson`_)
Fix bug with mne.preprocessing.ICA where projections were not tracked properly (8343 by `Eric Larson`_)
Fix bug where extrapolation points created artifacts in mne.viz.plot_evoked_topomap and related functions (8425 by `Mikołaj Magnuski`_)
Fix bug with mne.preprocessing.read_ica_eeglab where full-rank data were not handled properly (8326 by `Eric Larson`_)
Fix bug with somato-dataset where the BEM was not included (8317 by `Eric Larson`_)
Fix bug with coordinate frames when performing volumetric morphs via mne.compute_source_morph and mne.SourceMorph.apply that could lead to ~5 mm bias (8642 by `Eric Larson`_)
Fix bug with volumetric rendering alpha in mne.VolSourceEstimate.plot_3d and related functions (8663 by `Eric Larson`_)
Fix missing documentation of mne.io.read_raw_nihon in tut-imorting-eeg-data (8320 by `Adam Li`_)
Fix bug with mne.add_reference_channels when mne.io.Raw.reorder_channels or related methods are used afterward (8303, #8484 by `Eric Larson`_)
Fix bug where the verbose arguments to mne.Evoked.apply_baseline and mne.Epochs.apply_baseline were not keyword-only (8349 by `Eric Larson`_)
ICA.max_pca_components will not be altered by calling ~mne.preprocessing.ICA.fit anymore. Instead, the new attribute ICA.max_pca_components_ will be set (8321 by `Richard Höchenberger`_)
Fix bug that ~mne.viz.plot_ica_overlay would sometimes not create red traces (8341 by `Richard Höchenberger`_)
Fix bug with ~mne.preprocessing.ICA where n_components=None, n_pca_components=None could lead to unstable unmixing matrix inversion by making n_components=None also use the lesser of n_components=0.999999 and n_components=n_pca_components (8351 by `Eric Larson`_)
The ica.n_pca_components property is no longer be updated during mne.preprocessing.ICA.fit, instead ica.n_components_ will be added to the instance (8351 by `Eric Larson`_)
Pass rank everyhwere in forward preparation for source imaging. This bug affected sparse solvers when using maxfilter data (8368 by `Alex Gramfort`_)
Fix bug in mne.viz.plot_alignment where ECoG and sEEG channels were not plotted and fNIRS channels were always plotted in the head coordinate frame (8393 by `Eric Larson`_)
Fix bug in mne.set_bipolar_reference where ch_info could contain invalid channel information keys (8416 by `Eric Larson`_)
When reading BrainVision raw data, the channel units and types were sometimes not inferred correctly (8434 by `Richard Höchenberger`_)
Attempting to remove baseline correction from preloaded ~mne.Epochs will now raise an exception (8435 by `Richard Höchenberger`_)
mne.Report.parse_folder will now correctly handle split FIFF files (8486, 8491 by `Richard Höchenberger`_)
Fix bug where BrainVision channel names, event types, and event descriptions containing commas were incorrectly parsed (8492 by `Stefan Appelhoff`_)
Fix bug in mne.preprocessing.compute_fine_calibration where the magnetometer calibration coefficients were computed incorrectly (8522 by `Eric Larson`_)
Fix bug in mne.io.read_raw_eeglab where empty event durations led to an error (8384 by `Mikołaj Magnuski`_)
Fix inset sensor plots to always use equal aspect (8545 by `Daniel McCloy`_)
Fix bug in mne.viz.plot_compare_evokeds where evokeds with identical comment attributes would not plot properly if passed as a list (8590 by `Daniel McCloy`_)
Fix bug in mne.time_frequency.psd_welch and related functions where the window default errantly changed from 'hamming' to ('tukey', 0.25) (8862 by `Eric Larson`_)
Fix bug in mne.io.read_raw_kit where scale factors for EEG channels could be set to zero (8542 by `Eric Larson`_)
Fix reading GDF files with excluded channels in mne.io.read_raw_gdf (8520 by `Clemens Brunner`_)
Fix automatic selection of extrapolation mask type from channel type when plotting field maps (8589 by `Daniel McCloy`_)
Fix bug in mne.viz.set_3d_title where 3D plot could have multiple titles that overlap (8564 by `Guillaume Favelier`_)
Fix bug in mne.viz.set_3d_view where plotter is not updated properly causing camera issues in the doc (8564 by `Guillaume Favelier`_)
mne.preprocessing.find_ecg_events didn't take the tstart parameter value into account when calculating the average heart rate (8605 by `Richard Höchenberger`_)
Minimum required versions were increased for core dependencies NumPy (1.15.4), SciPy (1.1.0), and Matplotlib (3.0) and for the optional dependencies scikit-learn (0.20.2) and pandas (0.23.4) (8374 by `Eric Larson`_)
The parameter on_split_missing has been added to mne.io.read_raw_fif and its default will change from 'warn' to 'raise' in 0.23, by (8357 `Eric Larson`_)
The max_pca_components argument of ~mne.preprocessing.ICA has been deprecated, use n_components during initialization and n_pca_components in ~mne.preprocessing.ICA.apply instead (8351 by `Eric Larson`_)
The n_pca_components argument of ~mne.preprocessing.ICA has been deprecated, use n_pca_components in ~mne.preprocessing.ICA.apply (8356 by `Eric Larson`_)
The trans argument of mne.extract_label_time_course is deprecated and will be removed in 0.23 as it is no longer necessary (8389 by `Eric Larson`_)
Parameter event_colors in mne.viz.plot_epochs and mne.Epochs.plot is deprecated, replaced by event_color which is consistent with mne.viz.plot_raw and provides greater flexibility (8381 by `Daniel McCloy`_)
People who contributed to this release in alphabetical order (people with a + are first time contributors):
Adam Li
Alexandre Gramfort
Aniket Pradhan +
Austin Hurst +
Christian Brodbeck
Clemens Brunner
Daniel McCloy
Denis A. Engemann
Eduard Ort +
Eric Larson
Evan Hathaway +
Evgenii Kalenkovich
Fede Raimondo
Guillaume Favelier
Hongjiang Ye +
Jean-Rémi King
Jeff Stout +
Jonathan Kuziek +
Jussi Nurminen
Justus Schwabedal
Keith Doelling
Kyle Mathewson
Mads Jensen
Mainak Jas
Marijn van Vliet
Mikolaj Magnuski
Olaf Hauk
Qianliang Li +
Richard Höchenberger
Robert Luke
Stefan Appelhoff
Thomas Hartmann
Tod Flak +
Victoria Peterson +
Nothing published for this version
Nothing published for this version
The normalize_fwd argument of mne.beamformer.make_dics has been deprecated in favor of depth, by Eric Larson_
Modified mne.Epochs.pick_types to remove dropped channel types from reject and flat dictionaries by Rahul Nadkarni
Add function mne.preprocessing.regress_artifact to remove artifacts using linear regression by Kyle Mathewson and `Eric Larson`_
Add sources and detectors options for fNIRS use of mne.viz.plot_alignment allowing plotting of optode locations in addition to channel midpoint channels and path between fNIRS optodes by Kyle Mathewson
BrainVision data format files are now parsed for EEG impedance values in mne.io.read_raw_brainvision and provided as a .impedances attribute of raw by Jan Sedivy and `Stefan Appelhoff`_
Add function mne.channels.combine_channels to combine channels from Raw, Epochs, or Evoked according to ROIs (combinations including mean, median, or standard deviation; can also use a callable) by Johann Benerradi
Improved documentation building instructions and execution on Windows by Martin Schulz, `Evgenii Kalenkovich`_, and `Eric Larson`_
Speed up reading of annotations in EDF+ files by Jeroen Van Der Donckt
Add head to mri and mri to voxel space transform details to tut-source-alignment tutorial, by `Alex Rockhill`_
Improve memory efficiency of mne.concatenate_epochs by `Eric Larson`_
Allow picking channels in raw instances (e.g., mne.io.Raw.pick_types) without preloading data, by `Eric Larson`_
mne.preprocessing.ICA.plot_sources now plots annotation markers similar to mne.io.Raw.plot by `Luke Bloy`_
Add support for scalar multiplication and division of mne.time_frequency.AverageTFR instances by `Luke Bloy`_
Add support for signals in mV for mne.io.read_raw_brainvision by `Clemens Brunner`_
mne.Epochs.plot_psd_topomap and mne.viz.plot_epochs_psd_topomap now allow joint colorbar limits across subplots, by `Daniel McCloy`_.
Add support for using loose-orientation surface priors with free-orientation volume priors in mixed source space inverses by `Eric Larson`_
Add mne.MixedVectorSourceEstimate for vector source estimates for mixed source spaces, by `Eric Larson`_
Add mixed and volumetric source estimate plotting using volumetric ray-casting to mne.MixedSourceEstimate.plot and mne.VolSourceEstimate.plot_3d by `Eric Larson`_
Add mne.MixedSourceEstimate.surface and mne.MixedSourceEstimate.volume methods to allow surface and volume extraction by `Eric Larson`_
Add mne.VectorSourceEstimate.project to project vector source estimates onto the direction of maximum source power by `Eric Larson`_
Add support to mne.extract_label_time_course for vector-valued and volumetric source estimates by `Eric Larson`_
Add method mne.VolSourceEstimate.in_label by `Eric Larson`_
Add support for mixed source spaces to mne.compute_source_morph by `Eric Larson`_
Add support for volume and mixed source spaces to mne.stats.summarize_clusters_stc by `Eric Larson`_
Add support for omitting the SDR step in volumetric morphing by passing n_iter_sdr=() to mne.compute_source_morph by `Eric Larson`_
Add single_volume argument to mne.setup_volume_source_space to facilitate creating source spaces with many volumes (e.g., all subvolumes of aseg.mgz) by `Eric Larson`_
Add support for passing a string argument to bg_img in mne.viz.plot_volume_source_estimates by `Eric Larson`_
Add support for providing the destination surface source space in the src_to argument of mne.compute_source_morph by `Eric Larson`_
Add explained variance logging to mne.inverse_sparse.mixed_norm, mne.inverse_sparse.gamma_map, and mne.beamformer.rap_music by `Eric Larson`_
Add tol_kind option to mne.compute_rank by `Eric Larson`_
Allow resampling raw data with mne.io.Raw.resample without preloading data, by `Eric Larson`_
Allow using pick_ori='vector' with a fixed-orientation inverse to facilitate visualization with mne.viz.plot_vector_source_estimates by `Eric Larson`_
mne.viz.plot_dipole_locations and mne.Dipole.plot_locations gained a title argument to specify a custom figure title in orthoview mode by `Richard Höchenberger`_
Add orientations projected onto the MRI slices in mne.viz.plot_dipole_locations in 'orthoview' mode by `Eric Larson`_
Add temporal derivative distribution repair (TDDR) mne.preprocessing.nirs.temporal_derivative_distribution_repair with shortened alias mne.preprocessing.nirs.tddr by `Robert Luke`_
Add mne.read_freesurfer_lut to make it easier to work with volume atlases by `Eric Larson`_
Add support for overlap-add processing when method='spectrum_fit' in mne.io.Raw.notch_filter by `Eric Larson`_
Add functionality to interpolate bad NIRS channels by `Robert Luke`_
Add ability to interpolate EEG channels using minimum-norm projection in mne.io.Raw.interpolate_bads and related functions with method=dict(eeg='MNE') by `Eric Larson`_
Added ability of mne.io.read_raw_nirx to open data by passing path to header file `Robert Luke`_
Add mne.channels.DigMontage.rename_channels to allow renaming montage channels by `Eric Larson`_
Document mne.channels.compute_native_head_t to allow computing the native-to-head transformation that will be applied when doing raw.set_montage and related functions by `Eric Larson`_
Add support to in mne.io.Raw.plot for passing clipping as a float to clip to a proportion of the dedicated channel range by `Eric Larson`_
Add function mne.preprocessing.annotate_muscle_zscore to annotate periods with muscle artifacts. by `Adonay Nunes`_
Add mne.stats.ttest_ind_no_p to mirror mne.stats.ttest_1samp_no_p with hat correction by `Eric Larson`_
Add mne.stats.combine_adjacency to combine adjacency matrices for independent data dimensions to enable things like spatio-temporal-time-frequency clustering in mne.stats.permutation_cluster_test by `Eric Larson`_
Speed up raw data reading without preload in mne.io.read_raw_nirx by `Eric Larson`_
Speed up mne.Epochs.copy and mne.Epochs.__getitem__ by avoiding copying immutable attributes by `Eric Larson`_
Speed up and reduce memory usage of mne.SourceEstimate.plot and related functions/methods when show_traces=True by `Eric Larson`_
Reduce memory usage of ~mne.io.Raw.plot_psd, mne.time_frequency.psd_welch, and ~mne.time_frequency.psd_array_welch for long segments of data by `Eric Larson`_
Support for saving movies of source time courses (STCs) with brain.save_movie method and from graphical user interface by `Guillaume Favelier`_
Add mri and show_orientation arguments to mne.viz.plot_bem by `Eric Larson`_
Add mne.viz.centers_to_edges to help when using matplotlib.axes.Axes.pcolormesh with flat shading by `Eric Larson`_
Add on_missing='raise' to mne.io.Raw.set_montage and related functions to allow ignoring of missing electrode coordinates by `Adam Li`_
Add on_missing='raise' to mne.viz.plot_events to allow ignoring missing events when passing event_id by `Eric Larson`_
Add REST EEG infinity reference scheme to mne.io.Raw.set_eeg_reference and related functions by `Eric Larson`_
Add better sanity checking of max_pca_components and n_components to provide more informative error messages for mne.preprocessing.ICA by `Eric Larson`_
Add plot option to mne.viz.plot_filter allowing selection of which filter properties are plotted and added option for user to supply axes by `Robert Luke`_
Add estimation method legend to mne.viz.plot_snr_estimate by `Eric Larson`_
Add support to mne.SourceSpaces.export_volume for mri_resolution='sparse' to color only the nearest-neighbor voxels instead of entire regions by `Eric Larson`_
Add axes argument to mne.viz.plot_evoked_white, mne.Evoked.plot_white, and mne.viz.plot_snr_estimate by `Eric Larson`_
Change default to surfaces='auto' from surfaces='head' to allow mne.viz.plot_alignment to work when just passing a mne.Info as plot_alignment(info) by `Eric Larson`_
Add ECoG misc EDF dataset to the tut-working-with-ecog tutorial to show snapshots of time-frequency activity by `Adam Li`_
Add mne.viz.set_3d_options and MNE_3D_OPTION_ANTIALIAS environment variable to control full-scene antialiasing (FXAA) in 3D functions like mne coreg, mne.viz.plot_alignment, and mne.viz.plot_source_estimates; this can be useful on systems where FXAA does not work well, such as some with MESA software rendering, by `Eric Larson`_
Add config variable MNE_TQDM to support explicitly setting the TQDM backend to use, for example tqdm or tqdm.auto (default) by `Eric Larson`_
Add better support for reading corrupted FIF files in mne.io.read_raw_fif by `Eric Larson`_
BIDS conformity: When saving FIF files to disk and the files are split into parts, the split_naming='bids' parameter now uses a "_split-%d" naming instead of the previous "_part-%d", by `Stefan Appelhoff`_
Add support for whitening and multiple channel types in mne.beamformer.make_dics by `Marijn van Vliet`_
Add better error message when trying to save incompatible ~mne.Evoked objects to the same file by `Eric Larson`_
Add support for loading complex numbers from mat files by `Thomas Hartmann`_
Add generic reader function mne.io.read_raw that loads files based on their extensions (it wraps the underlying specific read_raw_xxx functions) by `Clemens Brunner`_
Add automatic T3 magnetometer detection and application of mne.io.Raw.fix_mag_coil_types to mne.preprocessing.maxwell_filter by `Eric Larson`_
Add extended SSS (eSSS) support to mne.preprocessing.maxwell_filter by `Eric Larson`_
Add 'auto' option to mne.preprocessing.ICA.find_bads_ecg to automatically determine the threshold for CTPS method by `Yu-Han Luo`_
Add a notebook 3d backend for visualization in jupyter notebook with mne.viz.set_3d_backend by `Guillaume Favelier`_
Add support for reading and writing surfaces in Wavefront .obj format to the mne.read_surface and mne.write_surface by `Marijn van Vliet`_
Add tutorial on how to manually fix BEM meshes in Blender by `Marijn van Vliet`_ and `Ezequiel Mikulan`_
mne.write_evokeds will now accept mne.Evoked objects with differing channel orders in info['bads'], which would previously raise an exception by `Richard Höchenberger`_
Add support for reading channel names (e.g., for Ricoh data) to mne.io.read_raw_kit by `Alex Gramfort`_ and `Eric Larson`_
The reject_tmin and reject_tmax parameters of mne.Epochs are now taken into account when using the reject_by_annotation parameter by `Stefan Appelhoff`_
mne.preprocessing.find_bad_channels_maxwell now automatically applies a low-pass filter before running bad channel detection. This can be disabled, restoring previous behavior by `Richard Höchenberger`_
Add proj='reconstruct' to mne.Evoked.plot and related functions to apply projectors and then undo the signal bias using field mapping by `Eric Larson`_
Add writing BEM surfaces and solutions in H5 format in mne.write_bem_surfaces and mne.write_bem_solution by `Eric Larson`_
When picking a subset of channels, or when dropping channels from ~mne.io.Raw, ~mne.Epochs, or ~mne.Evoked, projectors that can only be applied to the removed channels will now be dropped automatically by `Richard Höchenberger`_
mne.Report now can add topomaps of SSP projectors to the generated report. This behavior can be toggled via the new projs argument by `Richard Höchenberger`_
When passing a list of ~mne.Evoked objects to ~mne.viz.plot_compare_evokeds, each evoked's .comment attribute will be used to label the trace. If .comment is empty, a 1-based index is assigned as the label by `Richard Höchenberger`_
Speed up mne.stats.summarize_clusters_stc using Numba by `Yu-Han Luo`_
Add reject_by_annotation=True to mne.make_fixed_length_epochs and mne.preprocessing.ICA.plot_properties to reject bad data segments based on annotation by `Yu-Han Luo`_
~mne.Report.parse_folder now accepts a path-like folder name (it used to work with strings only) by `Alex Gramfort`_
Add component_order parameter to mne.decoding.CSP which allows switching between mutual_info (default) and alternate (a simpler and frequently used option) by `Martin Billinger`_ and `Clemens Brunner`_
Add memory size information to the repr of mne.SourceSpaces and mne.SourceEstimate and related classes by `Eric Larson`_
Add reader for Persyst (.lay + .dat format) data in mne.io.read_raw_persyst by `Adam Li`_
Use PyVista as the default backend for 3D visualization instead of Mayavi by `Guillaume Favelier`_
Add reader for SNIRF NIRS data in mne.io.read_raw_snirf by `Robert Luke`_
~mne.Evoked has gained tmin and tmax attributes for more consistency with ~mne.Epochs by `Richard Höchenberger`_
Fix bug for writing and reading complex evoked data modifying mne.write_evokeds and mne.read_evokeds by Lau Møller Andersen
Fix bug by adding error message when trying to save complex stc data in a non.-h5 format mne.VolSourceEstimate.save by Lau Møller Andersen
Fix bug with logging in mne.io.Raw.set_eeg_reference and related functions by Simeon Wong
Fix bug with mne.io.read_raw_gdf where birthdays were not parsed properly, leading to an error by Svea Marie Meyer
Fix bug with mne.io.read_raw_edf where recording ID was not read properly for non-ASCII characters by Alexandra Corneyllie
Fix bug in mne.set_eeg_reference and related functions to set info['custom_ref_applied'] to True for 'ecog' and 'seeg' channels in addition to 'eeg' by Liberty Hamilton
Fix bug with mne.chpi.compute_chpi_amplitudes and mne.chpi.filter_chpi to optimize time window length by Steven Bierer
Fix bug with mne.preprocessing.ICA.find_bads_eog when more than one EOG components are present by `Christian O'Reilly`_
Fix bug with non-preloaded data when using raw.apply_proj().load_data().get_data() where projectors were not applied by `Eric Larson`_
Fix bug to permit stc.project('nn', src) to be applied after stc was restricted to an mne.Label by `Luke Bloy`_
Fix bug with mne.io.Raw.set_meas_date to support setting meas_date to None, by `Luke Bloy`_
Fix bug with mne.setup_volume_source_space when volume_label was supplied where voxels slightly (in a worst case, about 37% times pos in distance) outside the voxel-grid-based bounds of regions were errantly included, by `Eric Larson`_
Fix bug with mne coreg where reverse scalings were applied to src[0]['src_mri_t'] for volume source spaces, so morphing and plotting did not work correctly by `Eric Larson`_
Fix bug with mne.io.read_raw_ctf when reference magnetometers have the compensation grade marked by `Eric Larson`_
Fix bug with mne.SourceSpaces.export_volume with use_lut=False where no values were written by `Eric Larson`_
Fix bug with mne.preprocessing.annotate_movement where bad data segments, specified in raw.annotations, would be handled incorrectly by `Luke Bloy`_
Fix bug with mne.compute_source_morph when more than one volume source space was present (e.g., when using labels) where only the first label would be interpolated when mri_resolution=True by `Eric Larson`_
Fix bug with mne.compute_source_morph when morphing to a volume source space when src_to is used and the destination subject is not fsaverage by `Eric Larson`_
Fix bug with mne.compute_source_morph where outermost voxels in the destination source space could be errantly omitted by `Eric Larson`_
Fix bug with mne.compute_source_morph where complex data was cast to real when doing a volumetric morph by `Eric Larson`_
Fix bug with mne.minimum_norm.compute_source_psd_epochs and mne.minimum_norm.source_band_induced_power raised errors when method='eLORETA' by `Eric Larson`_
Fix bug with mne.minimum_norm.apply_inverse where the explained variance did not work for complex data by `Eric Larson`_
Fix bug with mne.preprocessing.compute_current_source_density where values were not properly computed; maps should now be more focal, by `Alex Rockhill`_ and `Eric Larson`_
Fix bug with mne.combine_evoked where equal-weighted averages were wrongly computed as equal-weighted sums, by `Daniel McCloy`_
Fix bug with mne.channels.DigMontage.plot when reference channels with no defined position are present, by `Eric Larson`_
Fix bug with mne.channels.read_custom_montage where "headshape" points in SFP format were not read properly, by `Eric Larson`_
Fix bug with setting HTML classes when using mne.Report.add_bem_to_section by `Eric Larson`_
Fix bug with convex-hull based MEG helmet creation where the face area could be covered up, by `Eric Larson`_
Fix bug with mne.inverse_sparse.mixed_norm and mne.inverse_sparse.gamma_map with return_as_dipoles=True and mne.beamformer.rap_music where dip.gof was the same for all dipoles. GOF values / explained variance across all dipoles now gets split among the dipoles using SVD of the lead fields. To get the total GOF, sum(dip.gof for dip in dipoles) can be used, by `Eric Larson`_
Fix bug with mne.inverse_sparse.gamma_map where output data was not assigned properly when using a free-orientation forward and xyz_same_gamma=False by `Eric Larson`_
Fix to enable interactive plotting with no colorbar with mne.viz.plot_evoked_topomap by `Daniel McCloy`_
Fix plotting with mne.viz.plot_evoked_topomap to pre-existing axes by `Daniel McCloy`_
Fix bug with mne.viz.plot_vector_source_estimates using the PyVista backend with time_viewer=True when updating the arrow colormaps by `Eric Larson`_
Fix bug with mne.viz.plot_vector_source_estimates where clim='auto' and clim=dict(..., kind='percent') did not take into account the magnitude of the activation, by `Eric Larson`_
The default plotting mode for mne.io.Raw.plot and mne browse_raw has been changed to clipping=3. to facilitate data analysis with large deflections, by `Eric Larson`_
PSD plots will now show non-data channels (e.g., misc) if those channels are explicitly passed to picks, by `Daniel McCloy`_.
Fix bug with mne.time_frequency.read_tfrs where info['meas_date'] was not parsed correctly, by `Eric Larson`_
Fix bug with mne.time_frequency.tfr_array_stockwell where inputs were not properly validated by `Eric Larson`_
Fix handling of NaN when using TFCE in clustering functions such as mne.stats.spatio_temporal_cluster_1samp_test by `Eric Larson`_
Fix handling of signs when using TFCE by `Eric Larson`_
The mne.MixedSourceEstimate class has been clarified to contain two cortical surface source spaces, plus at least one other source space. Creating source estimates in other orderings is not supported, by `Eric Larson`_
Fix bug where VolSourceEstimate.vertices was an instance of ~numpy.ndarray instead of python:list of one ~numpy.ndarray, by `Eric Larson`_
Fix default to be foreground=None in mne.viz.plot_source_estimates to use white or black text based on the background color by `Eric Larson`_
Fix bug with writing EGI and CTF mne.Info to H5 format, e.g., with mne.time_frequency.AverageTFR.save by `Eric Larson`_
Fix bug with topomap outlines in mne.time_frequency.AverageTFR.plot_joint and mne.time_frequency.AverageTFR.plot_topo by `Eric Larson`_
Fix bug with mne.io.Raw.plot where toggling all projectors did not actually take effect by `Eric Larson`_
Fix bug with mne.write_proj where the number of columns was incorrectly written by `Eric Larson`_
Fix bug with mne.read_epochs when loading data in complex format with preload=False by `Eric Larson`_
Fix bug with mne.Epochs.save where the file splitting calculations did not account for the sizes of non-data writes by `Eric Larson`_
Fix bug with mne.Epochs when metadata was not subselected properly when event_repeated='drop' by `Eric Larson`_
Fix bug with mne.Epochs where epochs.drop_log was a list of list of str rather than an immutable tuple of tuple of str (not meant to be changed by the user) by `Eric Larson`_
Fix bug with mne.Report where the BEM section could not be toggled by `Eric Larson`_
Fix bug when using mne.Epochs.crop to exclude the baseline period would break mne.Epochs.save / mne.read_epochs round-trip by `Eric Larson`_
Fix bug with mne.Epochs.subtract_evoked where using decimated epochs would lead to an error by `Eric Larson`_
Fix bug with mne.viz.plot_bem and mne.Report when plotting BEM contours when MRIs are not in standard FreeSurfer orientation by `Eric Larson`_
Fix bug with mne.minimum_norm.make_inverse_operator where it would warn even when an explicit rank was used by `Eric Larson`_
Fix bugs with mne.beamformer.make_lcmv and mne.beamformer.make_dics where:
Noise normalization factors weight_norm='unit-noise-gain' and weight_norm='nai' were computed incorrectly
pick_ori='max-power' computed the max-power orientation incorrectly
pick_ori='normal' did not compute power or noise normalization factors correctly
mne.beamformer.apply_lcmv_cov did not apply whitening and projections properly
Fix mne setup_forward_model to have it actually compute the BEM solution in addition to creating the BEM model by `Eric Larson`_
Fix bug with mne.io.read_raw_edf where null bytes were not properly handled, causing an error when opening a file by `Eric Larson`_
Fix bug with mne.Report where unicode characters were not rendered properly (encoding for HTML was not set) by `Eric Larson`_
Fix bug with mne.preprocessing.nirs.scalp_coupling_index where filter transition was incorrectly assigned by `Robert Luke`_
Fix bug with mne.make_forward_dipole where mne.write_forward_solution could not be used by `Eric Larson`_
Fix bug with mne.io.Raw.plot when scalings='auto' where bad data would prevent channel plotting by `Eric Larson`_
Default border and extrapolate arguments for mne.Evoked.plot_topomap and related functions were changed from 0. to 'mean' and 'box' to 'auto', respectively, to help more accurately reflect sensor geometries and boundary conditions. extrapolate='auto' uses extrapolate='local' for MEG data and extrapolate='head' otherwise, by `Eric Larson`_
Fix bug that prevents n_jobs from being a NumPy integer type, by `Daniel McCloy`_.
Fix bug with mne.epochs.average_movements where epoch weights were computed using all basis vectors instead of the internal basis only by `Eric Larson`_
Fix bug with mne.get_volume_labels_from_aseg where the returned labels were alphabetical instead of reflecting their volumetric ID-based order by `Eric Larson`_
Fix bug with mne.preprocessing.find_bad_channels_maxwell where good data of exactly step duration would lead to an error by `Eric Larson`_
Fix bug with mne.preprocessing.find_bad_channels_maxwell where indices were not handled properly when MEG channels were not first in the raw instance, and logging messages incorrectly reported the interval used by `Eric Larson`_
Make mne.set_config accept path-like input values by `Richard Höchenberger`_
Fix bug with mne.write_labels_to_annot and mne.datasets.fetch_hcp_mmp_parcellation where label name strings were not properly terminated, leading to problems loading in FreeSurfer by `Eric Larson`_
Fix bug with mne.beamformer.make_dics where complex conjugates were not applied properly by `Britta Westner`_ and `Eric Larson`_
Fix bug with mne.bem.make_watershed_bem where the RAS coordinates of watershed bem surfaces were not updated correctly from the volume file by `Yu-Han Luo`_
Fix bug with mne.io.Raw.get_channel_types and related methods where the ordering of picks was not preserved, by `Eric Larson`_
Fix bug with mne.io.Raw.plot_psd with average=False and multiple channel types where channel locations were not shown properly by `Eric Larson`_
Fix bug with mne.viz.plot_sparse_source_estimates when using 'sphere' mode by `Eric Larson`_ and `Guillaume Favelier`_
Fix bug in FieldTrip reader functions when channels are missing in the info object by `Thomas Hartmann`_
Throw proper error when trying to import FieldTrip Epochs data with non-uniform time for trials by `Thomas Hartmann`_
Throw proper error when trying to import FieldTrip data saved by an old, incompatible version by `Thomas Hartmann`_
Fix bug in mne.read_epochs_fieldtrip when importing data without a trialinfo field by `Thomas Hartmann`_
Fix bug in mne.preprocessing.ICA.plot_properties where time series plot doesn't start at the proper tmin by `Teon Brooks`_
Fix bug with mne.preprocessing.ICA.plot_properties where a mne.io.Raw object with annotations would lead to an error by `Yu-Han Luo`_
Fix bug with mne.events_from_annotations(raw.annotations) when orig_time of annotations is None and raw.first_time > 0, by `Alex Gramfort`_
Python 3.5 is no longer supported, Python 3.6+ is required, by `Eric Larson`_
adjacency has replaced connectivity in the names of:
Arguments to clustering functions, such as mne.stats.permutation_cluster_test, and
Function names for defining adjacency, such as mne.spatio_temporal_src_adjacency replacing mne.spatio_temporal_src_connectivity.
The complete list of changed function names is:
mne.channels.find_ch_connectivity → ~mne.channels.find_ch_adjacency
mne.channels.read_ch_connectivity → ~mne.channels.read_ch_adjacency
mne.spatial_dist_connectivity → ~mne.spatial_dist_adjacency
mne.spatial_inter_hemi_connectivity → ~mne.spatial_inter_hemi_adjacency
mne.spatial_src_connectivity → ~mne.spatial_src_adjacency
mne.spatial_tris_connectivity → ~mne.spatial_tris_adjacency
mne.spatio_temporal_dist_connectivity → ~mne.spatio_temporal_dist_adjacency
mne.spatio_temporal_src_connectivity → ~mne.spatio_temporal_src_adjacency
mne.spatio_temporal_tris_connectivity → ~mne.spatio_temporal_tris_adjacency
"connectivity" is now reserved for discussions of functional and effective connectivity of the brain, and "adjacency" for source or sensor neighbor definitions for cluster-based analyses, by `Eric Larson`_.
The default for the standardize_names argument of mne.io.read_raw_kit will change from True to False in 0.22, by `Eric Larson`_
The normalize_fwd argument of mne.beamformer.make_dics has been deprecated in favor of depth, by `Eric Larson`_
The overwrite parameter of mne.write_bem_surfaces and mne.write_bem_solution defaults to True in 0.21 but will change to False in 0.22, by `Eric Larson`_
Add n_cols parameter to mne.preprocessing.ICA.plot_scores to allow plotting scores in multiple columns, by `Luke Bloy`_
In mne.stats.permutation_cluster_test and mne.stats.permutation_cluster_1samp_test the default parameter value out_type='mask' has changed to None, which in 0.21 means 'mask' but will change to mean 'indices' in the next version, by `Daniel McCloy`_
The default window size set by filter_length when method='spectrum_fit' in mne.io.Raw.notch_filter will change from None (use whole file) to '10s' in 0.22, by `Eric Larson`_
vmin and vmax parameters are deprecated in mne.Epochs.plot_psd_topomap and mne.viz.plot_epochs_psd_topomap; use new vlim parameter instead, by `Daniel McCloy`_.
The method stc_mixed.plot_surface for a mne.MixedSourceEstimate has been deprecated in favor of stc.surface().plot(...) by `Eric Larson`_
The method stc.normal for mne.VectorSourceEstimate has been deprecated in favor of stc.project('nn', src) by `Eric Larson`_
Add use_dev_head_trans parameter to mne.preprocessing.annotate_movement to allow choosing the device to head transform is used to define the fixed cHPI coordinates by `Luke Bloy`_
The function mne.channels.read_dig_captrack will be deprecated in version 0.22 in favor of mne.channels.read_dig_captrak to correct the spelling error: "captraCK" -> "captraK", by `Stefan Appelhoff`_
The threshold argument in mne.preprocessing.ICA.find_bads_ecg defaults to None in version 0.21 but will change to 'auto' in 0.22 by `Yu-Han Luo`_
The function mne.preprocessing.mark_flat has been deprecated in favor of mne.preprocessing.annotate_flat by `Eric Larson`_
The default argument meg=True in mne.pick_types will change to meg=False in version 0.22 by `Clemens Brunner`_
Added mne.io.Raw.get_montage, which obtains the montage that an instance has, by `Adam Li`_
People who contributed to this release in alphabetical order (people with a + are first time contributors):
Adam Li
Adonay Nunes
Alejandro Weinstein
Alex Rockhill
Alexandre Gramfort
Anton Nikolas Waniek
Britta Westner
Christian O'Reilly
Clemens Brunner
Daniel McCloy
Eric Larson
Evgenii Kalenkovich
Fede Raimondo
Guillaume Favelier
Hubert Banville
Jeroen Van Der Donckt +
Johann Benerradi +
Kyle Mathewson +
Lau Møller Andersen +
Liberty Hamilton +
Luke Bloy
Lx37 +
Mainak Jas
Marijn van Vliet
Martin Billinger
Martin Schulz +
Martin van Harmelen
Mikolaj Magnuski
Olaf Hauk
Rahul Nadkarni +
Richard Höchenberger
Robert Luke
Sara Sommariva
Simeon Wong +
Stefan Appelhoff
Steven Bierer +
Svea Marie Meyer +
Teon Brooks
Thomas Hartmann
Yu-Han Luo
chapochn
mshader
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Changes for raise_if_subset.
Changes for raise_if_subset.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Passing ch_types=None has been deprecated in favor of explicitly passing ch_types='misc' in mne.create_info by Eric Larson_
Improved mne.viz.plot_epochs to label epoch counts starting from 0, by `Sophie Herbst`_
Add minimum_norm.apply_inverse_cov to compute static power by applying inverse solutions to a data covariance matrix by `Denis Engemann`_, `Luke Bloy`_, and `Eric Larson`_
Add mne.minimum_norm.resolution_metrics to compute various resolution metrics for inverse solutions, by `Olaf Hauk`_
Add current source density mne.preprocessing.compute_current_source_density to compute the surface Laplacian in order to reduce volume conduction in data by `Alex Rockhill`_
Add mne.chpi.extract_chpi_locs_ctf to extract cHPI coil locations from CTF data by `Luke Bloy`_
Add mne.chpi.compute_chpi_amplitudes, mne.chpi.compute_chpi_locs, and mne.chpi.compute_head_pos to compute head positions from cHPI coil locations by `Eric Larson`_ and `Luke Bloy`_
Add allow_line_only option to mne.chpi.filter_chpi to allow filtering line frequencies only in files that do not have cHPI information by `Eric Larson`_
Add mne.io.Raw.set_meas_date by `Eric Larson`_
Add mne.Epochs.as_type to allow remapping data in MEG channels to virtual magnetometer or gradiometer channels by `Sophie Herbst`_ and `Alex Gramfort`_
Add copy parameter to mne.Epochs.iter_evoked by `Alex Gramfort`_
Add command mne setup_source_space to quickly set up bilateral hemisphere surface-based source space with subsampling by `Victor Férat`_.
Add command mne sys_info to print system information by `Eric Larson`_
Add function mne.make_fixed_length_epochs to segment raw into fixed length epochs by `Mohammad Daneshzand`_
Add support for computing patch information only in surface source space creation with add_dist='patch' in mne.setup_source_space and dist_limit=0 in mne.add_source_space_distances by `Eric Larson`_
Add mne.Label.restrict to restrict a label to vertices within a source space by `Eric Larson`_
Add support for passing a destination source space src_to in mne.compute_source_morph to ensure morphing for multiple subjects results in consistent STCs, by `Eric Larson`_
Add support for smooth='nearest' for surfaces in mne.compute_source_morph by `Eric Larson`_
Add support for plotting fNIRS channels in mne.viz.plot_alignment, mne.viz.plot_evoked_topo and mne.Evoked.animate_topomap by `Eric Larson`_ and `Robert Luke`_
Add command line tool mne anonymize for anonymizing raw fiff files by `Luke Bloy`_
Add mne.preprocessing.find_bad_channels_maxwell for automatic bad channel detection via Maxwell filtering by `Eric Larson`_
Add support to mne.io.anonymize_info to allow time offset to be applied to dates by `Luke Bloy`_
Add support for computing resolution matrix to get point spread functions (PSF) and cross-talk functions (CTF) in mne.minimum_norm.make_inverse_resolution_matrix, mne.beamformer.make_lcmv_resolution_matrix, mne.minimum_norm.get_cross_talk, mne.minimum_norm.get_point_spread by `Olaf Hauk`_
Add mne.preprocessing.read_ica_eeglab to read EEGLAB ICA decompositions by `Christian O'Reilly`_
Add keyboard functionality to interactive colorbar plotting TFRs by `Stefan Repplinger`_
Add the ability to return_event_id in mne.read_events for use with MNE-C produced -annot.fif files, by `Eric Larson`_
Add option to mne.connectivity.spectral_connectivity to compute corrected imaginary PLV by `Adonay Nunes`_
Add mne.SourceEstimate.estimate_snr to estimate source-space SNR, by `Kaisu Lankinen`_ and `Padma Sundaram`_
Add option to specify the coordinate frame in mne.channels.read_custom_montage by `Eric Larson`_
Add option to use match_case=False to mne.io.Raw.set_montage and related functions by `Eric Larson`_
Add reader for NIRx data in mne.io.read_raw_nirx by `Robert Luke`_
Add function to convert NIRS data to optical density mne.preprocessing.nirs.optical_density by `Robert Luke`_
Add function to convert NIRS data to haemoglobin concentration mne.preprocessing.nirs.beer_lambert_law by `Robert Luke`_
Add fig argument to mne.viz.plot_evoked_field by `Eric Larson`_
Add functions to calculate spatial information of NIRS channels mne.preprocessing.nirs.source_detector_distances and mne.preprocessing.nirs.short_channels by `Robert Luke`_
Add reader for *.dat electrode position files mne.channels.read_dig_dat by `Christian Brodbeck`_
Improved mne.viz.plot_events to always show event counts by `Eric Larson`_
Improved limo-dataset usage and example for usage of mne.stats.linear_regression by `José C. García Alanis`_
Add support for reduce_rank=True for vector beamformers by `Eric Larson`_
Add method='sphere' support for using FreeSurfer spherical inflation in mne.decimate_surface to facilitate mesh downsampling for use with mne.make_bem_model by `Eric Larson`_
Speed up mne.beamformer.make_lcmv and mne.beamformer.make_dics calculations by vectorizing linear algebra calls by `Dmitrii Altukhov`_ and `Eric Larson`_
Speed up mne.make_forward_solution using Numba, by `Eric Larson`_
Speed up mne.io.read_raw_fif data reading when the recording is long and there are many data tags repeatedly accessed, by `Eric Larson`_
For KIT systems without built-in layout, mne.channels.find_layout now falls back on an automatically generated layout, by `Christian Brodbeck`_
mne.Epochs.plot now takes a epochs_colors parameter to color specific epoch segments by `Mainak Jas`_
Add command mne setup_forward_model to quickly create a BEM model for a subject by `Victor Férat`_.
Add command mne prepare_bem_model to quickly create a BEM solution using the linear collocation approach by `Victor Férat`_.
Add support for reading .bdip Xfit binary dipole fit files in mne.read_dipole by `Eric Larson`_
Allow returning vector source estimates from sparse inverse solvers through pick_ori='vector' by `Christian Brodbeck`_
Add NIRS support to mne.viz.plot_topomap and mne.viz.plot_ica_components by `Robert Luke`_
Add the ability to mne.channels.equalize_channels to also re-order the channels and also operate on instances of mne.Info, mne.Forward, mne.Covariance and mne.time_frequency.CrossSpectralDensity by `Marijn van Vliet`_
Allow mne.channels.read_custom_montage to handle fiducial points for BESA spherical (.elp) files by `Richard Höchenberger`_
Add rank argument to mne.fit_dipole by `Eric Larson`_
Add function to convert events to annotations mne.annotations_from_events by `Nicolas Barascud`_
Add function to calculate scalp coupling index for fNIRS data mne.preprocessing.nirs.scalp_coupling_index by `Robert Luke`_
Add item argument to mne.Epochs.get_data for faster access to NumPy data arrays compared to mne.Epochs.__getitem__ for frequent access on large mne.Epochs objects, by `Eric Larson`_
More accurate coordinate system for Easycap montages in mne.channels.make_standard_montage by `Christian Brodbeck`_
Add border argument to mne.viz.plot_topomap. border controls the value of the edge points to which topomap values are extrapolated. border='mean' sets these points value to the average of their neighbours. By `Mikołaj Magnuski`_
Add function mne.viz.link_brains to link time properties of multiple brain objects interactively by `Guillaume Favelier`_
Add function mne.preprocessing.annotate_movement to annotate periods with head motion and mne.preprocessing.compute_average_dev_head_t to re-estimate the device to head transform with average head position during segments with acceptable head movement. by `Adonay Nunes`_
Make selected channels more distinguishable in mne.Epochs.plot_sensors when using kind='select' by `Mikołaj Magnuski`_
Allow retrieval of the number of Infomax ICA iterations via the new return_n_iter keyword argument of mne.preprocessing.infomax by `Richard Höchenberger`_
Expose the number of ICA iterations during the fitting procedure via the n_iter_ attribute of mne.preprocessing.ICA by `Richard Höchenberger`_
mne.grand_average now produces a warning when only a single dataset was passed, instead of raising an error by `Richard Höchenberger`_
Add nrows and ncols parameters to mne.viz.plot_evoked_topomap, which allows to create multiline topomap plots for Evoked. By `Federico Raimondo`_
Improve repr of mne.Info (empty items are not shown anymore) by `Clemens Brunner`_
Fix the reduce_rank parameter in mne.beamformer.make_lcmv and mne.beamformer.make_dics to reduce the rank of the leadfield first before then reducing the rank of the denominator of the beamformer formula for the inversion by `Britta Westner`_ and `Eric Larson`_.
Fix bug with mne.beamformer.make_lcmv with data where rank was incorrectly checked by `Eric Larson`_.
Allow mne.channels.read_dig_hpts to accept point categories (eg. EEG) to be specified in upper case by `Alex Gramfort`_.
Fix a bug in mne.MixedSourceEstimate.plot_surface that prevented plotting in latest PySurfer by `Christian O'Reilly`_.
Fix method='eLORETA' in mne.minimum_norm.apply_inverse, by `Eric Larson`_:
regularization, which was off by roughly a factor of a square root
units, which are now nAm instead of being arbitrary
explained variance and residuals, which were previously unavailable
force_equal in the case of loose orientations, which previously defaulted to True now defaults to False. Reapplying orientation priors at each iteration of the algorithm sufficiently preserves a smooth transition between loose=0. to loose=1. without compromising localization accuracy in testing.
Fix bug in method='eLORETA' for mne.minimum_norm.apply_inverse (and variants) to allow restricting source estimation to a label by `Luke Bloy`_
Fix bug in mne.compute_covariance and mne.compute_raw_covariance where biased normalization (based on degrees of freedom) was used and cov.nfree was not set properly by `Eric Larson`_
Fix mne.VectorSourceEstimate.normal to account for cortical patch statistics using use_cps=True by `Eric Larson`_
Fix pick_ori='normal' for mne.minimum_norm.apply_inverse when the inverse was computed with loose=1. and the forward solution was not in surface orientation, by `Eric Larson`_
Fix missing xlabel for mne.io.Raw.plot_psd and similar functions when passing a subset of axes from a figure by `Alex Gramfort`_
Fix wrong DataFrame index when index=None in methods mne.io.Raw.to_data_frame, mne.Epochs.to_data_frame, mne.Evoked.to_data_frame, and mne.SourceEstimate.to_data_frame, by `Daniel McCloy`_.
Fix incorrect scaling of cluster temporal extent in mne.stats.summarize_clusters_stc by `Daniel McCloy`_.
Fix mne.time_frequency.read_tfrs to properly read ~mne.Info transforms by `Eric Larson`_
Fix mne.viz.plot_sensors to always plot in head coordinate frame by `Daniel McCloy`_.
Fix mne.io.read_raw_cnt for version 1 of format in the presence of annotations by `Alex Gramfort`_.
Fix mne.decoding.GeneralizingEstimator and related classes to support multi-class sklearn scorers such as 'roc_auc_ovo' and 'roc_auc_ovo_weighted' by `Eric Larson`_
Fix mne.io.read_raw_ctf to set measurement date from CTF ds files by `Luke Bloy`_.
Fix mne.read_epochs_eeglab that ignored channel locations by `Alex Gramfort`_.
Fix mne.io.read_raw_brainvision when channel names have spaces by `Sebastian Major`_.
Fix mne.io.read_raw_brainvision when "Core" is in the data header by `Eric Larson`_
Fix mne.io.Raw.anonymize to correctly reset raw.annotations.orig_time by `Luke Bloy`_.
Fix mne.io.Raw.anonymize to correctly avoid shifting raw.annotations.onset relative to raw.first_samp by `Eric Larson`_
Fix mne.io.Raw.set_channel_types and mne.io.Raw.rename_channels and related methods to return the instance instead of None by `Eric Larson`_
mne.Epochs.iter_evoked now does not return a copy of info when copy=False (default parameter) by `Alex Gramfort`_
The attribute mne.Annotations.orig_time is now read-only, and is a ~python:datetime.datetime object (or None) rather than float, by `Eric Larson`_
Fix bug where MRI distances were not properly initialized in mne coreg by `Eric Larson`_
Fix xscale='log' in mne.io.Raw.plot_psd and related functions by `Alex Gramfort`_
Unify behavior of raw.annotations.append(...) when raw.info['meas_date'] is None to make onsets absolute relative to first_samp as they are when raw.info['meas_date'] is not None; i.e., you might need to do raw.annotations.append(old_time + raw.first_time), by `Eric Larson`_
The info['meas_date'] entry is now a ~python:datetime.datetime object (or None) rather than float, by `Eric Larson`_
Fix mne.time_frequency.AverageTFR.save and related functions to deal with ~python:datetime.datetime objects properly by `Eric Larson`_
Fix date reading before Unix time zero (1970 Jan 1) on Windows by `Alex Rockhill`_.
Fix bug running subprocesses (e.g., in mne.bem.make_watershed_bem) in Jupyter notebooks, by `Eric Larson`_
Fix mne.io.read_raw_artemis123 to add HPI locations to digitization points, by `Luke Bloy`_
Fix mne.Epochs.shift_time and mne.Evoked.shift_time to return the modified ~mne.Epochs or ~mne.Evoked instance (instead of None) by `Daniel McCloy`_.
Fix mne.read_annotations for text files with zero or one annotations, by `Adonay Nunes`_
Fix bug in ~mne.preprocessing.ICA where requesting extended infomax via fit_params={'extended': True} was overridden, by `Daniel McCloy`_.
Fix bug in mne.Epochs.interpolate_bads where the origin was not used during MEG or EEG data interpolation by `Eric Larson`_. Old behavior can be achieved using origin=(0., 0., 0.) for EEG and origin=(0., 0., 0.04) for MEG, and the new default is origin='auto', which uses a head-digitization-based fit.
Fix bug in mne.write_evokeds where evoked.nave was not saved properly when multiple ~mne.Evoked instances were written to a single file, by `Eric Larson`_
Fix bug in mne.preprocessing.mark_flat where acquisition skips were not handled properly, by `Eric Larson`_
Fix bug in mne.viz.plot_bem where some sources were not plotted by `Jean-Rémi King`_ and `Eric Larson`_
Fix TAL channel parsing (annotations) for EDF-D files by `Clemens Brunner`_
Fix bug with mne.viz.plot_dipole_locations when plotting in head coordinates by `Eric Larson`_
Fix handling in cases where no components are found in mne.preprocessing.corrmap by `Eric Larson`_
Fix handling of repeated events in mne.Epochs by `Fahimeh Mamashli`_ and `Alex Gramfort`_
Fix many bugs with plotting sensors overlaid on a head outline. All plotting is now done in head coordinates and scaled by head_radius, which defaults to 0.095, by `Eric Larson`_
Fix mne.io.anonymize_info to allow shifting dates of service and to match anticipated changes in mne-cpp by `Luke Bloy`_
Fix reading of cardinals in .htps files (identifier are int not strings) by `Alex Gramfort`_
Fix IO of TFRs when event_id contain a / in one of the keys by `Alex Gramfort`_
Fix plotting of TFRs with linear y-scale (misaligned frequency bins), by `Stefan Repplinger`_ and `Eric Larson`_
Fix info['sfreq'] when decimating in mne.time_frequency.tfr_multitaper and mne.time_frequency.tfr_morlet and make sure an error is raised when exceed Nyquist frequency by `Adonay Nunes`_
Fix bug in EDF(+) loading, filter values ignored by insufficient regex, by `Darlene Heliokinde`_
Fix missing scaling of tolerance parameter in mne.inverse_sparse.tf_mixed_norm and mne.inverse_sparse.mixed_norm, by `Mathurin Massias`_
Fix the automatic scaling of the glyphs in mne.viz.plot_vector_source_estimates by using 10% of the brain width, by `Guillaume Favelier`_
Fix handling of missing values (NaNs) in mne.time_frequency.psd_welch by `Clemens Brunner`_
Fix mne.decoding.LinearModel to support the refitted estimator of GridSearchCV in sklearn by `Chun-Hui Li`_
Fix mne.viz.plot_topomap when there are bad channels in the provided mne.Info instance by `Eric Larson`_
Fix check for subject definition existing in source space in mne.compute_source_morph and related functions by `Eric Larson`_
Fix creation of new figures in mne.Epochs.plot_image and mne.viz.plot_epochs_image by `Eric Larson`_
Fix bug in ~mne.preprocessing.Xdawn where filters where selected along the incorrect axis, by `Henrich Kolkhorst`_
Fix bug in mne.bem.make_watershed_bem where some surfaces were saved incorrectly in the working directory by `Yu-Han Luo`_
Fix support for multiple TAL (annotations) channels in BDF reader by `Clemens Brunner`_
Fix missing brainmask file type in mne.bem.make_watershed_bem by changing its default value to ws.mgz by `Fu-Te Wong`_
Fix bug in mne.channels.make_standard_montage which would return easycap-M1 even when requesting easycap-M10 by `Christian Brodbeck`_
Fix the way planar gradiometers are combined in mne.viz.plot_tfr_topomap and mne.Epochs.plot_psd_topomap by `Geoff Brookshire`_
Improve error message when trying to load FieldTrip data from a cell array by `Thomas Hartmann`_
Fix bug in mne.read_evoked_fieldtrip causing it to crash when channels were present in the provided Info object but were not present in the data by `Thomas Hartmann`_
Fix placement of extrapolation points in mne.Evoked.plot_topomap and related functions when exactly three channels were used by `Mikołaj Magnuski`_.
Fix bug in reading annotations in read_annotations, which would not accept ";" character by `Adam Li`_
Fix bug in mne.Report.parse_folder, which would not recognize *meg.fif files by `Dmitrii Altukhov`_.
Include fit_params when saving an ~mne.preprocessing.ICA instance to disk by `Richard Höchenberger`_
Update old url link in mne.datasets.eegbci.load_data to EEGMI_URL = 'https://physionet.org/files/eegmmidb/1.0.0/' by `Ramiro Gatti`_
Ensure corrected p-values calculated by mne.stats.bonferroni_correction never exceed the value of 1.0 by `Richard Höchenberger`_
mne.io.pick.get_channel_types is now called mne.io.pick.get_channel_type_constants to better reflect its return values, by `Daniel McCloy`_.
mne.Evoked.as_type now returns an instance of mne.EvokedArray by `Sophie Herbst`_ and `Alex Gramfort`_
Bumped minimum requirements to fall 2017 versions by `Eric Larson`_:
NumPy 1.13.3
SciPy 1.0.0
matplotlib 2.1
scikit-learn 0.19.1 (optional requirement)
pandas 0.21 (optional requirement)
mne.Epochs.plot now accepts an event_id parameter (useful in tandem with event_colors for specifying event colors by name) by `Daniel McCloy`_.
Passing ch_types=None has been deprecated in favor of explicitly passing ch_types='misc' in mne.create_info by `Eric Larson`_
New time conversion options for methods mne.io.Raw.to_data_frame, mne.Epochs.to_data_frame, mne.Evoked.to_data_frame, and mne.SourceEstimate.to_data_frame, by `Daniel McCloy`_.
mne.Epochs.shift_time and mne.Evoked.shift_time now allow shifting times by arbitrary amounts (previously only by integer multiples of the sampling period), by `Daniel McCloy`_ and `Eric Larson`_.
The head_pos argument of mne.Evoked.plot_topomap and related functions has been deprecated in favor of head_radius, by `Eric Larson`_.
The layout argument to topomap-related functions such as mne.Evoked.plot_topomap and mne.viz.plot_tfr_topomap has been deprecated in favor of channel-position based flattening based on the info and sphere argument, by `Eric Larson`_.
The APIs of mne.io.Raw.plot_projs_topomap, mne.Epochs.plot_projs_topomap and mne.Evoked.plot_projs_topomap are now more similar to mne.viz.plot_projs_topomap by `Daniel McCloy`_.
The function mne.setup_volume_source_space has a sphere_units argument that defaults to 'mm' in 0.20 but will change to 'm' in 0.21, set it to avoid a warning by `Eric Larson`_.
mne.viz.plot_projs_topomap and the related methods mne.io.Raw.plot_projs_topomap, mne.Epochs.plot_projs_topomap and mne.Evoked.plot_projs_topomap now accept parameter vlim to control the colormap, with keyword 'joint' computing the colormap jointly across all projectors of a given channel type, by `Daniel McCloy`_.
New methods mne.io.Raw.get_channel_types, mne.Epochs.get_channel_types, mne.Evoked.get_channel_types by `Daniel McCloy`_.
Deprecate mne.minimum_norm.point_spread_function and mne.minimum_norm.cross_talk_function by `Alex Gramfort`_
Deprecate montage parameter of mne.create_info in favor of mne.io.Raw.set_montage, mne.Info.set_montage, and related functions by `Eric Larson`_
mne.channels.equalize_channels no longer operates in-place by default, but instead makes copies of the objects when necessary (see copy parameter) by `Marijn van Vliet`_
mne.channels.equalize_channels now uses the first object in the list as a template for channel ordering by `Marijn van Vliet`_
mne.channels.equalize_channels now also re-orders the channels to match, in addition to dropping channels that are not shared by all objects by `Marijn van Vliet`_
mne.io.Raw.pick_channels, mne.Epochs.pick_channels and mne.Evoked.pick_channels now have an ordered parameter to enforce the ordering of the picked channels by `Marijn van Vliet`_
New methods mne.Forward.pick_channels, mne.Covariance.pick_channels, mne.Info.pick_channels, mne.time_frequency.CrossSpectralDensity.pick_channels by `Marijn van Vliet`_
New attributes mne.Forward.ch_names and mne.Info.ch_names by `Marijn van Vliet`_
In ~mne.preprocessing.Xdawn, the components are stored in the rows of attributes filters_ and patterns_ to be consistent with ~mne.decoding.CSP and ~mne.preprocessing.ICA by `Henrich Kolkhorst`_
Drop unit keyword argument from mne.channels.read_custom_montage, as it was unused by `Richard Höchenberger`_
Deprecate mne.preprocessing.run_ica, use mne.preprocessing.ICA.detect_artifacts instead by `Richard Höchenberger`_
People who contributed to this release (in alphabetical order):
Adam Li
Adonay Nunes
Alex Rockhill
Alexandre Gramfort
Ariel Rokem
Britta Westner
Carlos de la Torre-Ortiz
Christian Brodbeck
Christian O'Reilly
Chun-Hui Li
Clemens Brunner
Daniel McCloy
Demetres Kostas
Denis A. Engemann
Dmitrii Altukhov
Dominik Welke
Eric Larson
Ezequiel Mikulan
Fahimeh Mamashli
Fede Raimondo
Fu-Te Wong
Geoff Brookshire
Guillaume Favelier
Henrich Kolkhorst
Joan Massich
José C. García Alanis
Jussi Nurminen
Kaisu Lankinen
Luke Bloy
Mainak Jas
Marijn van Vliet
Mathurin Massias
Mikolaj Magnuski
Mohamed Sherif
Mohammad Daneshzand
Nataliia Kozhemiako
Nicolas Barascud
Nicolas Legrand
Olaf Hauk
Padma Sundaram
Ramiro Gatti
Richard Höchenberger
Robert Luke
Robert Oostenveld
Sebastian Major
Sophie Herbst
Stefan Appelhoff
Stefan Repplinger
Thomas Hartmann
Victor Férat
Yu-Han Luo
Nothing published for this version
Fix plotting of TFRs with linear y-scale (misaligned frequency bins), by Stefan Repplinger and Eric Larson
mne.preprocessing.ICA where requesting extended infomax via fit_params={'extended': True} was overriddenmne.Epochsmne.preprocessing.corrmapmne.write_evokeds where evoked.nave was not saved properly when multiple mne.Evoked instances were written to a single fileinfo['sfreq'] when decimating in mne.time_frequency.tfr_multitaper and mne.time_frequency.tfr_morlet and make sure an error is raised when exceed Nyquist frequencyReorganized documentation, with 19 new or revised tutorials.
In addition, we caught and fixed more than 41 bugs!
Add mne.cuda.set_cuda_device and config variable MNE_CUDA_DEVICE to select among multiple GPUs (by numeric device ID) by `Daniel McCloy`_.
Add mne.channels.make_standard_montage to create mne.channels.DigMontage from templates by `Joan Massich`_ and `Alex Gramfort`_.
Add mne.channels.compute_dev_head_t to compute Device-to-Head transformation from a montage by `Joan Massich`_ and `Alex Gramfort`_.
Add mne.channels.read_dig_fif to read digitization coordinates from .fif files by `Joan Massich`_ and `Alex Gramfort`_.
Add mne.channels.read_dig_egi to read digitization coordinates from EGI .xml files by `Joan Massich`_ and `Alex Gramfort`_.
Add mne.channels.read_dig_polhemus_isotrak and mne.channels.read_polhemus_fastscan to read Polhemus data by `Joan Massich`_
Add mne.channels.read_dig_captrack to read BrainVision CapTrak (BVCT) digitization coordinate files by `Stefan Appelhoff`_ and `Joan Massich`_
Add mne.channels.make_dig_montage to create mne.channels.DigMontage objects out of np.arrays by `Joan Massich`_
Add mne.channels.read_custom_montage to read various EEG electrode locations files by `Joan Massich`_ and `Alex Gramfort`_.
Add support for making epochs with duplicated events, by allowing three policies: "error" (default), "drop", or "merge" in mne.Epochs by `Stefan Appelhoff`_
Allow mne.Annotations.crop to support negative tmin and tmax by `Joan Massich`_
Unknown events code in GDF are now visible in the event_id by `Théodore Papadopoulo`_
Now mne.io.read_raw_ctf populates raw.annotations with the markers in MarkerFile.mrk if any by `Joan Massich`_
Add options for controlling the use of the -T1 flag and the location of the brainmask output in mne watershed_bem by `Eric Larson`_
Add support to mne.read_annotations to read CTF marker files by `Joan Massich`_
Do not convert effective number of averages (nave attribute of mne.Evoked) to integer except when saving to FIFF file by `Daniel McCloy`_.
Add automatic fiducial position estimation in mne coreg using MNI Talairach fiducial locations in mne.coreg.get_mni_fiducials by `Jon Houck`_ and `Eric Larson`_
Add support for mne coreg scaling surrogate subjects without surface reconstructions, such as those created for volumetric analyses only (e.g., with recon-all -autorecon1) by `Eric Larson`_
Add reader for Curry data in mne.io.read_raw_curry by `Dirk Gütlin`_
Butterfly channel plots now possible for mne.Epochs.plot_psd with average=False. Infrastructure for this function now shared with analogous Raw function, found in mne.viz.utils by `Jevri Hanna`_
Add option not to orthogonalize power envelopes with orthogonalize=False in mne.connectivity.envelope_correlation by `Denis Engemann`_
Accept filenames of raw .fif files that end in _meg.fif to enable complicance with the Brain Imaging Data Structure by `Stefan Appelhoff`_
Add function to check the type of a FIF file using mne.what and mne what by `Eric Larson`_
Add support for specifying the initial time and/or position and providing a mne.SourceMorph instead of mne.SourceSpaces in mne.viz.plot_volume_source_estimates by `Eric Larson`_
Speed up morph map generation in mne.read_morph_map by ~5-10x by using numba.jit by `Eric Larson`_
Speed up mne.setup_volume_source_space, especially when volume_label is not None by `Eric Larson`_
Speed up mne coreg interactive and automated (ICP) alignment by using nearest-neighbor calculations in the MRI coordinate frame, by `Eric Larson`_
Add mne.dig_mri_distances to compute the distances between digitized head points and the MRI head surface by `Alex Gramfort`_ and `Eric Larson`_
Add scale bars for data channels in mne.io.Raw.plot by `Eric Larson`_
Add mne.viz.plot_brain_colorbar to plot a colorbar appropriately matched to a mne.viz.plot_source_estimates plot by `Eric Larson`_
Add support for showing head surface (to visualize digitization fit) while showing a single-layer BEM to mne.viz.plot_alignment by `Eric Larson`_
Add option include_tmax=True to cropping methods mne.io.Raw.crop, mne.Epochs.crop, mne.Evoked.crop, mne.SourceEstimate.crop, mne.Dipole.crop, and mne.time_frequency.AverageTFR.crop by `Eric Larson`_
Change the behavior of mne.io.Raw.plot for scalings='auto' and remove_dc=True to compute the scalings on the data with DC removed by `Clemens Brunner`_
Allow creating annotations within existing annotations in mne.io.Raw.plot by default (the old snapping behavior can be toggled by pressing 'p') by `Clemens Brunner`_
Add plotting of rank estimates in mne.viz.plot_cov by `Eric Larson`_
Add a new mne.viz.plot_sensors_connectivity function to visualize the sensor connectivity in 3D by `Guillaume Favelier`_ and `Alex Gramfort`_
Add support for info['utc_offset'], info['device_info'], and info['helium_info'] components of mne.Info by `Eric Larson`_
Add control over dipole colors in mne.viz.plot_dipole_locations when using orthoview mode by `Eric Larson`_
Use second-order-sections filtering in mne.io.Raw.plot and mne browse_raw by `Eric Larson`_
Add re-referencing functionality for ecog and seeg channel types in mne.set_eeg_reference by `Keith Doelling`_
Add support for median averaging and for returning unaggregated segments in mne.time_frequency.psd_welch by `Richard Höchenberger`_
io.read_raw_kit: add support for NYU New York 2019 system update, by `Christian Brodbeck`_
Fix setting montage eeg ref position for captrak by `Joan Massich`_
Fix saving raw read from BDF file using tmin and tmax using preload=False by `Alex Gramfort`_
Fix mne.grand_average to use equal sum-to-one weights (like it used to, before changes to underlying mne.combine_evoked) by `Daniel McCloy`_
Fix mne.io.Raw.filter to deal with instances with no data channels properly by `Eric Larson`_
Fix one-sample baseline issue in mne.BaseEpochs when using tmin=0 by `Milan Rybář`_
Fix bug in mne.viz.plot_volume_source_estimates where 'glass_brain' MRIs were not transformed to MNI space, by `Eric Larson`_
Fix bug in mne.viz.plot_volume_source_estimates where MRIs with voxels not in RAS orientation could not be browsed properly, by `Eric Larson`_
Fix bug in mne.SourceMorph.apply where output STCs had stc.vertices defined improperly, by `Eric Larson`_
Fix bug in mne.SourceMorph.apply where the default was errantly mri_space=False instead of mri_space=None (as documented), by `Eric Larson`_
Fix mne.VolVectorSourceEstimate.normal and mne.minimum_norm.apply_inverse to only allow normal extraction/orientation for surface and discrete source spaces by `Eric Larson`_
Fix mne.io.Raw.set_annotations for meas_date previous to 1970 by `Joan Massich`_
Fix horizontal spacing issues in mne.io.Raw.plot_psd by `Jevri Hanna`_
Fix reading of dates in BrainVision files if no "New Segment" marker is specified, no date is given, or data is missing, by `Stefan Appelhoff`_
Fix bug with reading one-channel GDF files by `Abram Hindle`_
Fix bug with y-axis labeling in mne.io.Raw.plot_psd by `Eric Larson`_
Fix side-effect where mne.viz.plot_ica_sources and mne.preprocessing.ICA.plot_sources changed the ICA.exclude attribute even when users didn't interact with the plot by `Daniel McCloy`_.
Fix scaling of sources in ica.plot_sources(epochs) by `Eric Larson`_
Fix wrong assumptions about units in BrainVision montages and add test asserting units in "mm" or "auto", by `Stefan Appelhoff`_
Fix scaling issue with signals in mV in EDF files read with mne.io.read_raw_edf by `Alex Gramfort`_
Fix mne.extract_label_time_course behavior when using STCs generated with apply_inverse(..., label=label) or stc.in_label by `Eric Larson`_
Fix bug in mne.io.read_raw_brainvision so that recording date timestamps are also recognized if channel reference data is negative, by `Stefan Appelhoff`_
Fix order of info['dig'] that was alphabetical based on channel names and not following the channel order when using mne.io.Raw.set_montage and a mne.channels.Montage object by `Joan Massich`_ and `Alex Gramfort`_.
Fix reading CNT files larger than 2Gb by `Joan Massich`_
Fix reading of 4D/BTi data with different channel names and onsets in mne.io.read_raw_bti by `Joshua Bear`_ and `Eberhard Eich`_
Fix formula for effective number of averages in mne.combine_evoked when weights='equal' by `Daniel McCloy`_.
Fix bug in mne.simulation.simulate_stc to avoid empty stc if label vertices and source space do not intersect, by `Kostiantyn Maksymenko`_
Fix event_id='auto' in mne.events_from_annotations to recover Brainvision markers after saving it in .fif by `Joan Massich`_
Fix mne.read_epochs_eeglab when epochs are stored as float. By `Thomas Radman`_
Fix mne.Evoked.resample and mne.Epochs.resample not setting inst.info['lowpass'] properly by `Eric Larson`_
Fix checks when constructing volumetric and surface source spaces with mne.setup_volume_source_space and mne.setup_source_space, respectively, by `Eric Larson`_
Fix bug in handling of mne.Evoked types that were not produced by MNE-Python (e.g., alternating average) by `Eric Larson`_
Fix bug in mne.read_source_estimate where vector volumetric source estimates could not be read by `Eric Larson`_
Fix bug in mne.inverse_sparse.mixed_norm and mne.inverse_sparse.tf_mixed_norm where weights was supplied but weights_min was not, by `Eric Larson`_
Fix bug in mne.set_eeg_reference where non-EEG channels could be re-referenced by default if there were no EEG channels present, by `Eric Larson`_
Fix bug in mne.io.Raw.plot when using HiDPI displays and the MacOSX backend of matplotlib by `Eric Larson`_
Fix bug in mne.viz.plot_compare_evokeds when using Neuromag 122 system by `Eric Larson`_
Fix bug in mne.Epochs.plot_psd when some channels had zero/infinite psd values causing erroneous error messages by `Luke Bloy`_
Fix mne.Evoked.decimate not setting inst.first and inst.last properly by `Marijn van Vliet`_
Fix mne.io.read_raw_brainvision not handling Event markers created by PyCorder correctly by `Richard Höchenberger`_
Fix support for string-like objects (such as python:pathlib.Path) by `Eric Larson`_
Fix mne.Report silently suppressing exceptions when used as a context manager by `Marijn van Vliet`_
Deprecate mne.channels.Montage class, mne.channels.read_montage and mne.channels.read_dig_montage function by `Joan Massich`_.
Deprecate passing Montage, str as montage parameter in mne.io.Raw.set_montage by `Joan Massich`_.
Deprecate set_dig parameter in mne.io.Raw.set_montage and update_ch_names in mne.io.RawEEGLAB.set_montage when using mne.channels.DigMontage as by `Joan Massich`_.
Now mne.io.Raw.set_montage raises an error when mne.channels.DigMontage contains only a subset of the channels in raw.info. It also adds raise_if_subset parameter to ensure backward compatibility (defaults to False in 0.19, to True in 0.20, and will be removed in 0.21) by `Joan Massich`_.
Minimum dependency versions for the following libraries have been bumped up (by `Eric Larson`_):
NumPy: 1.12.1
SciPy: 0.18.1
matplotlib: 2.0.2
scikit-learn: 0.18.2
pandas 0.19.2
New boolean parameter show_scrollbars for mne.io.Raw.plot, mne.Epochs.plot, and mne.preprocessing.ICA.plot_sources (and associated functions) that allows hiding the scrollbars and buttons for a "zen mode" data browsing experience. When the plot window has focus, zen mode can be toggled by pressing z, by `Daniel McCloy`_.
Deprecate mne.evoked.grand_average in favor of mne.grand_average (which works on both ~mne.Evoked and ~mne.time_frequency.AverageTFR) by `Daniel McCloy`_
Deprecate exclude parameter in mne.viz.plot_ica_sources and mne.preprocessing.ICA.plot_sources, instead always use the exclude attribute of the ICA object by `Daniel McCloy`_.
Deprecate montage parameter in favor of the set_montage method in all EEG data readers mne.io.read_raw_cnt, mne.io.read_raw_egi, mne.io.read_raw_edf, mne.io.read_raw_gdf, mne.io.read_raw_nicolet, mne.io.read_raw_eeglab and mne.read_epochs_eeglab by `Alex Gramfort`_
New parameter clear in mne.viz.plot_epochs_image for clearing pre-existing axes before plotting into them by `Daniel McCloy`_
mne.viz.plot_epochs_image no longer supports group_by='type' — combining by channel type is now the default when picks is a channel type string; to get individual plots for each channel, pass picks as a list of channel names or indices by `Daniel McCloy`_
New parameter combine in mne.viz.plot_compare_evokeds for specifying method to combine information across channels by `Daniel McCloy`_
FIFF constants related to SmartShield (*_SMSH_* and *_SMARTSHIELD) have been renamed to IAS for consistency with MEGIN, by `Eric Larson`_
The gfp parameter of mne.viz.plot_compare_evokeds is deprecated; use combine='gfp' instead by `Daniel McCloy`_
The truncate_yaxis='max_ticks' parameter of mne.viz.plot_compare_evokeds is deprecated; use truncate_yaxis='auto' instead by `Daniel McCloy`_
The truncate_xaxis and truncate_yaxis parameters of mne.viz.plot_compare_evokeds now perform one-sided truncation unless both are True by `Daniel McCloy`_
The show_legend parameter of mne.viz.plot_compare_evokeds is renamed to legend by `Daniel McCloy`_
mne.viz.plot_compare_evokeds always returns a list of figures even when a single figure is generated by `Daniel McCloy`_
Deprecate average=True and spatial_colors=False for mne.Epochs.plot_psd by `Jevri Hanna`_
mne.io.read_raw_brainvision no longer raises an error when there are inconsistencies between info['chs'] and montage but warns instead by `Joan Massich`_
Add update_ch_names parameter to mne.io.RawEEGLAB.set_montage to allow updating the channel names based on the montage by `Joan Massich`_
Reading annotations contained in GDF files with mne.io.read_raw_gdf now returns numeric event codes as descriptions (instead of textual descriptions) due to restrictive licensing of the GDF event code table from BioSig by `Clemens Brunner`_
channels.find_ch_connectivity now returns pre-built neighbor maps for KIT systems when available, by `Christian Brodbeck`_
Nothing published for this version
Deprecation of mne.realtime module to become entire project in the MNE echosystem
And we caught and fixed more than 50 bugs!
mne.realtime module to become entire project in the MNE echosystemmne.io.find_edf_events, raw.estimate_rankmne.io.read_raw_edf is deprecated and replaced by mne.io.read_raw_bdf and mne.io.read_raw_gdfmne.preprocessing.ICA, mne.simulation.add_noise and mne.simulation.add_chpi have changedmne.Epochs.savemne.minimum_norm.apply_inverse now returns mne.VolVectorSourceEstimate when neededpeak_finder should be imported as: from mne.preprocessing import peak_finderDeprecate cov, iir_params, blink, ecg, chpi, random_state and support for mne.io.Raw instance inputs in mne.simulation.simulate_raw; use mne.simulatio…
Add event_id='auto' in mne.events_from_annotations to accommodate Brainvision markers by `Jona Sassenhagen`_, `Joan Massich`_ and `Eric Larson`_
Add example on how to simulate raw data using subject anatomy, by `Ivana Kojcic`_, `Eric Larson`_, `Samuel Deslauriers-Gauthier`_ and `Kostiantyn Maksymenko`_
mne.beamformer.apply_lcmv_cov returns static source power after supplying a data covariance matrix to the beamformer filter by `Britta Westner`_ and `Marijn van Vliet`_
Add butterfly and order arguments to mne.viz.plot_epochs and offer separated traces for non-meg data (seeg, eeg, ecog) in butterfly view by `Stefan Repplinger`_ and `Eric Larson`_
mne.Epochs.get_data now takes a picks parameter by `Jona Sassenhagen`_
~mne.viz.plot_compare_evokeds will generate topo plots if axes='topo' by `Jona Sassenhagen`_
mne.viz.iter_topography can yield an additional axis, e.g., for plotting legends by `Jona Sassenhagen`_ and `Daniel McCloy`_
Default plot title reflects channel type when picks is a channel type in ~mne.viz.plot_compare_evokeds by `Daniel McCloy`_
Color scale limits in ~mne.viz.plot_topo_image_epochs are now computed separately per channel type in combined mag/grad plots, by `Daniel McCloy`_
mne.simulation.simulate_stc now allows for label overlaps by `Nathalie Gayraud`_, and `Ivana Kojcic`_
Add long_format option to the pandas dataframe exporters, e.g mne.Epochs.to_data_frame by `Denis Engemann`_
Add example on how to load standard montage plot_montage by `Joan Massich`_
Add new tutorial on tut-eeg-fsaverage-source-modeling by `Alex Gramfort`_, and `Joan Massich`_
Add mne.Epochs.apply_hilbert and mne.Evoked.apply_hilbert by `Eric Larson`_
Add convenience fsaverage subject dataset fetcher / updater mne.datasets.fetch_fsaverage by `Eric Larson`_
Add fmin and fmax argument to mne.time_frequency.AverageTFR.crop and to mne.time_frequency.EpochsTFR.crop to crop TFR objects along frequency axis by `Dirk Gütlin`_
Add support to mne.read_annotations to read CNT formats by `Joan Massich`_
Add reject parameter to mne.preprocessing.ICA.plot_properties to visualize rejected epochs by `Antoine Gauthier`_
Add support for picking channels using channel name and type strings to functions with picks arguments, along with a convenience mne.io.Raw.pick, mne.Epochs.pick, and mne.Evoked.pick method, by `Eric Larson`_
Add new tutorial on tut-sleep-stage-classif by `Alex Gramfort`_, `Stanislas Chambon`_ and `Joan Massich`_
Add data fetchers for polysomnography (PSG) recordings from Physionet (mne.datasets.sleep_physionet.age.fetch_data and mne.datasets.sleep_physionet.temazepam.fetch_data) by `Alex Gramfort`_ and `Joan Massich`_
Add envelope correlation code in mne.connectivity.envelope_correlation by `Denis Engemann`_, `Sheraz Khan`_, and `Eric Larson`_
Add option to toggle all projectors in mne.io.Raw.plot and related functions by `Eric Larson`_
Add support for indexing, slicing, and iterating mne.Annotations by `Joan Massich`_
mne.io.Raw.plot now uses the lesser of n_channels and raw.ch_names, by `Joan Massich`_
Add support for FIR filtering in mne.io.Raw.plot and mne browse_raw by passing filtorder=0 or --filtorder 0, respectively, by `Eric Larson`_
Add chunk_duration parameter to mne.events_from_annotations to allow multiple events from a single annotation by `Joan Massich`_
Add mne.simulation.SourceSimulator class to simplify simulating SourceEstimates, by `Samuel Deslauriers-Gauthier`_, `Kostiantyn Maksymenko`_, `Nathalie Gayraud`_, `Ivana Kojcic`_, `Alex Gramfort`_, and `Eric Larson`_
mne.io.read_raw_edf now detects analog stim channels labeled 'STATUS' and sets them as stim channel. mne.io.read_raw_edf no longer synthesize TAL annotations into stim channel but stores them in raw.annotations when reading by `Joan Massich`_
Add mne.simulation.add_noise for ad-hoc noise addition to io.Raw, Epochs, and Evoked instances, by `Eric Larson`_
Add drop_refs=True parameter to set_bipolar_reference to drop/keep anode and cathode channels after applying the reference by `Cristóbal Moënne-Loccoz`_.
Add processing of reference MEG channels to mne.preprocessing.ICA by `Jevri Hanna`_
Add use of scipy.signal.windows.dpss for faster multitaper window computations in PSD functions by `Eric Larson`_
Add mne.morph_labels to facilitate morphing label sets obtained from parcellations, by `Eric Larson`_
Add mne.labels_to_stc to facilitate working with label data, by `Eric Larson`_
Add mne.label.select_sources to simplify the selection of sources within a label, by `Samuel Deslauriers-Gauthier`_
Add support for using mne.Info in mne.simulation.simulate_raw instead of mne.io.Raw by `Eric Larson`_
Add support for passing an iterable and stim channel values using stc parameter of mne.simulation.simulate_raw by `Eric Larson`_
Add overlap argument to mne.make_fixed_length_events by `Eric Larson`_
Add approximate distance-based spacing source space decimation algorithm to mne.setup_source_space by `Eric Larson`_
Add 448-labels subdivided aparc cortical parcellation by `Denis Engemann`_ and `Sheraz Khan`_
Add option to improve rendering in mne coreg for modern graphics cards by `Eric Larson`_
Add mne.preprocessing.mark_flat to automate marking of flat channels and segments of raw data by `Eric Larson`_
Add support for CUDA-based correlation computations and progress bars in mne.decoding.ReceptiveField by `Eric Larson`_
Add support for file-like objects in mne.io.read_raw_fif as long as preloading is used by `Eric Larson`_
Add keyboard shortcuts to nativate volume source estimates in time using (shift+)left/right arrow keys by `Mainak Jas`_
Add option to SSP preprocessing functions (e.g., mne.preprocessing.compute_proj_eog and mne.compute_proj_epochs) to process MEG channels jointly with meg='combined' by `Eric Larson`_
Add Epoch selection and metadata functionality to mne.time_frequency.EpochsTFR using new mixin class by `Keith Doelling`_
Add reject_by_annotation argument to mne.preprocessing.find_ecg_events by `Eric Larson`_
Add pca argument to return the rank-reduced whitener in mne.cov.compute_whitener by `Eric Larson`_
Add extrapolate argument to mne.viz.plot_topomap for better control of extrapolation points placement by `Mikołaj Magnuski`_
Add channel_wise argument to mne.io.Raw.apply_function to allow applying a function on multiple channels at once by `Hubert Banville`_
Add option copy='auto' to control data copying in mne.io.RawArray by `Eric Larson`_
The mri parameter in mne.setup_volume_source_space is now automatically set to T1.mgz if subject is provided. This allows to get a mne.SourceSpaces of kind volume more automatically. By `Alex Gramfort`_
Add better __repr__ for constants, and info['dig'] entries via DigPoint by `Eric Larson`_
Allow string argument in mne.io.Raw.drop_channels to remove a single channel by `Clemens Brunner`_
Add additional depth weighting options for inverse solvers (e.g., mne.inverse_sparse.gamma_map and mne.inverse_sparse.mixed_norm) by `Eric Larson`_
Add depth weighting to LCMV beamformers via depth argument in mne.beamformer.make_lcmv by `Eric Larson`_
Allow toggling of DC removal in mne.io.Raw.plot by pressing the 'd' key by `Clemens Brunner`_
Improved clicking in mne.io.Raw.plot (left click on trace toggles bad, left click on background sets green line, right click anywhere removes green line) by `Clemens Brunner`_
Add mne.realtime.LSLClient for realtime data acquisition with LSL streams of data by `Teon Brooks`_ and `Mainak Jas`_
Add partial support for PyVista as a 3D backend using mne.viz.use_3d_backend by `Guillaume Favelier`_
Add option ids = None in mne.event.shift_time_events for considering all events by `Nikolas Chalas`_ and `Joan Massich`_
Add mne.realtime.MockLSLStream to simulate an LSL stream for testing and examples by `Teon Brooks`_
Add support for file-like objects in mne.read_epochs as long as preloading is used by `Paul Roujansky`_
Fix annotations in split fif files mne.io.read_raw_fif by `Joan Massich`_
Fix mne.Epochs.plot with scalings='auto' to properly compute channel-wise scalings by `Stefan Repplinger`_
Fix mne.gui.coregistration and mne coreg crashing with segmentation fault when switching subjects by `Eric Larson`_
Fix mne.io.read_raw_brainvision to accommodate vmrk files which do not have any annotations by Alexander Kovrig
Fix mne.io.Raw.plot and mne.Epochs.plot to auto-scale misc channel types by default by `Eric Larson`_
Fix filtering functions (e.g., mne.io.Raw.filter) to properly take into account the two elements in n_pad parameter by `Bruno Nicenboim`_
Fix feature_names parameter change after fitting in mne.decoding.ReceptiveField by `Jean-Rémi King`_
Fix index error in mne.io.read_raw_cnt when creating stim_channel manually by `Joan Massich`_
Fix bug with weight_norm='unit-gain' in mne.beamformer.make_lcmv and mne.beamformer.make_dics by `Britta Westner`_
Fix 32bits annotations in mne.io.read_raw_cnt by `Joan Massich`_
Fix mne.events_from_annotations to ignore 'BAD_' and 'EDGE_' annotations by default using a new default regexp by `Eric Larson`_
Fix bug in mne.preprocessing.mark_flat where raw.first_samp was not taken into account by `Evgenii Kalenkovich`_
Fix date parsing in mne.io.read_raw_cnt by `Joan Massich`_
Fix topological checks and error messages for BEM surfaces in mne.make_bem_model by `Eric Larson`_
Fix default HTML language of mne.Report to be "en-us" instead of "fr" and allow setting via report.lang property by `Eric Larson`_
Fix bug where loading epochs with preload=True and subsequently using mne.Epochs.drop_bad with new reject or flat entries leads to improper data (and epochs.selection) since v0.16.0 by `Eric Larson`_. If your code uses Epochs(..., preload=True).drop_bad(reject=..., flat=...), we recommend regenerating these data.
Fix mne flash_bem to properly utilize flash30 images when conversion from DICOM images is used, and to properly deal with non-standard acquisition affines by `Eric Larson`_
Fix mne.io.Raw.set_annotations with annotations=None to create an empty annotations object with orig_time that matches the mne.io.Raw instance by `Eric Larson`_
Fix mne.io.read_raw_edf returning all the annotations with the same name in GDF files by `Joan Massich`_
Fix boundaries during plotting of raw data with mne.io.Raw.plot and mne browse_raw on scaled displays (e.g., macOS with HiDPI/Retina screens) by `Clemens Brunner`_
Fix bug where filtering was not performed with lowpass or highpass in mne.io.Raw.plot and mne browse_raw by `Eric Larson`_
Fix mne.simulation.simulate_evoked that was failing to simulate the noise with heterogeneous sensor types due to poor conditioning of the noise covariance and make sure the projections from the noise covariance are taken into account `Alex Gramfort`_
Fix checking of data dimensionality in mne.SourceEstimate and related constructors by `Eric Larson`_
Fix mne.io.Raw.append annotations miss-alignment by `Joan Massich`_
Fix hash bug in the mne.io.edf module when installing on Windows by `Eric Larson`_
Fix mne.io.read_raw_edf reading duplicate channel names by `Larry Eisenman`_
Fix set_bipolar_reference in the case of generating all bipolar combinations and also in the case of repeated channels in both lists (anode and cathode) by `Cristóbal Moënne-Loccoz`_
Fix missing code for computing the median when method='median' in mne.Epochs.average by `Cristóbal Moënne-Loccoz`_
Fix CTF helmet plotting in mne.viz.plot_evoked_field by `Eric Larson`_
Fix saving of rejection parameters in mne.Epochs.save by `Eric Larson`_
Fix orientations returned by mne.dipole.get_phantom_dipoles (half were flipped 180 degrees) by `Eric Larson`_
Fix bug in mne.viz.plot_compare_evokeds when evoked.times[0] >= 0 would cause a problem with vlines='auto' mode by `Eric Larson`_
Fix path bugs in mne.bem.make_flash_bem and mne flash_bem by `Eric Larson`_
Fix mne.time_frequency.AverageTFR.plot_joint mishandling bad channels, by `David Haslacher`_ and `Jona Sassenhagen`_
Fix mne.beamformer.make_lcmv failing when full rank data is used (i.e., when no projection is done) with reg=0., by `Eric Larson`_
Fix issue with bad channels ignored in mne.beamformer.make_lcmv and mne.beamformer.make_dics by `Alex Gramfort`_
Fix mne.compute_proj_raw when duration != None not to apply existing proj and to avoid using duplicate raw data samples by `Eric Larson`_
Fix reject_by_annotation not being passed internally by mne.preprocessing.create_ecg_epochs and mne clean_eog_ecg to mne.preprocessing.find_ecg_events by `Eric Larson`_
Fix mne.io.read_raw_edf failing when EDF header fields (such as patient name) contained special characters, by `Clemens Brunner`_
Fix mne.io.read_raw_eeglab incorrectly parsing event durations by `Clemens Brunner`_
Fix mne.io.read_raw_egi when cropping non-preloaded EGI MFF data by `Alex Gramfort`_
Fix mne.io.Raw.interpolate_bads for interpolating CTF MEG channels when reference sensors are present by `Johannes Kasper`_
Fix a bug in mne.io.Raw.resample, where resampling events could result in indices > n_times-1, by `Johannes Kasper`_
Fix mne.preprocessing.ICA.score_sources to use the sfreq of the raw data to filter rather than the sfreq when the ICA was fit, by `Johannes Kasper`_
Fix a bug in mne.preprocessing.ICA, where manually setting the attribute ICA.exclude to an np.array resulted in the removal of random components when later also providing the exclude argument to any apply...-method, by `Johannes Kasper`_
Ascending changed to descending sorting of scores for integer ..._criterion arguments in mne.preprocessing.ICA.detect_artifacts and mne.preprocessing.run_ica, as it used to be documented; the docstring in these functions was corrected for float ..._criterion arguments, by `Johannes Kasper`_
Deprecate cov, iir_params, blink, ecg, chpi, random_state and support for mne.io.Raw instance inputs in mne.simulation.simulate_raw; use mne.simulation.add_noise, mne.simulation.add_ecg, mne.simulation.add_eog, and mne.simulation.add_chpi by `Eric Larson`_
Add overwrite parameter in mne.Epochs.save by `Katarina Slama`_
Add stim_channel parameter in mne.io.read_raw_cnt to toggle stim channel synthesis by `Joan Massich`_
Python 2 is no longer supported; MNE-Python now requires Python 3.5+, by `Eric Larson`_
A new class mne.VolVectorSourceEstimate is returned by mne.minimum_norm.apply_inverse (and related functions) when a volume source space and pick_ori='vector' is used, by `Eric Larson`_
Converting a forward solution with a volume source space to fixed orientation using mne.convert_forward_solution now raises an error, by `Eric Larson`_
raw.estimate_rank has been deprecated and will be removed in 0.19 in favor of mne.compute_rank by `Eric Larson`_
Annotations are now kept sorted (by onset time) during instantiation and ~Annotations.append operations, by `Eric Larson`_
Deprecate mne.io.find_edf_events by `Joan Massich`_
Deprecate limit_depth_chs in mne.minimum_norm.make_inverse_operator in favor of depth=dict(limit_depth_chs=...) by `Eric Larson`_
Reading BDF and GDF files with mne.io.read_raw_edf is deprecated and replaced by mne.io.read_raw_bdf and mne.io.read_raw_gdf, by `Clemens Brunner`_
mne.forward.compute_depth_prior has been reworked to operate directly on Forward instance as forward rather than a representation scattered across the parameters G, is_fixed_ori, patch_info, by `Eric Larson`_
Deprecate method='extended-infomax' in mne.preprocessing.ICA; Extended Infomax can now be computed with method='infomax' and fit_params=dict(extended=True) by `Clemens Brunner`_
Fix support for supplying extrapolate via ica.plot_properties(..., topomap_args=dict(extrapolate=...)) by `Sebastián Castaño-Candamil`_
The peak finder that was formerly accessible via from mne.preprocessing.peak_finder import peak_finder should now be imported directly from the enclosing namespace as from mne.preprocessing import peak_finder by `Eric Larson`_
Deprecate mne.realtime module to make a standalone module mne-realtime that will live outside of this package by `Teon Brooks`_
Nothing published for this version
One column per quarter.