FWDLIB::FwdCompData Class Reference

This structure is used in the compensated field calculations. More...

#include <fwd_comp_data.h>

Public Types
typedef QSharedPointer< FwdCompData >	SPtr
typedef QSharedPointer< const FwdCompData >	ConstSPtr

Public Member Functions
	FwdCompData ()
	~FwdCompData ()

Static Public Member Functions
static int	fwd_comp_field (float *rd, float *Q, FwdCoilSet *coils, float *res, void *client)
static void	fwd_free_comp_data (void *d)
static int	fwd_make_ctf_comp_coils (MNELIB::MneCTFCompDataSet *set, FwdCoilSet *coils, FwdCoilSet *comp_coils)
static FwdCompData *	fwd_make_comp_data (MNELIB::MneCTFCompDataSet *set, FwdCoilSet *coils, FwdCoilSet *comp_coils, fwdFieldFunc field, fwdVecFieldFunc vec_field, fwdFieldGradFunc field_grad, void *client, fwdUserFreeFunc client_free)
static int	fwd_comp_field_vec (float *rd, FwdCoilSet *coils, float **res, void *client)
static int	fwd_comp_field_grad (float *rd, float *Q, FwdCoilSet *coils, float *res, float *xgrad, float *ygrad, float *zgrad, void *client)

Public Attributes
MNELIB::MneCTFCompDataSet *	set
FwdCoilSet *	comp_coils
fwdFieldFunc	field
fwdVecFieldFunc	vec_field
fwdFieldGradFunc	field_grad
void *	client
fwdUserFreeFunc	client_free
float *	work
float **	vec_work

Detailed Description

This structure is used in the compensated field calculations.

Implements the Forward Compensation Data description (Replaces *fwdCompData,fwdCompDataRec; struct of MNE-C fwd_comp_data.h).

Definition at line 87 of file fwd_comp_data.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const FwdCompData> FWDLIB::FwdCompData::ConstSPtr

Const shared pointer type for FwdCompData.

Definition at line 91 of file fwd_comp_data.h.

SPtr

typedef QSharedPointer<FwdCompData> FWDLIB::FwdCompData::SPtr

Shared pointer type for FwdCompData.

Definition at line 90 of file fwd_comp_data.h.

Constructor & Destructor Documentation

FwdCompData()

FwdCompData::FwdCompData

(

)

Constructs the Forward Compensation Data Refactored: fwd_new_comp_data (fwd_comp.c)

Definition at line 129 of file fwd_comp_data.cpp.

~FwdCompData()

FwdCompData::~FwdCompData

(

)

Destroys the Forward Compensation Data Refactored: fwd_free_comp_data (fwd_comp.c)

Definition at line 144 of file fwd_comp_data.cpp.

Member Function Documentation

fwd_comp_field()

int FwdCompData::fwd_comp_field ( float * rd, float * Q, FwdCoilSet * coils, float * res, void * client )

static

Definition at line 160 of file fwd_comp_data.cpp.

fwd_comp_field_grad()

int FwdCompData::fwd_comp_field_grad ( float * rd, float * Q, FwdCoilSet * coils, float * res, float * xgrad, float * ygrad, float * zgrad, void * client )

static

Definition at line 352 of file fwd_comp_data.cpp.

fwd_comp_field_vec()

int FwdCompData::fwd_comp_field_vec ( float * rd, FwdCoilSet * coils, float ** res, void * client )

static

Definition at line 308 of file fwd_comp_data.cpp.

fwd_free_comp_data()

void FwdCompData::fwd_free_comp_data ( void * d )

static

Definition at line 199 of file fwd_comp_data.cpp.

fwd_make_comp_data()

FwdCompData * FwdCompData::fwd_make_comp_data ( MNELIB::MneCTFCompDataSet * set, FwdCoilSet * coils, FwdCoilSet * comp_coils, fwdFieldFunc field, fwdVecFieldFunc vec_field, fwdFieldGradFunc field_grad, void * client, fwdUserFreeFunc client_free )

static

Definition at line 263 of file fwd_comp_data.cpp.

fwd_make_ctf_comp_coils()

int FwdCompData::fwd_make_ctf_comp_coils ( MNELIB::MneCTFCompDataSet * set, FwdCoilSet * coils, FwdCoilSet * comp_coils )

static

Definition at line 216 of file fwd_comp_data.cpp.

Member Data Documentation

client

void* FWDLIB::FwdCompData::client

Definition at line 142 of file fwd_comp_data.h.

client_free

fwdUserFreeFunc FWDLIB::FwdCompData::client_free

Definition at line 143 of file fwd_comp_data.h.

comp_coils

FwdCoilSet* FWDLIB::FwdCompData::comp_coils

Definition at line 138 of file fwd_comp_data.h.

field

fwdFieldFunc FWDLIB::FwdCompData::field

Definition at line 139 of file fwd_comp_data.h.

field_grad

fwdFieldGradFunc FWDLIB::FwdCompData::field_grad

Definition at line 141 of file fwd_comp_data.h.

set

MNELIB::MneCTFCompDataSet* FWDLIB::FwdCompData::set

Definition at line 137 of file fwd_comp_data.h.

vec_field

fwdVecFieldFunc FWDLIB::FwdCompData::vec_field

Definition at line 140 of file fwd_comp_data.h.

vec_work

float** FWDLIB::FwdCompData::vec_work

Definition at line 145 of file fwd_comp_data.h.

work

float* FWDLIB::FwdCompData::work

Definition at line 144 of file fwd_comp_data.h.

---

The documentation for this class was generated from the following files:

• src/libraries/fwd/fwd_comp_data.h
• src/libraries/fwd/fwd_comp_data.cpp