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

Forward modelling — BEM solver, spherical models, sensor/coil definitions and the lead-field assembly that links current dipoles to MEG/EEG sensor readings. More...

Classes

class  ComputeFwd
 Top-level driver for MEG/EEG forward-solution computation. More...
class  ComputeFwdSettings
 Settings struct — source-space / BEM / sphere paths, sensor selection, coordinate transforms and accuracy level consumed by ComputeFwd. More...
class  Fwd
 Static-method façade that re-exposes MNEForwardSolution toolbox-equivalent entry points under their familiar mne_* names. More...
struct  SurfExpl
struct  MethodExpl
struct  FrameNameRec
 Lookup record mapping a FIFF coordinate frame integer ID to its human-readable name. More...
class  FwdBemModel
 Layered triangulated volume-conductor model (scalp/skull/inner-skull surfaces, per-compartment conductivities, IP-approach data and dense potential-solution matrix) used by the linear-collocation BEM forward solver. More...
class  FwdBemSolution
 Channel-specific projection that contracts a BEM node-potential vector down to one entry per MEG coil or EEG electrode — i.e. the Geselowitz surface-integral weights cached as a dense ncoil × np matrix. More...
class  FwdCoil
 Single MEG sensor coil or EEG electrode — stores the coil-local frame and the (r_mag, cos_mag, w) integration-point triples that approximate the Biot-Savart surface integral over the coil area. More...
class  FwdCoilSet
 Container of FwdCoil instances acting both as the in-memory image of the coil_def.dat template database and as a per-channel sensor array in a chosen coordinate frame (device / head / MRI). More...
class  FwdCompData
 CTF / 4D software-gradiometer wrapper that re-evaluates the primary field callback on a separate reference-coil set and subtracts the linear combination k·B_ref from the primary field to mirror the compensation already applied to the recorded data. More...
class  FwdEegSphereLayer
 One concentric shell (outer radius rad, conductivity sigma and the derived ratios) of a multi-shell de Munck / Berg-Scherg EEG head model. More...
struct  BergSchergPar
 Berg-Scherg parameter pair (magnitude and distance multiplier) for an equivalent dipole in the EEG sphere model approximation. More...
struct  fitUserRec
 Workspace for the linear least-squares fit of Berg-Scherg parameters in the EEG sphere model (SVD matrices, residuals, weights). More...
class  FwdEegSphereModel
 Multi-shell concentric-sphere head model holding the Berg-Scherg equivalent-source parameters that accelerate the de Munck Legendre series for EEG, plus the Sarvas closed-form coefficients used for the spherically-symmetric MEG forward solution. More...
class  FwdEegSphereModelSet
 Name-indexed collection of FwdEegSphereModel objects parsed from an mne_setup_eeg_sphere_model parameter file so callers can resolve textual model names ("Default", "Stok", …) into ready-to-use analytic head models. More...
class  FwdFieldMap
 Computes the per-vertex sensor-to-surface mapping matrix used to render a continuous scalp/cortex field that exactly reproduces the recorded MEG/EEG values. More...
class  FwdThreadArg
 Per-thread work packet carrying the dipole-index range, coil set, field/grad callback and write-back view into the shared lead-field matrix — unit of work for the parallel source-space dipole loop. More...

Typedefs

using fitUser = fitUserRec*

Functions

constexpr bool FWD_IS_MEG_COIL (int x)
const char * buildDateTime ()
const char * buildHash ()
const char * buildHashLong ()

Variables

constexpr int FWD_BEM_UNKNOWN = -1
constexpr int FWD_BEM_CONSTANT_COLL = 1
constexpr int FWD_BEM_LINEAR_COLL = 2
constexpr double FWD_BEM_IP_APPROACH_LIMIT = 0.1
constexpr int FWD_BEM_LIN_FIELD_SIMPLE = 1
constexpr int FWD_BEM_LIN_FIELD_FERGUSON = 2
constexpr int FWD_BEM_LIN_FIELD_URANKAR = 3
constexpr int FWD_COIL_UNKNOWN = 0
constexpr int FWD_COILC_UNKNOWN = 0
constexpr int FWD_COILC_EEG = 1000
constexpr int FWD_COILC_MAG = 1
constexpr int FWD_COILC_AXIAL_GRAD = 2
constexpr int FWD_COILC_PLANAR_GRAD = 3
constexpr int FWD_COILC_AXIAL_GRAD2 = 4
constexpr int FWD_COIL_ACCURACY_POINT = 0
constexpr int FWD_COIL_ACCURACY_NORMAL = 1
constexpr int FWD_COIL_ACCURACY_ACCURATE = 2

Detailed Description

Forward modelling — BEM solver, spherical models, sensor/coil definitions and the lead-field assembly that links current dipoles to MEG/EEG sensor readings.

Typedef Documentation

◆ fitUser

Definition at line 88 of file fwd_eeg_sphere_model.h.

Function Documentation

◆ buildDateTime()

const char * FWDLIB::buildDateTime ( )

Returns build date and time.

Definition at line 25 of file fwd_global.cpp.

◆ buildHash()

const char * FWDLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 29 of file fwd_global.cpp.

◆ buildHashLong()

const char * FWDLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 33 of file fwd_global.cpp.

◆ FWD_IS_MEG_COIL()

bool FWDLIB::FWD_IS_MEG_COIL ( int x)
inlineconstexpr

Definition at line 79 of file fwd_coil.h.

Variable Documentation

◆ FWD_BEM_CONSTANT_COLL

int FWDLIB::FWD_BEM_CONSTANT_COLL = 1
constexpr

Definition at line 77 of file fwd_bem_model.h.

◆ FWD_BEM_IP_APPROACH_LIMIT

double FWDLIB::FWD_BEM_IP_APPROACH_LIMIT = 0.1
constexpr

Definition at line 80 of file fwd_bem_model.h.

◆ FWD_BEM_LIN_FIELD_FERGUSON

int FWDLIB::FWD_BEM_LIN_FIELD_FERGUSON = 2
constexpr

Definition at line 83 of file fwd_bem_model.h.

◆ FWD_BEM_LIN_FIELD_SIMPLE

int FWDLIB::FWD_BEM_LIN_FIELD_SIMPLE = 1
constexpr

Definition at line 82 of file fwd_bem_model.h.

◆ FWD_BEM_LIN_FIELD_URANKAR

int FWDLIB::FWD_BEM_LIN_FIELD_URANKAR = 3
constexpr

Definition at line 84 of file fwd_bem_model.h.

◆ FWD_BEM_LINEAR_COLL

int FWDLIB::FWD_BEM_LINEAR_COLL = 2
constexpr

Definition at line 78 of file fwd_bem_model.h.

◆ FWD_BEM_UNKNOWN

int FWDLIB::FWD_BEM_UNKNOWN = -1
constexpr

Definition at line 76 of file fwd_bem_model.h.

◆ FWD_COIL_ACCURACY_ACCURATE

int FWDLIB::FWD_COIL_ACCURACY_ACCURATE = 2
constexpr

Definition at line 77 of file fwd_coil.h.

◆ FWD_COIL_ACCURACY_NORMAL

int FWDLIB::FWD_COIL_ACCURACY_NORMAL = 1
constexpr

Definition at line 76 of file fwd_coil.h.

◆ FWD_COIL_ACCURACY_POINT

int FWDLIB::FWD_COIL_ACCURACY_POINT = 0
constexpr

Definition at line 75 of file fwd_coil.h.

◆ FWD_COIL_UNKNOWN

int FWDLIB::FWD_COIL_UNKNOWN = 0
constexpr

Definition at line 66 of file fwd_coil.h.

◆ FWD_COILC_AXIAL_GRAD

int FWDLIB::FWD_COILC_AXIAL_GRAD = 2
constexpr

Definition at line 71 of file fwd_coil.h.

◆ FWD_COILC_AXIAL_GRAD2

int FWDLIB::FWD_COILC_AXIAL_GRAD2 = 4
constexpr

Definition at line 73 of file fwd_coil.h.

◆ FWD_COILC_EEG

int FWDLIB::FWD_COILC_EEG = 1000
constexpr

Definition at line 69 of file fwd_coil.h.

◆ FWD_COILC_MAG

int FWDLIB::FWD_COILC_MAG = 1
constexpr

Definition at line 70 of file fwd_coil.h.

◆ FWD_COILC_PLANAR_GRAD

int FWDLIB::FWD_COILC_PLANAR_GRAD = 3
constexpr

Definition at line 72 of file fwd_coil.h.

◆ FWD_COILC_UNKNOWN

int FWDLIB::FWD_COILC_UNKNOWN = 0
constexpr

Definition at line 68 of file fwd_coil.h.