FWDLIB Namespace Reference

Forward modelling (BEM, MEG/EEG lead fields). More...

Classes
class	ComputeFwd
	Forward solution computation worker. More...
class	ComputeFwdSettings
	Forward-computation parameter class. More...
class	Fwd
	The Fwd class provides static wrapper functions for the forward library. More...
struct	SurfExpl
struct	MethodExpl
struct	FrameNameRec
	Lookup record mapping a FIFF coordinate frame integer ID to its human-readable name. More...
class	FwdBemModel
	BEM (Boundary Element Method) model definition. More...
class	FwdBemSolution
	Mapping from infinite medium potentials to a particular set of coils or electrodes. More...
class	FwdCoil
	Single MEG or EEG sensor coil with integration points, weights, and coordinate frame. More...
class	FwdCoilSet
	Collection of FwdCoil objects representing a full MEG or EEG sensor array. More...
class	FwdCompData
	This structure is used in the compensated field calculations. More...
class	FwdEegSphereLayer
	Single concentric sphere layer with conductivity ratio for the EEG forward 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-layer spherical head model for EEG forward computation. More...
class	FwdEegSphereModelSet
	Collection of FwdEegSphereModel objects for multi-model EEG forward solutions. More...
class	FwdFieldMap
	Computes and stores sensor-to-surface field mapping matrices for MEG/EEG forward solutions. More...
class	FwdThreadArg
	Thread-local arguments for parallel forward field computation (source range, coils, result buffer). 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, MEG/EEG lead fields).

Typedef Documentation

fitUser

using FWDLIB::fitUser = fitUserRec*

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 46 of file fwd_global.cpp.

buildHash()

const char * FWDLIB::buildHash

(

)

Returns abbreviated build git hash.

Definition at line 50 of file fwd_global.cpp.

buildHashLong()

const char * FWDLIB::buildHashLong

(

)

Returns full build git hash.

Definition at line 54 of file fwd_global.cpp.

FWD_IS_MEG_COIL()

bool FWDLIB::FWD_IS_MEG_COIL ( int x )

inlineconstexpr

Definition at line 84 of file fwd_coil.h.

Variable Documentation

FWD_BEM_CONSTANT_COLL

int FWDLIB::FWD_BEM_CONSTANT_COLL = 1

constexpr

Definition at line 75 of file fwd_bem_model.h.

FWD_BEM_IP_APPROACH_LIMIT

double FWDLIB::FWD_BEM_IP_APPROACH_LIMIT = 0.1

constexpr

Definition at line 78 of file fwd_bem_model.h.

FWD_BEM_LIN_FIELD_FERGUSON

int FWDLIB::FWD_BEM_LIN_FIELD_FERGUSON = 2

constexpr

Definition at line 81 of file fwd_bem_model.h.

FWD_BEM_LIN_FIELD_SIMPLE

int FWDLIB::FWD_BEM_LIN_FIELD_SIMPLE = 1

constexpr

Definition at line 80 of file fwd_bem_model.h.

FWD_BEM_LIN_FIELD_URANKAR

int FWDLIB::FWD_BEM_LIN_FIELD_URANKAR = 3

constexpr

Definition at line 82 of file fwd_bem_model.h.

FWD_BEM_LINEAR_COLL

int FWDLIB::FWD_BEM_LINEAR_COLL = 2

constexpr

Definition at line 76 of file fwd_bem_model.h.

FWD_BEM_UNKNOWN

int FWDLIB::FWD_BEM_UNKNOWN = -1

constexpr

Definition at line 74 of file fwd_bem_model.h.

FWD_COIL_ACCURACY_ACCURATE

int FWDLIB::FWD_COIL_ACCURACY_ACCURATE = 2

constexpr

Definition at line 82 of file fwd_coil.h.

FWD_COIL_ACCURACY_NORMAL

int FWDLIB::FWD_COIL_ACCURACY_NORMAL = 1

constexpr

Definition at line 81 of file fwd_coil.h.

FWD_COIL_ACCURACY_POINT

int FWDLIB::FWD_COIL_ACCURACY_POINT = 0

constexpr

Definition at line 80 of file fwd_coil.h.

FWD_COIL_UNKNOWN

int FWDLIB::FWD_COIL_UNKNOWN = 0

constexpr

Definition at line 71 of file fwd_coil.h.

FWD_COILC_AXIAL_GRAD

int FWDLIB::FWD_COILC_AXIAL_GRAD = 2

constexpr

Definition at line 76 of file fwd_coil.h.

FWD_COILC_AXIAL_GRAD2

int FWDLIB::FWD_COILC_AXIAL_GRAD2 = 4

constexpr

Definition at line 78 of file fwd_coil.h.

FWD_COILC_EEG

int FWDLIB::FWD_COILC_EEG = 1000

constexpr

Definition at line 74 of file fwd_coil.h.

FWD_COILC_MAG

int FWDLIB::FWD_COILC_MAG = 1

constexpr

Definition at line 75 of file fwd_coil.h.

FWD_COILC_PLANAR_GRAD

int FWDLIB::FWD_COILC_PLANAR_GRAD = 3

constexpr

Definition at line 77 of file fwd_coil.h.

FWD_COILC_UNKNOWN

int FWDLIB::FWD_COILC_UNKNOWN = 0

constexpr

Definition at line 73 of file fwd_coil.h.