FWDLIB::FwdCoilSet Class Reference

FwdCoilSet description. More...

#include <fwd_coil_set.h>

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

Public Member Functions
	FwdCoilSet ()
	~FwdCoilSet ()
void	fwd_free_coil_set_user_data ()
FwdCoil *	create_meg_coil (const FIFFLIB::FiffChInfo &ch, int acc, const FIFFLIB::FiffCoordTransOld *t)
FwdCoilSet *	create_meg_coils (const QList< FIFFLIB::FiffChInfo > &chs, int nch, int acc, const FIFFLIB::FiffCoordTransOld *t)
FwdCoilSet *	dup_coil_set (const FIFFLIB::FiffCoordTransOld *t) const
bool	is_planar_coil_type (int type) const
bool	is_axial_coil_type (int type) const
bool	is_magnetometer_coil_type (int type) const
bool	is_eeg_electrode_type (int type) const

Static Public Member Functions
static FwdCoilSet *	create_eeg_els (const QList< FIFFLIB::FiffChInfo > &chs, int nch, const FIFFLIB::FiffCoordTransOld *t)
static FwdCoilSet *	read_coil_defs (const QString &name)

Public Attributes
FwdCoil **	coils
int	ncoil
int	coord_frame
void *	user_data
fwdUserFreeFunc	user_data_free

Detailed Description

FwdCoilSet description.

Implements FwdCoilSet (Replaces *fwdCoilSet,fwdCoilSetRec; struct of MNE-C fwd_types.h).

Definition at line 75 of file fwd_coil_set.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FwdCoilSet.

Definition at line 79 of file fwd_coil_set.h.

SPtr

typedef QSharedPointer<FwdCoilSet> FWDLIB::FwdCoilSet::SPtr

Shared pointer type for FwdCoilSet.

Definition at line 78 of file fwd_coil_set.h.

Constructor & Destructor Documentation

FwdCoilSet()

FwdCoilSet::FwdCoilSet

(

)

Constructs the Forward Coil Set description Refactored: fwd_new_coil_set

Definition at line 265 of file fwd_coil_set.cpp.

~FwdCoilSet()

FwdCoilSet::~FwdCoilSet

(

)

Destroys the Forward Coil Set description Refactored: fwd_free_coil_set, fwd_free_coil_set_user_data

Definition at line 282 of file fwd_coil_set.cpp.

Member Function Documentation

create_eeg_els()

FwdCoilSet * FwdCoilSet::create_eeg_els ( const QList< FIFFLIB::FiffChInfo > &  chs, int  nch, const FIFFLIB::FiffCoordTransOld *  t  )

static

Create a EEG coil set definition using a channel information Change the coordinate frame if so desired Refactored: fwd_create_eeg_els (fwd_coil_def.c)

Parameters

[in]	ch	Channel information to use.
[in]	nch	Number of channels.
[in]	t	Transform the points using this.

Returns

The created meg coil set.

Definition at line 390 of file fwd_coil_set.cpp.

create_meg_coil()

FwdCoil * FwdCoilSet::create_meg_coil	(	const FIFFLIB::FiffChInfo &	ch,
		int	acc,
		const FIFFLIB::FiffCoordTransOld *	t
	)

Create a MEG coil definition using a database of templates Change the coordinate frame if so desired Refactored: fwd_create_meg_coil (fwd_coil_def.c)

Parameters

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

Returns

The created meg coil.

Definition at line 293 of file fwd_coil_set.cpp.

create_meg_coils()

FwdCoilSet * FwdCoilSet::create_meg_coils	(	const QList< FIFFLIB::FiffChInfo > &	chs,
		int	nch,
		int	acc,
		const FIFFLIB::FiffCoordTransOld *	t
	)

Create a MEG coil set definition using a database of templates Change the coordinate frame if so desired Refactored: fwd_create_meg_coils (fwd_coil_def.c)

Parameters

[in]	ch	Channel information to use.
[in]	nch	Number of channels.
[in]	acc	Required accuracy.
[in]	t	Transform the points using this.

Returns

The created meg coil set.

Definition at line 363 of file fwd_coil_set.cpp.

dup_coil_set()

FwdCoilSet * FwdCoilSet::dup_coil_set

(

const FIFFLIB::FiffCoordTransOld *

t

)

const

Make a coil set duplicate Refactored: fwd_dup_coil_set (fwd_coil_def.c)

Parameters

[in]

t

Transformation which should be applied to the duplicate.

Returns

The duplicated coil set.

Definition at line 506 of file fwd_coil_set.cpp.

is_axial_coil_type()

bool FwdCoilSet::is_axial_coil_type

(

int

type

)

const

Checks if a set of templates contains an axial coil of a specified type. Refactored: fwd_is_axial_coil_type (fwd_coil_def.c)

Parameters

[in]

type

This is the coil type we are interested in.

Returns

True if set contains an axial coil of specified type, false otherwise.

Definition at line 561 of file fwd_coil_set.cpp.

is_eeg_electrode_type()

bool FwdCoilSet::is_eeg_electrode_type

(

int

type

)

const

Checks if a set of templates contains an EEG electrode of a specified type. Refactored: fwd_is_eeg_electrode_type (fwd_coil_def.c)

Parameters

[in]

type

This is the coil type we are interested in.

Returns

True if set contains an EEG electrode of specified type, false otherwise.

Definition at line 587 of file fwd_coil_set.cpp.

is_magnetometer_coil_type()

bool FwdCoilSet::is_magnetometer_coil_type

(

int

type

)

const

Checks if a set of templates contains a magnetometer of a specified type. Refactored: fwd_is_magnetometer_coil_type (fwd_coil_def.c)

Parameters

[in]

type

This is the coil type we are interested in.

Returns

True if set contains a magnetometer of specified type, false otherwise.

Definition at line 575 of file fwd_coil_set.cpp.

is_planar_coil_type()

bool FwdCoilSet::is_planar_coil_type

(

int

type

)

const

Checks if a set of templates contains a planar coil of a specified type. Refactored: fwd_is_planar_coil_type (fwd_coil_def.c)

Parameters

[in]

type

This is the coil type we are interested in.

Returns

True if set contains a planar coil of specified type, false otherwise.

Definition at line 549 of file fwd_coil_set.cpp.

read_coil_defs()

FwdCoilSet * FwdCoilSet::read_coil_defs ( const QString &  name )

static

Read a coil definitions from file Refactored: fwd_read_coil_defs (fwd_coil_def.c)

Parameters

[in]

name

File name to read from.

Returns

The read meg coil set.

Definition at line 416 of file fwd_coil_set.cpp.

---

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

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