Version 0.12 (2016-05-10)#
Changelog#
Add
overlay_timesparameter tomne.viz.plot_epochs_image()to be able to display for example reaction times on top of the images, by Alex GramfortAnimation for evoked topomap in
mne.Evoked.animate_topomap()by Jaakko LeppakangasMake
mne.channels.find_layout()more robust for KIT systems in the presence of bad or missing channels by Jaakko LeppakangasAdd raw movement compensation to
mne.preprocessing.maxwell_filter()by Eric LarsonAdd
mne.Annotationsfor for annotating segments of raw data by Jaakko LeppakangasAdd reading of .fif file montages by Eric Larson
Add system config utility
mne.sys_info()by Eric LarsonAutomatic cross-validation and scoring metrics in
mne.decoding.GeneralizationAcrossTime, by Jean-Rémi Kingmne.decoding.GeneralizationAcrossTimeaccepts non-deterministic cross-validations, by Jean-Rémi KingAdd plotting RMS of gradiometer pairs in
mne.viz.plot_evoked_topo()by Jaakko LeppakangasAdd regularization methods to
mne.compute_raw_covariance()by Eric Larson.Add command
mne show_infoto quickly show the measurement info from a .fif file from the terminal by Alex Gramfort.Add creating forward operator for dipole object
mne.make_forward_dipole()by Chris BaileyAdd reading and estimation of fixed-position dipole time courses (similar to Elekta
xfit) usingmne.read_dipole()andmne.fit_dipole()by Eric Larson.Accept
mne.decoding.GeneralizationAcrossTime’sscorerparameter to be a string that refers to a scikit-learn metric scorer by Asish Panda.Add method
mne.Epochs.plot_image()callingmne.viz.plot_epochs_image()for better usability by Asish Panda.Add
mne.io.read_raw_cnt()for reading Neuroscan CNT files by Jaakko LeppakangasAdd
decimparameter tomne.time_frequency.cwt_morlet, by Jean-Rémi KingAdd method
mne.Epochs.plot_topo_image()by Jaakko LeppakangasAdd the ability to read events when importing raw EEGLAB files, by Jona Sassenhagen.
Add function
mne.viz.plot_sensors()and methodsmne.Epochs.plot_sensors(),mne.io.Raw.plot_sensors()andmne.Evoked.plot_sensors()for plotting sensor positions andmne.viz.plot_layout()andmne.channels.Layout.plot()for plotting layouts by Jaakko LeppakangasAdd epoch rejection based on annotated segments by Jaakko Leppakangas
Add option to use new-style MEG channel names in
mne.read_selectionby Eric LarsonAdd option for
projinmne.EpochsArrayby Eric LarsonEnable the usage of
mne.viz.plot_topomap()with anmne.Infoinstance for location information, by Jona Sassenhagen.Add support for electrocorticography (ECoG) channel type by Eric Larson
Add option for
first_sampinmne.make_fixed_length_events()by Jon HouckAdd ability to auto-scale channel types for
mne.viz.plot_raw()andmne.viz.plot_epochs()and corresponding object plotting methods by Chris Holdgraf
BUG#
mne.time_frequency.compute_raw_psd,mne.time_frequency.compute_epochs_psd,mne.time_frequency.psd_multitaper, andmne.time_frequency.psd_welchno longer remove rows/columns of the SSP matrix before applying SSP projectors when picks are provided by Chris Holdgraf.mne.Epochs.plot_psd()no longer calls a Welch PSD, and instead uses a Multitaper method which is more appropriate for epochs. Flags for this function are passed tomne.time_frequency.psd_multitaperby Chris HoldgrafTime-cropping functions (e.g.,
mne.Epochs.crop(),mne.Evoked.crop(),mne.io.Raw.crop(),mne.SourceEstimate.crop()) made consistent with behavior oftminandtmaxofmne.Epochs, where nearest sample is kept. For example, for MGH data acquired withsfreq=600.614990234, constructingEpochs(..., tmin=-1, tmax=1)has bounds+/-1.00064103, and nowepochs.crop(-1, 1)will also have these bounds (previously they would have been+/-0.99897607). Time cropping functions also no longer use relative tolerances when determining the boundaries. These changes have minor effects on functions that use cropping under the hood, such asmne.compute_covariance()andmne.connectivity.spectral_connectivity. Changes by Jaakko Leppakangas and Eric LarsonFix EEG spherical spline interpolation code to account for average reference by Mainak Jas
MEG projectors are removed after Maxwell filtering by Eric Larson
Fix
mne.decoding.TimeDecodingto allow specifyingclfby Jean-Rémi KingFix bug with units (uV) in ‘Brain Vision Data Exchange Header File Version 1.0’ by Federico Raimondo
Fix bug where
mne.preprocessing.maxwell_filter()destinationparameter did not properly set device-to-head transform by Eric LarsonFix bug in rank calculation of
mne.utils.estimate_rank,mne.io.Raw.estimate_rank, and covariance functions where the tolerance was set to slightly too small a value, new ‘auto’ mode uses values fromscipy.linalg.orthby Eric Larson.Fix bug when specifying irregular
train_times['slices']inmne.decoding.GeneralizationAcrossTime, by Jean-Rémi KingFix colorbar range on norm data by Jaakko Leppakangas
Fix bug in
mne.preprocessing.run_ica, which used theecg_criterionparameter for the EOG criterion instead ofeog_criterionby Christian BrodbeckFix normals in CTF data reader by Eric Larson
Fix bug in
mne.io.read_raw_ctf(), when omitting samples at the end by Jaakko LeppakangasFix
info['lowpass']value for downsampled raw data by Eric LarsonRemove measurement date from
mne.Infoinmne.io.Raw.anonymize()by Eric LarsonFix bug that caused synthetic ecg channel creation even if channel was specified for ECG peak detection in
mne.preprocessing.create_ecg_epochs()by Jaakko LeppakangasFix bug with vmin and vmax when None is passed in
mne.viz.plot_topo_image_epochs()by Jaakko LeppakangasFix bug with
mne.label_sign_flip()(andmne.extract_label_time_course()) by Natalie Klein and Eric LarsonAdd copy parameter in
mne.Epochs.apply_baseline()andmne.io.Raw.filter()methods by Jona Sassenhagen and Alex GramfortFix bug in
mne.merge_events()when usingreplace_events=Falseby Alex GramfortFix bug in
mne.Evokedtype setting inmne.stats.linear_regression_raw()by Eric LarsonFix bug in
mne.io.edf.RawEDFhighpass filter setting to take max highpass to match warning message by Teon BrooksFix bugs with coordinane frame adjustments in
mne.viz.plot_transby Eric LarsonFix bug in colormap selection in
mne.Evoked.plot_projs_topomap()by Jaakko LeppakangasFix bug in source normal adjustment that occurred when 1) patch information is available (e.g., when distances have been calculated) and 2) points are excluded from the source space (by inner skull distance) by Eric Larson
Fix bug when merging info that has a field with list of dicts by Jaakko Leppakangas
The BTi/4D reader now considers user defined channel labels instead of the hard-ware names, however only for channels other than MEG. By Denis Engemann and Alex Gramfort.
The BTi reader
mne.io.read_raw_bti()can now read 2500 system data, by Eric LarsonFix bug in
mne.compute_raw_covariance()where rejection by non-data channels (e.g. EOG) was not done properly by Eric Larson.Change default scoring method of
mne.decoding.GeneralizationAcrossTimeandmne.decoding.TimeDecodingto estimate the scores within the cross-validation as in scikit-learn as opposed to across all cross-validatedy_pred. The method can be changed with thescore_modeparameter by Jean-Rémi KingFix bug in
mne.io.Raw.save()where, in rare cases, automatically split files could end up writing an extra empty file that wouldn’t be read properly by Eric LarsonFix
mne.realtime.StimServerby removing superfluous argumentipused while initializing the object by Mainak Jas.Fix removal of projectors in
mne.preprocessing.maxwell_filter()inst_only=Truemode by Eric Larson
API#
The default
picks=Noneinmne.viz.plot_epochs_image()now only plots the first 5 channels, not all channels, by Jona SassenhagenThe
mesh_colorparameter inmne.viz.plot_dipole_locations()has been removed (usebrain_colorinstead), by Marijn van VlietDeprecated functions
mne.time_frequency.compute_raw_psdandmne.time_frequency.compute_epochs_psd, replaced bymne.time_frequency.psd_welchby Chris HoldgrafDeprecated function
mne.time_frequency.multitaper_psdand replaced bymne.time_frequency.psd_multitaperby Chris HoldgrafThe
y_predattribute inmne.decoding.GeneralizationAcrossTimeandmne.decoding.TimeDecodingis now a numpy array, by Jean-Rémi KingThe
mne.bem.fit_sphere_to_headshape()function now default todig_kinds='auto'which will use extra digitization points, falling back to extra plus eeg digitization points if there not enough extra points are available.The
mne.bem.fit_sphere_to_headshape()now has aunitsargument that should be set explicitly. This will default tounits='mm'in 0.12 for backward compatibility but change tounits='m'in 0.13.Added default parameters in Epochs class namely
event_id=None,tmin=-0.2andtmax=0.5.To unify and extend the behavior of
mne.compute_raw_covariance()relative tomne.compute_covariance(), the default parametertstep=0.2now discards any epochs at the end of themne.io.Rawinstance that are not the fulltstepduration. This will slightly change the computation ofmne.compute_raw_covariance(), but should only potentially have a big impact if themne.io.Rawinstance is short relative totstepand the last, too short (now discarded) epoch contained data inconsistent with the epochs that preceded it.The default
picks=Noneinmne.io.Raw.filter()now picks eeg, meg, seeg, and ecog channels, by Jean-Rémi King and Eric LarsonEOG, ECG and EMG channels are now plotted by default (if present in data) when using
mne.viz.plot_evoked()by Marijn van VlietReplace pseudoinverse-based solver with much faster Cholesky solver in
mne.stats.linear_regression_raw(), by Jona Sassenhagen.CTF data reader now reads EEG locations from .pos file as HPI points by Jaakko Leppakangas
Subselecting channels can now emit a warning if many channels have been subselected from projection vectors. We recommend only computing projection vertors for and applying projectors to channels that will be used in the final analysis. However, after picking a subset of channels, projection vectors can be renormalized with
mne.Info.normalize_proj()if necessary to avoid warnings about subselection. Changes by Eric Larson and Alex Gramfort.Rename and deprecate
mne.Epochs.drop_bad_epochstomne.Epochs.drop_bad(), andmne.Epochs.drop_epochstomne.Epochs.drop()by Alex Gramfort.The C wrapper
mne.do_forward_solutionhas been deprecated in favor of the native Python versionmne.make_forward_solution()by Eric LarsonThe
eventsparameter ofmne.EpochsArray()is set by default to chronological time-samples and event values to 1, by Jean-Rémi King