FWDLIB::FwdCoil Class Reference

FwdCoil description. More...

#include <fwd_coil.h>

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

Public Member Functions
	FwdCoil (int p_np)
	FwdCoil (const FwdCoil &p_FwdCoil)
	~FwdCoil ()
bool	is_axial_coil () const
bool	is_magnetometer_coil () const
bool	is_planar_coil () const
bool	is_eeg_electrode () const

Static Public Member Functions
static FwdCoil *	create_eeg_el (const FIFFLIB::FiffChInfo &ch, const FIFFLIB::FiffCoordTransOld *t)

Public Attributes
QString	chname
int	coord_frame
QString	desc
int	coil_class
int	type
int	accuracy
float	size
float	base
float	r0 [3]
float	ex [3]
float	ey [3]
float	ez [3]
int	np
float **	rmag
float **	cosmag
float *	w

Detailed Description

FwdCoil description.

Implements FwdCoil (Replaces *fwdCoil,fwdCoilRec; struct of MNE-C fwd_types.h).

Definition at line 88 of file fwd_coil.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FwdCoil.

Definition at line 92 of file fwd_coil.h.

SPtr

typedef QSharedPointer<FwdCoil> FWDLIB::FwdCoil::SPtr

Shared pointer type for FwdCoil.

Definition at line 91 of file fwd_coil.h.

Constructor & Destructor Documentation

FwdCoil() [1/2]

FwdCoil::FwdCoil

(

int

p_np

)

Constructs the Forward Coil Refactored: fwd_new_coil (fwd_coil_def.c)

Definition at line 140 of file fwd_coil.cpp.

FwdCoil() [2/2]

FwdCoil::FwdCoil

(

const FwdCoil &

p_FwdCoil

)

Copy constructor. Refactored: fwd_dup_coil (fwd_coil_def.c)

Parameters

[in]

p_FwdCoil

FwdCoil which should be copied.

Definition at line 166 of file fwd_coil.cpp.

~FwdCoil()

FwdCoil::~FwdCoil

(

)

Destroys the Forward Coil description Refactored: fwd_free_coil

Definition at line 198 of file fwd_coil.cpp.

Member Function Documentation

create_eeg_el()

FwdCoil * FwdCoil::create_eeg_el ( const FIFFLIB::FiffChInfo &  ch, const FIFFLIB::FiffCoordTransOld *  t  )

static

Create an electrode definition. Transform coordinate frame if so desired. Refactored: fwd_create_eeg_el (fwd_coil_def.c)

Parameters

[in]	ch	Channel information to use.
[in]	t	Transform the points using this.

Returns

The created coil.

Definition at line 207 of file fwd_coil.cpp.

is_axial_coil()

bool FwdCoil::is_axial_coil

(

)

const

Checks if this is an axial coil. Refactored: fwd_is_axial_coil (fwd_coil_def.c)

Returns

True if axial coil, false otherwise.

Definition at line 268 of file fwd_coil.cpp.

is_eeg_electrode()

bool FwdCoil::is_eeg_electrode

(

)

const

Checks if this is an EEG electrode. Refactored: fwd_is_eeg_electrode (fwd_coil_def.c)

Returns

True if EEG electrode, false otherwise.

Definition at line 291 of file fwd_coil.cpp.

is_magnetometer_coil()

bool FwdCoil::is_magnetometer_coil

(

)

const

Checks if this is an magnetometer. Refactored: fwd_is_magnetometer_coil (fwd_coil_def.c)

Returns

True if magnetometer, false otherwise.

Definition at line 277 of file fwd_coil.cpp.

is_planar_coil()

bool FwdCoil::is_planar_coil

(

)

const

Checks if this is an planar coil. Refactored: fwd_is_planar_coil (fwd_coil_def.c)

Returns

True if planar coil, false otherwise.

Definition at line 284 of file fwd_coil.cpp.

Member Data Documentation

accuracy

int FWDLIB::FwdCoil::accuracy

Accuracy.

Definition at line 172 of file fwd_coil.h.

base

float FWDLIB::FwdCoil::base

Baseline.

Definition at line 174 of file fwd_coil.h.

chname

QString FWDLIB::FwdCoil::chname

Name of this channel.

Definition at line 167 of file fwd_coil.h.

coil_class

int FWDLIB::FwdCoil::coil_class

Coil class.

Definition at line 170 of file fwd_coil.h.

coord_frame

int FWDLIB::FwdCoil::coord_frame

Which coordinate frame are we in?.

Definition at line 168 of file fwd_coil.h.

cosmag

float** FWDLIB::FwdCoil::cosmag

The corresponding direction cosines.

Definition at line 181 of file fwd_coil.h.

desc

QString FWDLIB::FwdCoil::desc

Description for this type of a coil.

Definition at line 169 of file fwd_coil.h.

ex

float FWDLIB::FwdCoil::ex[3]

Coil coordinate system unit vectors.

Definition at line 176 of file fwd_coil.h.

ey

float FWDLIB::FwdCoil::ey[3]

This stupid construction needs to be replaced with.

Definition at line 177 of file fwd_coil.h.

ez

float FWDLIB::FwdCoil::ez[3]

a coordinate transformation.

Definition at line 178 of file fwd_coil.h.

np

int FWDLIB::FwdCoil::np

Number of integration points.

Definition at line 179 of file fwd_coil.h.

r0

float FWDLIB::FwdCoil::r0[3]

Coil coordinate system origin.

Definition at line 175 of file fwd_coil.h.

rmag

float** FWDLIB::FwdCoil::rmag

The field point locations.

Definition at line 180 of file fwd_coil.h.

size

float FWDLIB::FwdCoil::size

Coil size.

Definition at line 173 of file fwd_coil.h.

type

int FWDLIB::FwdCoil::type

Coil type.

Definition at line 171 of file fwd_coil.h.

w

float* FWDLIB::FwdCoil::w

The weighting coefficients.

Definition at line 182 of file fwd_coil.h.

---

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

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