v2.0.0
Loading...
Searching...
No Matches
MNALIB Namespace Reference

MNE Analysis Container Format (mna/mnx). More...

Classes

struct  MnaFileRef
class  MnaGraph
 In-memory DAG of MnaNode operations with validation, topological sort and JSON/CBOR persistence. More...
class  MnaGraphExecutor
 Stateless batch and stream-mode runner for an MnaGraph. More...
class  MnaIO
struct  MnaNode
 Single executable step in an MNA pipeline graph, with attributes, typed ports, exec mode, verification and provenance. More...
class  MnaOpRegistry
 Process-wide lookup from opType to MnaOpSchema and implementation function. More...
struct  MnaOpSchemaPort
struct  MnaOpSchemaAttr
class  MnaOpSchema
 Operation schema for graph validation. More...
struct  MnaParamBinding
 Dynamic parameter binding for the MNA parameter tree. More...
class  MnaParamTree
 Path-keyed parameter store with formula-driven dynamic bindings. More...
struct  MnaPort
 Named, typed port on an MNA graph node with upstream link and optional real-time stream binding. More...
class  MnaProject
struct  MnaRecording
class  MnaRegistryLoader
 Reads MNA op-schema manifests and feeds them into MnaOpRegistry, with drop-in directory merge support. More...
struct  MnaScript
 Inline interpreter-launched source code carried by a Script-mode MnaNode. More...
struct  MnaSession
struct  MnaSubject
struct  MnaVerificationCheck
 Verification check for a graph node. More...
struct  MnaVerificationResult
 Check evaluation result. More...
struct  MnaProvenance
 Provenance record for reproducibility. More...
struct  MnaVerification
 Verification, explanation, and provenance for a graph node. More...

Enumerations

enum class  MnaFileRole {
  Raw , Forward , Inverse , Covariance ,
  SourceEstimate , Bem , Surface , Annotation ,
  Digitizer , Transform , SourceSpace , Evoked ,
  Event , VirtualChannel , Custom
}
enum class  MnaContainerFormat { Json , Cbor }
enum class  MnaDataKind {
  FiffRaw , Forward , Inverse , Covariance ,
  SourceEstimate , Epochs , Evoked , Matrix ,
  Volume , Surface , Bem , Annotation ,
  Label , RealTimeStream , Custom
}
enum class  MnaPortDir { Input , Output }
enum class  MnaNodeExecMode { Batch , Stream , Ipc , Script }

Functions

MNASHARED_EXPORT const char * buildDateTime ()
MNASHARED_EXPORT const char * buildHash ()
MNASHARED_EXPORT const char * buildHashLong ()
QString mnaFileRoleToString (MnaFileRole role)
MnaFileRole mnaFileRoleFromString (const QString &str)
QString mnaDataKindToString (MnaDataKind kind)
MnaDataKind mnaDataKindFromString (const QString &str)

Detailed Description

MNE Analysis Container Format (mna/mnx).

Enumeration Type Documentation

◆ MnaContainerFormat

enum class MNALIB::MnaContainerFormat
strong

Supported container formats.

Enumerator
Json 
Cbor 

Definition at line 81 of file mna_types.h.

◆ MnaDataKind

enum class MNALIB::MnaDataKind
strong

Describes the kind of data flowing through a graph port.

Enumerator
FiffRaw 

Raw MEG/EEG data (FIFF format).

Forward 

Forward solution.

Inverse 

Inverse operator.

Covariance 

Noise or data covariance matrix.

SourceEstimate 

Source-level time series.

Epochs 

Epoched data.

Evoked 

Averaged evoked response.

Matrix 

Generic Eigen matrix (for intermediate results).

Volume 

MRI volume data.

Surface 

Surface mesh (FreeSurfer).

Bem 

BEM model.

Annotation 

FreeSurfer annotation / parcellation.

Label 

ROI label.

RealTimeStream 

Live data channel (MNE Scan / LSL / FIFF-RT).

Custom 

User-defined data kind.

Definition at line 92 of file mna_types.h.

◆ MnaFileRole

enum class MNALIB::MnaFileRole
strong

Describes the role a file plays within an MNA project.

Enumerator
Raw 
Forward 
Inverse 
Covariance 
SourceEstimate 
Bem 
Surface 
Annotation 
Digitizer 
Transform 
SourceSpace 
Evoked 
Event 
VirtualChannel 
Custom 

Definition at line 57 of file mna_types.h.

◆ MnaNodeExecMode

enum class MNALIB::MnaNodeExecMode
strong

Execution mode for a graph node.

Enumerator
Batch 

Runs once on static file-based inputs (default).

Stream 

Runs continuously on real-time data (MNE Scan mode).

Ipc 

Delegates to an external process via inter-process communication.

Script 

Inline code executed via interpreter (Python, shell, R, …).

Definition at line 127 of file mna_types.h.

◆ MnaPortDir

enum class MNALIB::MnaPortDir
strong

Direction of a port on a graph node.

Enumerator
Input 
Output 

Definition at line 116 of file mna_types.h.

Function Documentation

◆ buildDateTime()

const char * MNALIB::buildDateTime ( )

Returns build date and time.

Returns
Null-terminated string with the compile date and time of the library.

Definition at line 30 of file mna_global.cpp.

◆ buildHash()

const char * MNALIB::buildHash ( )

Returns abbreviated build git hash.

Returns
Null-terminated string with the short git commit hash the library was built from.

Definition at line 37 of file mna_global.cpp.

◆ buildHashLong()

const char * MNALIB::buildHashLong ( )

Returns full build git hash.

Returns
Null-terminated string with the full git commit hash the library was built from.

Definition at line 44 of file mna_global.cpp.

◆ mnaDataKindFromString()

MnaDataKind MNALIB::mnaDataKindFromString ( const QString & str)
inline

Convert a string to MnaDataKind.

Parameters
[in]strCamelCase or snake_case kind name, e.g. "SourceEstimate" or "source_estimate".
Returns
The matching kind, or MnaDataKind::Custom if str is not recognized.

Definition at line 280 of file mna_types.h.

◆ mnaDataKindToString()

QString MNALIB::mnaDataKindToString ( MnaDataKind kind)
inline

Convert MnaDataKind to its string representation.

Parameters
[in]kindData kind to convert.
Returns
CamelCase name such as "FiffRaw" or "SourceEstimate"; "Custom" for unknown values.

Definition at line 234 of file mna_types.h.

◆ mnaFileRoleFromString()

MnaFileRole MNALIB::mnaFileRoleFromString ( const QString & str)
inline

Convert a string to MnaFileRole.

Parameters
[in]strLower-case snake_case role name as produced by mnaFileRoleToString().
Returns
The matching role, or MnaFileRole::Custom if str is not recognized.

Definition at line 192 of file mna_types.h.

◆ mnaFileRoleToString()

QString MNALIB::mnaFileRoleToString ( MnaFileRole role)
inline

Convert MnaFileRole to its string representation.

Parameters
[in]roleFile role to convert.
Returns
Lower-case snake_case name such as "raw" or "source_estimate"; "custom" for unknown values.

Definition at line 146 of file mna_types.h.