Core MNE data structures (source spaces, source estimates, hemispheres). More...

Classes
class	FilterThreadArg
	Thread-local arguments for parallel raw data filtering (channel range, filter kernel, buffer). More...
class	MNE
	The MNE class provides wrapper functions to stay consistent with mne matlab toolbox. More...
class	MNEBem
	Aggregated boundary element model loaded from a `-bem.fif` file. More...
class	MNEBemSurface
	BEM surface provides geometry information. More...
class	MNEChSelection
class	MNEClusterInfo
	Cluster table used to compress and reconstruct a clustered leadfield. More...
class	MNECorticalMap
	Cortical map interpolation utilities. More...
class	MNECovMatrix
	Covariance matrix storage. More...
class	MNECTFCompData
	Represents a single CTF compensation data element. More...
class	MNECTFCompDataSet
	Collection of CTF third-order gradient compensation operators. More...
class	MNEDeriv
	One item in a derivation data set. More...
class	MNEDerivSet
	Collection of MNEDeriv channel derivation definitions loaded from a file. More...
class	MNEDescriptionParser
class	MNEEpochData
	Single epoch (trial slice) of sensor data with timing and rejection metadata. More...
struct	ArtifactRejectionData
	Artifact rejection thresholds and flags for each channel type (grad, mag, eeg, eog) used during epoch dropping. More...
class	MNEEpochDataList
	Ordered list of MNEEpochData objects sharing a common measurement info. More...
class	MNEEvent
	Single trigger-event marker. More...
class	MNEEventList
	Ordered list of trigger-event markers. More...
class	MNEFilterDef
struct	RegionDataOut
	Output of a cluster-based forward solution computation for a single cortical region. More...
struct	RegionData
	Input parameters for cluster-based forward solution computation on a single cortical region. More...
class	MNEForwardSolution
	In-memory representation of an `-fwd.fif` forward solution. More...
class	MNEHemisphere
	Hemisphere provides geometry information. More...
struct	RegionMTOut
	Output of a multi-threaded KMeans clustering step for a single cortical region. More...
struct	RegionMT
	Input parameters for multi-threaded KMeans clustering on a single cortical region. More...
class	MNEInverseOperator
	MNE-style inverse operator. More...
class	MNELayout
	Full plotter layout with viewports. More...
class	MNELayoutPort
	Single viewport in a plotter layout. More...
class	MNEMeasData
	Measurement data container for MNE inverse and dipole-fit computations. More...
class	MNEMeasDataSet
	Single measurement epoch or average within MNEMeasData. More...
class	MNEMghTag
	Single tag entry in a FreeSurfer MGH/MGZ file header. More...
class	MNEMghTagGroup
	Collection of MNEMghTag entries from a FreeSurfer MGH/MGZ file footer. More...
class	MNEMneData
	Data associated with MNE computations for each mneMeasDataSet. More...
class	MNEMorphMap
	Vertex-to-vertex mapping between two FreeSurfer surface meshes for morphing source estimates. More...
class	MNEMshColorScaleDef
	Color scale definition with value range and color mapping for surface visualization. More...
class	MNEMshDisplaySurface
	The MNE Msh Display FsSurface class holds information about a surface to be rendered. More...
class	MNEMshDisplaySurfaceSet
	The MNE Msh Display FsSurface Set class holds information about a set of surfaces to be rendered. More...
class	MNEMshEyes
	Eye/camera position and gaze direction for 3-D surface rendering. More...
class	MNEMshLight
	Single light source with position, color, and state for 3-D surface rendering. More...
class	MNEMshLightSet
	Collection of lights defining the lighting setup for 3-D rendering. More...
class	MNEMshPicked
	Picked point on a displayed surface storing vertex index, coordinates, and source value. More...
class	MNENamedMatrix
	A dense matrix with named rows and columns. More...
class	MNENamedVector
class	MNENearest
	This is used in the patch definitions. More...
class	MNEPatchInfo
	Patch information for a single source space point including vertex members and area. More...
struct	CovDefinition
struct	CovDescription
struct	FilterSettings
struct	ProcessingSettings
class	MNEProjData
	Auxiliary projection data computed from MNEProjOp for efficient repeated application. More...
class	MNEProjItem
	A single SSP (Signal-Space Projection) item. More...
class	MNEProjOp
	Projection operator managing a set of linear projection items and the final compiled projector matrix. More...
class	MNEProjectToSurface
	Projects 3-D points onto a triangulated surface mesh and returns nearest vertices and distances. More...
class	MNERawBufDef
	Definition of one raw data buffer within a FIFF file. More...
struct	RingBuffer
	Circular ring buffer for managing raw-data matrix allocations. More...
struct	FilterData
	Pre-computed frequency-domain filter state used for FFT-based raw data filtering. More...
class	MNERawData
	A comprehensive raw data structure. More...
class	MNERawInfo
	Information about raw data in a FIFF file. More...
class	MNESourceSpace
	This defines a source space. More...
class	MNESourceSpaces
	List of MNESourceSpace objects forming a subject source space. More...
class	MNESparseNamedMatrix
struct	frameNameRec_1
	Lookup record mapping a FIFF coordinate frame integer code to its human-readable name. More...
class	MNESssData
	Container for Signal Space Separation (SSS/Maxwell filtering) expansion coefficients and metadata. More...
class	MNESurface
	Lightweight triangulated surface (vertices, triangles, normals). More...
class	MNESurfaceOrVolume
	Defines a source space or a surface. More...
class	MNESurfacePatch
	Cortical surface patch linking a set of vertices to a single source space point. More...
class	MNETriangle
	Per-triangle geometric data for a cortical or BEM surface. More...
class	MNEVolGeom
	MRI data volume geometry information like FreeSurfer keeps it. More...

Typedefs
typedef MNEChSelection	mneChSelectionRec
typedef MNEChSelection *	mneChSelection
typedef MNELayoutPort	mneLayoutPortRec
typedef MNELayoutPort *	mneLayoutPort
using	RowMajorMatrixXf = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>
typedef void(*	mneUserFreeFunc) (void *)
	Generic destructor callback for user-attached data.

Functions
bool	operator== (const MNEClusterInfo &a, const MNEClusterInfo &b)
std::ostream &	operator<< (std::ostream &out, const MNELIB::MNEForwardSolution &p_MNEForwardSolution)
bool	operator== (const MNEForwardSolution &a, const MNEForwardSolution &b)
const char *	buildDateTime ()
const char *	buildHash ()
const char *	buildHashLong ()
bool	operator== (const MNEHemisphere &a, const MNEHemisphere &b)
bool	performIcp (const QSharedPointer< MNELIB::MNEProjectToSurface > mneSurfacePoints, const Eigen::MatrixXf &matPointCloud, FIFFLIB::FiffCoordTrans &transFromTo, float &fRMSE, bool bScale=false, int iMaxIter=20, float fTol=0.001, const Eigen::VectorXf &vecWeights=vecDefaultWeights)
bool	fitMatchedPoints (const Eigen::MatrixXf &matSrcPoint, const Eigen::MatrixXf &matDstPoint, Eigen::Matrix4f &matTrans, float fScale=1.0, bool bScale=false, const Eigen::VectorXf &vecWeights=vecDefaultWeights)
bool	discard3DPointOutliers (const QSharedPointer< MNELIB::MNEProjectToSurface > mneSurfacePoints, const Eigen::MatrixXf &matPointCloud, const FIFFLIB::FiffCoordTrans &transFromTo, Eigen::VectorXi &vecTake, Eigen::MatrixXf &matTakePoint, float fMaxDist=0.0)
std::ostream &	operator<< (std::ostream &out, const MNEInverseOperator &inv)
bool	operator== (const MNESourceSpaces &a, const MNESourceSpaces &b)

Variables
const Eigen::VectorXf	vecDefaultWeights

Detailed Description

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

Typedef Documentation

◆ mneChSelection

typedef MNEChSelection* MNELIB::mneChSelection

Definition at line 63 of file mne_ch_selection.h.

◆ mneChSelectionRec

typedef MNEChSelection MNELIB::mneChSelectionRec

Backward-compatible typedef aliases.

Definition at line 62 of file mne_ch_selection.h.

◆ mneLayoutPort

typedef MNELayoutPort* MNELIB::mneLayoutPort

Definition at line 61 of file mne_layout_port.h.

◆ mneLayoutPortRec

typedef MNELayoutPort MNELIB::mneLayoutPortRec

Backward-compatible typedef aliases.

Definition at line 60 of file mne_layout_port.h.

◆ mneUserFreeFunc

typedef void(* MNELIB::mneUserFreeFunc) (void *)

Generic destructor callback for user-attached data.

Several legacy structures carry a void* user_data slot together with a matching mneUserFreeFunc that is called when the owning object is destroyed.

Definition at line 68 of file mne_types.h.

◆ RowMajorMatrixXf

using MNELIB::RowMajorMatrixXf = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>

Row-major float matrix (file-local convenience alias).

Definition at line 55 of file mne_raw_data.cpp.

Function Documentation

◆ buildDateTime()

const char * MNELIB::buildDateTime ( )

Returns build date and time.

Definition at line 30 of file mne_global.cpp.

◆ buildHash()

const char * MNELIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 34 of file mne_global.cpp.

◆ buildHashLong()

const char * MNELIB::buildHashLong ( )

Returns full build git hash.

Definition at line 38 of file mne_global.cpp.

◆ discard3DPointOutliers()

bool MNELIB::discard3DPointOutliers	(	const QSharedPointer< MNELIB::MNEProjectToSurface >	mneSurfacePoints,
		const Eigen::MatrixXf &	matPointCloud,
		const FIFFLIB::FiffCoordTrans &	transFromTo,
		Eigen::VectorXi &	vecTake,
		Eigen::MatrixXf &	matTakePoint,
		float	fMaxDist = 0.0 )

Discard outliers compared to a given 3D surface.

Parameters

[in]	mneSurfacePoints	The MNEProjectToSurface object that contains the surface triangles etc. (To).
[in]	matPointCloud	The point cloud to be registered (From).
[in,out]	transFromTo	The forward transformation matrix.
[in]	vecTake	The index of taken digitizers.
[in]	matTakePoint	The digitizer points to take.
[in]	fMaxDist	The maximum distance to the surface in mm, defaults to 0 mm.

Returns: Whether the discarding was successful.

◆ fitMatchedPoints()

bool MNELIB::fitMatchedPoints	(	const Eigen::MatrixXf &	matSrcPoint,
		const Eigen::MatrixXf &	matDstPoint,
		Eigen::Matrix4f &	matTrans,
		float	fScale = 1.0,
		bool	bScale = false,
		const Eigen::VectorXf &	vecWeights = vecDefaultWeights )

Corresponding point set registration using quaternions.

Parameters

[in]	matSrcPoint	The source point set.
[in]	matDstPoint	The destination point set.
[in,out]	matTrans	The forward transformation matrix.
[in,out]	fScale	The scaling parameter, defaults to 1.0.
[in]	bScale	Whether to apply scaling or not. Should be false for matching data sets, defaults to false.
[in]	vecWeights	The weights to apply, defaults to zeros.

Returns: Whether the matching was successful.

◆ operator<<() [1/2]

std::ostream & MNELIB::operator<<	(	std::ostream &	out,
		const MNEInverseOperator &	inv )

inline

Parameters

[in]	out	Output stream.
[in]	inv	Inverse operator to print.

Returns: The output stream.

Definition at line 393 of file mne_inverse_operator.h.

◆ operator<<() [2/2]

std::ostream & MNELIB::operator<<	(	std::ostream &	out,
		const MNELIB::MNEForwardSolution &	p_MNEForwardSolution )

inline

overloading the stream out operator<<

Parameters

[in]	out	The stream to which the MNE forward solution should be assigned to.
[in]	p_MNEForwardSolution	MNE forward solution which should be assigned to the stream.

Returns: the stream with the attached fiff projector.

Definition at line 539 of file mne_forward_solution.h.

◆ operator==() [1/4]

bool MNELIB::operator==	(	const MNEClusterInfo &	a,
		const MNEClusterInfo &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 138 of file mne_cluster_info.h.

◆ operator==() [2/4]

bool MNELIB::operator==	(	const MNEForwardSolution &	a,
		const MNEForwardSolution &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 555 of file mne_forward_solution.h.

◆ operator==() [3/4]

bool MNELIB::operator==	(	const MNEHemisphere &	a,
		const MNEHemisphere &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 245 of file mne_hemisphere.h.

◆ operator==() [4/4]

bool MNELIB::operator==	(	const MNESourceSpaces &	a,
		const MNESourceSpaces &	b )

inline

Overloaded == operator to compare an object to this instance.

Parameters

[in] object The object which should be compared to.

Returns: true if equal, false otherwise.

Definition at line 376 of file mne_source_spaces.h.

◆ performIcp()

bool MNELIB::performIcp	(	const QSharedPointer< MNELIB::MNEProjectToSurface >	mneSurfacePoints,
		const Eigen::MatrixXf &	matPointCloud,
		FIFFLIB::FiffCoordTrans &	transFromTo,
		float &	fRMSE,
		bool	bScale = false,
		int	iMaxIter = 20,
		float	fTol = 0.001,
		const Eigen::VectorXf &	vecWeights = vecDefaultWeights )

The ICP algorithm to register a point cloud with a surface.

Parameters

[in]	mneSurfacePoints	The MNEProjectToSurface object that contains the surface triangles etc. (To).
[in]	matPointCloud	The point cloud to be registered (From).
[in,out]	transFromTo	The forward transformation matrix. It can contain an initial transformation (e.g. from fiducial alignment).
[in,out]	fRMSE	The resulting Root-Mean-Square-Error in m.
[in]	bScale	Whether to apply scaling or not. Should be false for matching data sets, defaults to false.
[in]	iMaxIter	The maximum number of iterations for the ICP algorithm, defaults to 20.
[in]	fTol	The convergence tolerance, defaults to 0.001.
[in]	vecWeights	The weights to apply, defaults to zeros.

Returns: Whether the registration was successful.

Variable Documentation

◆ vecDefaultWeights

const Eigen::VectorXf MNELIB::vecDefaultWeights

Definition at line 61 of file mne_icp.h.

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ mneChSelection

◆ mneChSelectionRec

◆ mneLayoutPort

◆ mneLayoutPortRec

◆ mneUserFreeFunc

◆ RowMajorMatrixXf

Function Documentation

◆ buildDateTime()

◆ buildHash()

◆ buildHashLong()

◆ discard3DPointOutliers()

◆ fitMatchedPoints()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ performIcp()

Variable Documentation

◆ vecDefaultWeights