File: getting_started.rst

package info (click to toggle)
python-mne 0.13.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 92,032 kB
  • ctags: 8,249
  • sloc: python: 84,750; makefile: 205; sh: 15
file content (123 lines) | stat: -rw-r--r-- 4,338 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
.. include:: links.inc

.. _getting_started:

Getting started
===============

.. _introduction_to_mne:

**MNE** is an academic software package that aims to provide data analysis
pipelines encompassing all phases of M/EEG data processing.

MNE started as tool written in C by Matti Hämäläinen while at MGH in Boston.
MNE was then extended with the Python programming language to implement
nearly all MNE-C’s functionality, offer transparent scripting, and
:ref:`extend MNE-C’s functionality considerably <what_can_you_do>`.

A basic :ref:`ch_matlab` is also available mostly
to allow reading and write MNE files. The sister :ref:`mne_cpp` project
aims to provide modular and open-source tools for acquisition,
visualization, and analysis.

.. note:: This package is based on the FIF file format from Neuromag. But, it
          can read and convert CTF, BTI/4D, KIT and various EEG formats to
          FIF (see :ref:`IO functions <ch_convert>`).

          If you have been using MNE-C, there is no need to convert your fif
          files to a new system or database -- MNE-Python works nicely with
          the historical fif files.

Installation
------------

To get started with MNE, visit the installation instructions for
:ref:`MNE-Python <install_python_and_mne_python>` and
:ref:`MNE-C <install_mne_c>`:

.. container:: span box

  .. raw:: html

    <h3>MNE-Python</h3>

  .. toctree::
    :maxdepth: 2

    install_mne_python

.. container:: span box

  .. raw:: html

    <h3>MNE-C</h3>

  .. toctree::
    :maxdepth: 2

    install_mne_c


.. _what_can_you_do:

What can you do with MNE using Python?
--------------------------------------

   - **Raw data visualization** to visualize recordings
     (see :ref:`general_examples` for more).
   - **Epoching**: Define epochs, baseline correction, handle conditions etc.
   - **Averaging** to get Evoked data.
   - **Compute SSP projectors** to remove ECG and EOG artifacts.
   - **Compute ICA** to remove artifacts or select latent sources.
   - **Maxwell filtering** to remove environmental noise.
   - **Boundary Element Modeling**: single and three-layer BEM model
     creation and solution computation.
   - **Forward modeling**: BEM computation and mesh creation
     (see :ref:`ch_forward`).
   - **Linear inverse solvers** (dSPM, sLORETA, MNE, LCMV, DICS).
   - **Sparse inverse solvers** (L1/L2 mixed norm MxNE, Gamma Map,
     Time-Frequency MxNE, RAP-MUSIC).
   - **Connectivity estimation** in sensor and source space.
   - **Visualization of sensor and source space data**
   - **Time-frequency** analysis with Morlet wavelets (induced power,
     intertrial coherence, phase lock value) also in the source space.
   - **Spectrum estimation** using multi-taper method.
   - **Mixed Source Models** combining cortical and subcortical structures.
   - **Dipole Fitting**
   - **Decoding** multivariate pattern analysis of M/EEG topographies.
   - **Compute contrasts** between conditions, between sensors, across
     subjects etc.
   - **Non-parametric statistics** in time, space and frequency
     (including cluster-level).
   - **Scripting** (batch and parallel computing)


Is that all you can do with MNE-Python?
---------------------------------------

Short answer is **No**! You can also do:

    - detect heart beat QRS component
    - detect eye blinks and EOG artifacts
    - compute SSP projections to remove ECG or EOG artifacts
    - compute Independent Component Analysis (ICA) to remove artifacts or
      select latent sources
    - estimate noise covariance matrix from Raw and Epochs
    - visualize cross-trial response dynamics using epochs images
    - compute forward solutions
    - estimate power in the source space
    - estimate connectivity in sensor and source space
    - morph stc from one brain to another for group studies
    - compute mass univariate statistics base on custom contrasts
    - visualize source estimates
    - export raw, epochs, and evoked data to other python data analysis
      libraries e.g. pandas
    - Raw movement compensation as you would do with Elekta Maxfilter™
    - and many more things ...


What you're not supposed to do with MNE-Python
----------------------------------------------

    - **Brain and head surface segmentation** for use with BEM
      models -- use Freesurfer_.