mne_types.h File Reference

Legacy MNE-C constants and shared typedefs used across MNELIB structures. More...

#include <fiff/fiff_types.h>
#include <fiff/fiff_stream.h>
#include <fiff/fiff_sparse_matrix.h>
#include "mne_sss_data.h"
#include "mne_named_matrix.h"
#include "mne_sparse_named_matrix.h"
#include "mne_named_vector.h"
#include "mne_deriv_set.h"
#include "mne_proj_item.h"
#include "mne_proj_op.h"
#include "mne_cov_matrix.h"
#include "mne_ctf_comp_data.h"
#include "mne_ctf_comp_data_set.h"
#include "mne_layout_port.h"
#include "mne_layout.h"
#include "mne_ch_selection.h"
#include "mne_event.h"
#include "mne_event_list.h"
#include "mne_filter_def.h"
#include <QStringList>

Include dependency graph for mne_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	MNELIB
	Core MNE data structures (source spaces, source estimates, hemispheres).

Macros
#define	MNE_DEFAULT_TRIGGER_CH   "STI 014"
	Default digital trigger channel name.
#define	MNE_ENV_TRIGGER_CH   "MNE_TRIGGER_CH_NAME"
	Environment variable overriding the trigger channel name.
#define	MNE_ENV_ROOT   "MNE_ROOT"
	Environment variable pointing to the MNE installation root.

Typedefs
typedef void(*	MNELIB::mneUserFreeFunc) (void *)
	Generic destructor callback for user-attached data.

Variables
Source-space types
Discriminators for the type field in MNESurfaceOrVolume / MNESourceSpace.
constexpr auto	MNELIB::MNE_SOURCE_SPACE_UNKNOWN = -1
constexpr auto	MNELIB::MNE_SOURCE_SPACE_SURFACE = 1
constexpr auto	MNELIB::MNE_SOURCE_SPACE_VOLUME = 2
constexpr auto	MNELIB::MNE_SOURCE_SPACE_DISCRETE = 3
Channel-selection kinds
Origin tag for MNEChSelection records.
constexpr auto	MNELIB::MNE_CH_SELECTION_UNKNOWN = 0
constexpr auto	MNELIB::MNE_CH_SELECTION_FILE = 1
constexpr auto	MNELIB::MNE_CH_SELECTION_USER = 2
CTF compensation grades
Software gradient-compensation levels for CTF systems.
constexpr auto	MNELIB::MNE_CTFV_NOGRAD = 0
constexpr auto	MNELIB::MNE_CTFV_GRAD1 = 1
constexpr auto	MNELIB::MNE_CTFV_GRAD2 = 2
constexpr auto	MNELIB::MNE_CTFV_GRAD3 = 3
CTF compensation grades as stored in CTF channel info (ASCII "G1BR", "G2OI", ...)
constexpr auto	MNELIB::MNE_CTFV_COMP_UNKNOWN = -1
constexpr auto	MNELIB::MNE_CTFV_COMP_NONE = 0
constexpr auto	MNELIB::MNE_CTFV_COMP_G1BR = 0x47314252
constexpr auto	MNELIB::MNE_CTFV_COMP_G2BR = 0x47324252
constexpr auto	MNELIB::MNE_CTFV_COMP_G3BR = 0x47334252
constexpr auto	MNELIB::MNE_CTFV_COMP_G2OI = 0x47324f49
constexpr auto	MNELIB::MNE_CTFV_COMP_G3OI = 0x47334f49
4D Neuroimaging compensation
constexpr auto	MNELIB::MNE_4DV_COMP1 = 101

Detailed Description

Legacy MNE-C constants and shared typedefs used across MNELIB structures.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2026 MNE-CPP Authors

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

2.0.0

Date

March 2026

Mirrors a curated subset of the mne_types.h shipped with the original MNE C tooling so ported code can continue to refer to the familiar enumerations (point types, surface ids, BEM coordinate frames, covariance kinds, ...) without dragging the full C header tree into every consumer. Definitions here are pure typedefs / enum / #define and carry no implementation, keeping the header safe to include from any layer of MNELIB.

Definition in file mne_types.h.

Macro Definition Documentation

MNE_DEFAULT_TRIGGER_CH

#define MNE_DEFAULT_TRIGGER_CH   "STI 014"

Default digital trigger channel name.

Definition at line 140 of file mne_types.h.

MNE_ENV_ROOT

#define MNE_ENV_ROOT   "MNE_ROOT"

Environment variable pointing to the MNE installation root.

Definition at line 146 of file mne_types.h.

MNE_ENV_TRIGGER_CH

#define MNE_ENV_TRIGGER_CH   "MNE_TRIGGER_CH_NAME"

Environment variable overriding the trigger channel name.

Definition at line 143 of file mne_types.h.