Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Graveyard/BESA_(outdated).md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ version of BESA we used to compare with Dipfit was BESA 3.0 which was
likely release before 1998 since it was released before BESA 99 (in
1999).

Our implementation in Dipfit (and Fieldtrip) was programmed by Robert
Our implementation in Dipfit (and FieldTrip) was programmed by Robert
Oostenveld and is based on the Habilschrift (sort of advanced PhD thesis
that only exists in Germany) from Bernd Lutkenhoner from 1992. That
habilschrift is not available in pdf or online, but Robert Oostenveld
Expand Down
8 changes: 4 additions & 4 deletions Graveyard/Compiling_EEGLAB_Technical_note_for_developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ git clone --recurse-submodules https://github.com/sccn/eeglab.git

2\. Install additional plugins (plugins that are already installed will
be skipped). Some folders from the plug-ins clean_rawdata
(**manopt/reference/m2html**) and Fieldtrip (**compat**,
(**manopt/reference/m2html**) and FieldTrip (**compat**,
**external/afni**, **external/spm8**, **external/spm12**,
**external/gifti**, **external/eeglab** and **external/bemcp**) should
be removed to avoid compilation issues. Do not use the GIT repo to
Expand All @@ -322,7 +322,7 @@ plugin_askinstall('bva-io', 'eegplugin_bva_io', true);
plugin_askinstall('clean_rawdata', 'eegplugin_clean_rawdata', true);
plugin_askinstall('dipfit', 'eegplugin_dipfit', true);
plugin_askinstall('egilegacy', 'eegplugin_egilegacy', true);
plugin_askinstall('Fieldtrip-lite', 'ft_defaults', true);
plugin_askinstall(' Fieldtrip-lite', 'ft_defaults', true);
plugin_askinstall('Fileio', 'ft_read_data', true);
plugin_askinstall('firfilt', 'eegplugin_firfilt', true);
plugin_askinstall('IClabel', 'eegplugin_iclabel', true);
Expand All @@ -339,7 +339,7 @@ CleanRawData_folder = fileparts(which('clean_rawdata.m'));
rmdir(fullfile(CleanRawData_folder,'manopt','reference','m2html'), 's');

% Removing FieldTrip files
% For Fieldtrip remove folders compat, external/afni, external/spm8, external/spm12, external/gifti, external/eeglab, external/bemcp and external/npmk
% For FieldTrip remove folders compat, external/afni, external/spm8, external/spm12, external/gifti, external/eeglab, external/bemcp and external/npmk
FieldTrip_folder = fileparts(which('ft_defaults.m'));
rmdir(fullfile(FieldTrip_folder,'compat'), 's');
rmdir(fullfile(FieldTrip_folder,'external','afni'), 's');
Expand Down Expand Up @@ -384,6 +384,6 @@ next release.

| Plugin name | Comment |
|-------------------|-------------------------------------------------------------------------------------------------------|
| Biosig | Not necessary because included in Fieldtrip |
| Biosig | Not necessary because included in FieldTrip |
| MFFMatlabIO | Issue with finding the JAR file at execution time; more debugging necessary before inclusion possible |
| bids-matlab-tools | Not tested |
2 changes: 1 addition & 1 deletion Graveyard/Using_custom_MRI_from_individual_subjects.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ noisy because of the renormalization process used in SPM2.

If you use
other software to perform the normalization, EEGLAB should be able to
read the output image using the Fieldtrip function *read_fcdc_mri.m* to
read the output image using the FieldTrip function *read_fcdc_mri.m* to
import various MRI data formats.


Expand Down
2 changes: 1 addition & 1 deletion Graveyard/dipfit_ctf.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ dipole positions before comparing them. These operations need to be
executed outside EEGLAB. A test set is available
[here](http://sccn.ucsd.edu/eeglab/dipfittut/testmeg.zip) (thanks to Nicolas
Robitaille for providing the test data). Simply load
the test file and follow the instruction above (note that newer versions of Fieldtrip cannot process this file anymore, so use Fieldtrip versions up to 2016).
the test file and follow the instruction above (note that newer versions of FieldTrip cannot process this file anymore, so use FieldTrip versions up to 2016).
2 changes: 1 addition & 1 deletion index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Other type of documentation are listed below.
- [EEGLAB reference articles - Please cite](/others/EEGLAB_References.html)
- [Quick ICA Component Rejection Tutorial](/tutorials/misc/Quick_Tutorial_on_Rejection.html)
- [Using EEGLAB vs. Commercial EEG Software](/others/EEGLAB_vs_Commercial_EEG_Software.html)
- [Working with EEGLAB and Fieldtrip](/others/EEGLAB_and_Fieldtrip.html)
- [Working with EEGLAB and FieldTrip](/others/EEGLAB_and_FieldTrip.html)
- [Using EEGLAB on open-source Octave](/others/Running_EEGLAB_on_Octave.html)
- [Using EEGLAB on high performance computing resources](/others/EEGLAB_and_high_performance_computing.html)
- [EEGLAB on MATLAB versus Python](/others/EEGLAB_and_python.html)
Expand Down
10 changes: 5 additions & 5 deletions others/Compiled_EEGLAB.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,16 +205,16 @@ git clone --recurse-submodules https://github.com/sccn/eeglab.git

2. Install additional plugins (already installed plugins will
be skipped). Some folders from the plugins clean_rawdata
and Fieldtrip should
be removed to avoid compilation issues. **Do not use the GIT version of Fieldtrip.** as it makes the release 1.5Gb instead of 200Mb. Instead get the latest plugin. Use the
and FieldTrip should
be removed to avoid compilation issues. **Do not use the GIT version of FieldTrip.** as it makes the release 1.5Gb instead of 200Mb. Instead get the latest plugin. Use the
following script to install plugins and remove these folders:

```matlab
eeglab % restart the fleshly installed eeglab

% Installing plugins
plugin_askinstall('ANTeepimport', 'eegplugin_eepimport', true);
plugin_askinstall('Fieldtrip-lite', 'ft_defaults', true);
plugin_askinstall(' Fieldtrip-lite', 'ft_defaults', true);
plugin_askinstall('Fileio', 'ft_read_data', true);
plugin_askinstall('IClabel', 'eegplugin_iclabel', true);
plugin_askinstall('PICARD', 'picard', true);
Expand Down Expand Up @@ -247,7 +247,7 @@ iclabel_folder = fileparts(which('iclabel.m'));
% rmdir(fullfile(iclabel_folder,'matconvnet','examples'), 's'); % not there any more?

% Removing FieldTrip files
% For Fieldtrip remove folders compat, external/afni, external/spm8, external/spm12, external/gifti, external/eeglab, external/bemcp and external/npmk
% For FieldTrip remove folders compat, external/afni, external/spm8, external/spm12, external/gifti, external/eeglab, external/bemcp and external/npmk
FieldTrip_folder = fileparts(which('ft_defaults.m'));
rmdir(fullfile(FieldTrip_folder,'compat'), 's');
rmdir(fullfile(FieldTrip_folder,'external','afni'), 's');
Expand Down Expand Up @@ -314,6 +314,6 @@ Adding new plugins

| Plugin name | Comment |
|-------------------|-------------------------------------------------------------------------------------------------------|
| Biosig | Path issue for compiler. Using the version included in Fieldtrip |
| Biosig | Path issue for compiler. Using the version included in FieldTrip |
| MFFMatlabIO | Issue with finding the JAR file at execution time; more debugging necessary before inclusion possible |
| bids-matlab-tools | Not tested |
4 changes: 2 additions & 2 deletions others/EEGLAB_Bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ to be recompiled, something you can sometimes do yourself - for more
information, see below). There are mainly four modules in EEGLAB that use mex
files.

- Fieldtrip functions: If you get an error that some functions in the
Fieldtrip folder cannot be found, refer to the [Fieldtrip
- FieldTrip functions: If you get an error that some functions in the
FieldTrip folder cannot be found, refer to the [FieldTrip
documentation](https://www.fieldtriptoolbox.org/faq/matlab_complains_about_a_missing_or_invalid_mex_file_what_should_i_do/)
for how to recompile such functions.

Expand Down
2 changes: 1 addition & 1 deletion others/EEGLAB_Extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ We only include the most popular ones below.

### Statistics and signal processing

- **[Fieldtrip-lite](https://github.com/fieldtrip/fieldtrip):** Fieldtrip is a stand-alone toolbox but may also act as an EEGLAB extension providing source localization methods and additional statistical methods.
- **[ Fieldtrip-lite](https://github.com/fieldtrip/fieldtrip):** FieldTrip is a stand-alone toolbox but may also act as an EEGLAB extension providing source localization methods and additional statistical methods.

- **[LIMO](https://github.com/LIMO-EEG-Toolbox/limo_tools):** The LInear MOdelling of MEEG data (LIMO MEEG) toolbox is an EEGLAB plugin dedicated to the statistical analysis of MEEG data.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion others/EEGLAB_and_python.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ sometimes hard to manipulate figures, impossible to zoom, etc...).
Most people who are used to Matlab and tried
Jupyter notebooks dislike Jupyter notebooks - then learn to live with the
limitations if they need it for their work. By contrast, the less popular [Spyder IDE](https://www.spyder-ide.org/) is a decent equivalent of the MATLAB graphical interface and should feel more familiar.
- **Lack of features.** MEEG software packages on MATLAB are mainly EEGLAB, Fieldtrip, and
- **Lack of features.** MEEG software packages on MATLAB are mainly EEGLAB, FieldTrip, and
Brainstorm. MEEG software on Python is MNE which is more tailored to MEG users than EEG users.
The MATLAB suite of available software is currently more mature than
the Python one, which is a good reason to stick to MATLAB. EEGLAB has 32 plugins for automated artifact rejections. MNE has one (autoreject).
Expand Down
8 changes: 4 additions & 4 deletions others/EEGLAB_revision_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Previous major EEGLAB versions (e.g., versions 13, 14, etc.) did not use this na
- **New feature**: Limit the number of displayed datasets to speed up display when processing more than 200 datasets.
- **New feature**: Change all function headers for better MATLAB interoperability (capitalize all function names, etc...).
- **Interoperability**: New function brainstorm2eeglab.m to import Brainstorm data epochs.
- **Interoperability**: Improved function fieldtrip2eeglab.m to convert Fieldtrip data structures. Update to pop_fileio to import MEG metadata.
- **Interoperability**: Improved function fieldtrip2eeglab.m to convert FieldTrip data structures. Update to pop_fileio to import MEG metadata.
- **Interoperability**: More command-line options to import files using BIOSIG.
- **Bug fix**: Better handling of boundary events (especially the ones at the beginning and end of the data).
- **Bug fix**: Better detection when a dataset is modified by the user in the global workspace.
Expand All @@ -135,7 +135,7 @@ Previous major EEGLAB versions (e.g., versions 13, 14, etc.) did not use this na
- **Version statistics**: 104 files changed, 4,411 insertions, 421 deletions.
- **Major interoperability change**: Allow using event type -99 for discontinuities and improve ERPLAB compatibility (20 functions modified). The default is still to use 'boundary' for event boundary, but the default can be changed in the EEGLAB preferences when processing numerical event types.
- **Interoperability**: Added 4 new parameters to import data with BIOSIG toolbox, in particular for EDF and BDF files.
- **Interoperability**: Increased compatibility for Fieldtrip dataset conversion back and forth, in particular for electrode coordinates.
- **Interoperability**: Increased compatibility for FieldTrip dataset conversion back and forth, in particular for electrode coordinates.
- **Interoperability**: Fix processing data from multiple sessions for LIMO.
- **Group analysis**: Allow fusing channel rejection across datasets of the same subject and session.
- **Bug fix**: Fix concatenating datasets of the same size.
Expand All @@ -153,7 +153,7 @@ Previous major EEGLAB versions (e.g., versions 13, 14, etc.) did not use this na
- **Bug fix**: Fix study issue when parallel toolbox is absent (GCP error)
- **Bug fix**: Fix rare bug when writing two files for an EEGLAB dataset (old default; the new default since 2021 is to write a single .set file)
- **Bug fix**: Fix plotting ERPimage for ICA component clusters
- **Interoperability**: Improved Fieldtrip bidirectional conversion for data trials
- **Interoperability**: Improved FieldTrip bidirectional conversion for data trials
- **Interoperability**: Improved LIMO compatibility issues when processing a study with multiple sessions
- **Speed increase**: Speed up IDing user profile and speed up eeg_checkset by 2 orders of magnitude
- **EDF files**: Exporting EDF files now use a common limit for all channels; fix importing channel labels with EEG prefix in EDF files
Expand Down Expand Up @@ -188,7 +188,7 @@ Previous major EEGLAB versions (e.g., versions 13, 14, etc.) did not use this na
- **Channel selection**: Now allows selecting channel subsets by label in all GUIs.
- **Channel location**: Now using the BEM-model channel scalp locations as the default for looking up channel locations by labels (instead of using the BESA spherical head model)
- **Plug-in support**: Now allowing plug-ins to be placed in the *plugins* subfolder of the current Matlab path
- **Interoperability**: Improved support for Matlab 2020 versions and for Octave, Fieldtrip, and LIMO
- **Interoperability**: Improved support for Matlab 2020 versions and for Octave, FieldTrip, and LIMO
- **Menu structure**: Now hiding a rarely used menu item to compare datasets by default
- Use this [Github link](https://github.com/sccn/eeglab/compare/eeglab2020.0..eeglab2020.1) to see all changes compared to the previous EEGLAB version.

Expand Down
2 changes: 1 addition & 1 deletion others/Firfilt_FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ For filter order = 1650 -> N = 1651 samples (N taps = filter length = filter ord

### Q. Does the _firfilt_ function automatically delay-correct if I choose to do the non-causal linear filter?

Yes, firfilt automatically corrects for the group delay, that is, implements a zero-phase FIR filter. But firfilt is a low-level function and you should know what you are doing when using it. If you want to do this on the command line I would rather recommend using fir_filterdcpadded. There is a 'causal‘ flag and you can do causal and non-causal (linear phase only) filtering. fir_filterdcpadded must be used with continuous segments only. firfilt also works with boundaries. firfilt was designed long time ago when memory was a limited resource and is memory optimized but complex. It will be sooner than later be fully replaced by fir_filterdcpadded (as in Fieldtrip) which is simple and fast but memory consuming.
Yes, firfilt automatically corrects for the group delay, that is, implements a zero-phase FIR filter. But firfilt is a low-level function and you should know what you are doing when using it. If you want to do this on the command line I would rather recommend using fir_filterdcpadded. There is a 'causal‘ flag and you can do causal and non-causal (linear phase only) filtering. fir_filterdcpadded must be used with continuous segments only. firfilt also works with boundaries. firfilt was designed long time ago when memory was a limited resource and is memory optimized but complex. It will be sooner than later be fully replaced by fir_filterdcpadded (as in FieldTrip) which is simple and fast but memory consuming.
Note: fir_filterdcpadded always operates (pads, filters) along first dimension.
So, with EEG.data (chans x times) it is necessary to transpose (twice):
```matlab
Expand Down
2 changes: 1 addition & 1 deletion plugins/EEG-BIDS/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Refer to the [wiki documentation](https://github.com/sccn/EEG-BIDS/wiki) or the

[ezBIDS](https://brainlife.io/ezbids/) is a data export tool for MRI and fMRI data. It does not allow to export EEG data to our knowledge.

[data2bids.m](https://www.fieldtriptoolbox.org/example/bids/) is a Fieldtrip function to export BIDS data. This includes EEG and maybe fMRI. This function can only be used from the command line.
[data2bids.m](https://www.fieldtriptoolbox.org/example/bids/) is a FieldTrip function to export BIDS data. This includes EEG and maybe fMRI. This function can only be used from the command line.

[EEG-BIDS](https://github.com/sccn/EEG-BIDS) (this program) is the most popular tool to export EEG data using both a graphical interface and/or command line (more than half of the BIDS datasets on OpenNeuro were exported using EEG-BIDS and it has more than 2200 installs in EEGLAB). A compiled stand-alone version will also be released soon.

Expand Down
2 changes: 1 addition & 1 deletion plugins/ICLabel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You will find the category is "eye."
![](Viewprops_eye.png)
The ICLabel plugin offers no built-in plotting or visualization; therefore, it is highly suggested that you also install the [Viewprops plug-in](https://sccn.ucsd.edu/wiki/Viewprops). It will produce figures like the one shown at the top of this article. See the [Installation](https://sccn.ucsd.edu/wiki/ICLabel#Installation) section for directions on how to acquire the [Viewprops plug-in](https://sccn.ucsd.edu/wiki/Viewprops) and see [its wiki page](https://sccn.ucsd.edu/wiki/Viewprops) for information on how to use it.

### Run ICLabel in Fieldtrip
### Run ICLabel in FieldTrip

First install EEGLAB (it includes the ICLabel plugin by default). Then use the script below.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ parent: MFF-matlab-io
grand_parent: Plugins
render_with_liquid: false

title: 5.-Use-with-Fieldtrip
long_title: 5.-Use-with-Fieldtrip
title: 5.-Use-with-FieldTrip
long_title: 5.-Use-with-FieldTrip
---
MFFMatlabIO is now the default import program for MFF files in Fieldtrip.
MFFMatlabIO is now the default import program for MFF files in FieldTrip.

First download the latest version of [Fieldtrip](http://www.fieldtriptoolbox.org/download)
First download the latest version of [FieldTrip](http://www.fieldtriptoolbox.org/download)

Then, download the [MFF test file](NIA_333ms_HCGSN32_test01.mff.zip "MFF file") and unzip it. Start a Matlab session.

Make sure that the Fieldtrip main folder is in your path and that the folder _NIA_333ms_HCGSN32_test01.mff_ (which you have downloaded above) is in your current Matlab path. On the Matlab command line type
Make sure that the FieldTrip main folder is in your path and that the folder _NIA_333ms_HCGSN32_test01.mff_ (which you have downloaded above) is in your current Matlab path. On the Matlab command line type

```matlab
hdr = ft_read_header(fullfile(pwd, 'NIA_333ms_HCGSN32_test01.mff'));
Expand All @@ -27,7 +27,7 @@ Plot and check the data
figure; plot(data(:,1:1000)' + repmat([1:size(data,1)]*100, [1000 1]));
```

![](Fieldtrip_data_plot.png)
![](FieldTrip_data_plot.png)

Writing the data back to MFF format

Expand Down
2 changes: 1 addition & 1 deletion plugins/MFF-matlab-io/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Version 3.5
- Now import subject information into EEGLAB

Version 3.4
- Fixes issues associated with reading data under Fieldtrip
- Fixes issues associated with reading data under FieldTrip

Version 3.3
- Fix reading on Windows
Expand Down
Loading