File: dig_formats.rst

package info (click to toggle)
python-mne 1.3.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 100,172 kB
  • sloc: python: 166,349; pascal: 3,602; javascript: 1,472; sh: 334; makefile: 236
file content (44 lines) | stat: -rw-r--r-- 1,819 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
:orphan:
.. _dig-formats:

Supported formats for digitized 3D locations
============================================

.. NOTE: If you want to link to this content, link to :ref:`dig-formats`
   for the implementation page. The next line is
   a target for :start-after: so we can omit the title above:
   dig-formats-begin-content

MNE-Python can load 3D point locations obtained by digitization systems.
Such files allow to obtain a :class:`montage <mne.channels.DigMontage>`
that can then be added to :class:`~mne.io.Raw` objects with the
:meth:`~mne.io.Raw.set_montage`. See the documentation for each reader
function for more info on reading specific file types.

.. NOTE: To include only the table, here's a different target for :start-after:
   dig-formats-begin-table

.. cssclass:: table-bordered
.. rst-class:: midvalign

=================  ================  ==============================================
Vendor             Extension(s)      MNE-Python function
=================  ================  ==============================================
Neuromag           .fif              :func:`mne.channels.read_dig_fif`

Polhemus ISOTRAK   .hsp, .elp, .eeg  :func:`mne.channels.read_dig_polhemus_isotrak`

EGI                .xml              :func:`mne.channels.read_dig_egi`

MNE-C              .hpts             :func:`mne.channels.read_dig_hpts`

Brain Products     .bvct             :func:`mne.channels.read_dig_captrak`

Compumedics        .dat              :func:`mne.channels.read_dig_dat`
=================  ================  ==============================================

To load Polhemus FastSCAN files you can use
:func:`montage <mne.channels.read_polhemus_fastscan>`.

It is also possible to make a :class:`montage <mne.channels.DigMontage>`
from arrays with :func:`mne.channels.make_dig_montage`.