What are the MATLAB and external requirements?
We try to develop FieldTrip in such a way that it works with the latest MATLAB release on the most popular operating system platforms, but at the same time we try to have it work with as many older MATLAB versions as possible.
However, the MATLAB syntax and the availability of functions in the standard MathWorks toolboxes changes over time. Consequently, sometimes we will use MATLAB code that is only supported from a certain version upwards. In general we attempt to support MATLAB versions up to 5 years old.
An online poll in April 2011 showed that a large proportion (>98%) of our users access the FieldTrip toolbox with a MATLAB version younger than 2006 (<5 years). The full results can be found here.
MATLAB includes a large number of functions in standard toolboxes that come with every installation, but certain functions are included in additional (commercial) toolboxes from MathWorks, such as the Signal Processing or the Statistics toolbox. Whether you need to buy these toolboxes depends on whether you want to use specific functionality in FieldTrip. We try to avoid using these additional MathWorks toolboxes to the extent that we will look for alternatives (e.g. from GNU Octave) or use drop-in replacement functions for certain functions, as long as the time required to implement these alternatives is not too large.
The following functions depend on the MathWorks Image Processing Toolbox
The following functions depend on the MathWorks Optimization Toolbox
The following functions depend on the MathWorks Signal Processing Toolbox
The following functions depend on the MathWorks Statistics and Machine Learning Toolbox
Besides the non-free MathWorks toolboxes that are used by some functions, FieldTrip also makes use of other free toolboxes for certain functionality, such as access to specific file formats. Using these external toolboxes allows us to focus on specifically improving FieldTrip and to join forces with other open source software projects. Whether you need these non-commercial external toolboxes depends on the data formats that you will use and whether you want to use their specific functionality. Most of these are also developed as open source projects and they all can be downloaded from the internet. Some of them are not open source, but can be redistributed in compiled form (e.g. mex files, p-files, compiled binaries). There are also certain toolboxes that FieldTrip can use which have even more strict copyright restrictions attached (e.g. signing a Non-Disclosure Agreement), which we are not allowed to redistribute.
A considerable number of external toolboxes is included in the FieldTrip release zip file inside the “fieldtrip/external” subdirectory. These include
- afni MATLAB functions (to read AFNI data)
- biosig (to read various EEG file formats)
- eeglab (only for independent component analysis)
- megdp (to read Neuromag fif data)
- spm2 (to read some MRI formats, for spatial normalization and segmentation)
- spm8 (to read some MRI formats, for spatial normalization and segmentation)
- spm12 (to read some MRI formats, for spatial normalization and segmentation)
- ctf (to read CTF data)
- mne (to read Neuromag fif data)
- yokogawa (to read data from the Yokogawa MEG system)
- dipoli (for forward EEG modeling using BEM)
- simbio (for forward EEG modeling using FEM)
Although we distribute these toolboxes along with FieldTrip to facilitate their use, we do not develop or support them. Each of the corresponding toolboxes has its own license agreement, and in the corresponding directories you can find more information on who is responsible for them.
The following toolboxes are also used for specific computations, but are not included in the default FieldTrip release. You can download them separately and place them in the “fieldtrip/external” directory (where they will be automatically found) or anywhere else on your path.
Replacements for functions from MathWorks toolboxes
To avoid unnecessary dependencies on functions from non-standard MathWorks toolboxes, FieldTrip includes a number of drop-in replacement functions that have the same functionality as their MATLAB counterparts. Have a look at this FAQ how you can control whether these are added to your path.
Alternatives are provided for the following functions from the Statistics Toolbox
- nansum, nanstd, etc.
Alternatives are provided for the following functions from the Signal Processing Toolbox
Alternatives are provided for the following functions from the Image Processing Toolbox