v2.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FWDLIB::FwdCoilSet Class Reference

Collection of FwdCoil objects representing a full MEG or EEG sensor array. More...

#include <fwd_coil_set.h>

Public Types

typedef QSharedPointer< FwdCoilSet > SPtr
typedef QSharedPointer< const FwdCoilSet > ConstSPtr
typedef std::unique_ptr< FwdCoilSet > UPtr

Public Member Functions

 FwdCoilSet ()
 ~FwdCoilSet ()
FwdCoil::UPtr create_meg_coil (const FIFFLIB::FiffChInfo &ch, int acc, const FIFFLIB::FiffCoordTrans &t=FIFFLIB::FiffCoordTrans())
FwdCoilSet::UPtr create_meg_coils (const QList< FIFFLIB::FiffChInfo > &chs, int nch, int acc, const FIFFLIB::FiffCoordTrans &t=FIFFLIB::FiffCoordTrans())
FwdCoilSet::UPtr dup_coil_set (const FIFFLIB::FiffCoordTrans &t=FIFFLIB::FiffCoordTrans()) 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
int ncoil () const

Static Public Member Functions

static FwdCoilSet::UPtr create_eeg_els (const QList< FIFFLIB::FiffChInfo > &chs, int nch, const FIFFLIB::FiffCoordTrans &t=FIFFLIB::FiffCoordTrans())
static FwdCoilSet::UPtr read_coil_defs (const QString &name)

Public Attributes

std::vector< FwdCoil::UPtr > coils
int coord_frame
std::unique_ptr< FwdBemSolution > user_data

Detailed Description

Collection of FwdCoil objects representing a full MEG or EEG sensor array.

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

Definition at line 76 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 80 of file fwd_coil_set.h.

◆ SPtr

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

Shared pointer type for FwdCoilSet.

Definition at line 79 of file fwd_coil_set.h.

◆ UPtr

typedef std::unique_ptr<FwdCoilSet> FWDLIB::FwdCoilSet::UPtr

Unique pointer type for FwdCoilSet.

Definition at line 81 of file fwd_coil_set.h.

Constructor & Destructor Documentation

◆ FwdCoilSet()

FwdCoilSet::FwdCoilSet ( )

Constructs the Forward Coil Set description

Definition at line 136 of file fwd_coil_set.cpp.

◆ ~FwdCoilSet()

FwdCoilSet::~FwdCoilSet ( )

Destroys the Forward Coil Set description

Definition at line 143 of file fwd_coil_set.cpp.

Member Function Documentation

◆ create_eeg_els()

FwdCoilSet::UPtr FwdCoilSet::create_eeg_els ( const QList< FIFFLIB::FiffChInfo > & chs,
int nch,
const FIFFLIB::FiffCoordTrans & t = FIFFLIB::FiffCoordTrans() )
static

Create a EEG coil set definition using a channel information Change the coordinate frame if so desired

Parameters
[in]chChannel information to use.
[in]nchNumber of channels.
[in]tTransform the points using this.
Returns
The created meg coil set.

Definition at line 230 of file fwd_coil_set.cpp.

◆ create_meg_coil()

FwdCoil::UPtr FwdCoilSet::create_meg_coil ( const FIFFLIB::FiffChInfo & ch,
int acc,
const FIFFLIB::FiffCoordTrans & t = FIFFLIB::FiffCoordTrans() )

Create a MEG coil definition using a database of templates Change the coordinate frame if so desired

Parameters
[in]chChannel information to use.
[in]accRequired accuracy.
[in]tTransform the points using this.
Returns
The created meg coil.

Definition at line 149 of file fwd_coil_set.cpp.

◆ create_meg_coils()

FwdCoilSet::UPtr FwdCoilSet::create_meg_coils ( const QList< FIFFLIB::FiffChInfo > & chs,
int nch,
int acc,
const FIFFLIB::FiffCoordTrans & t = FIFFLIB::FiffCoordTrans() )

Create a MEG coil set definition using a database of templates Change the coordinate frame if so desired

Parameters
[in]chChannel information to use.
[in]nchNumber of channels.
[in]accRequired accuracy.
[in]tTransform the points using this.
Returns
The created meg coil set.

Definition at line 210 of file fwd_coil_set.cpp.

◆ dup_coil_set()

FwdCoilSet::UPtr FwdCoilSet::dup_coil_set ( const FIFFLIB::FiffCoordTrans & t = FIFFLIB::FiffCoordTrans()) const

Make a coil set duplicate

Parameters
[in]tTransformation which should be applied to the duplicate.
Returns
The duplicated coil set.

Definition at line 334 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.

Parameters
[in]typeThis is the coil type we are interested in.
Returns
True if set contains an axial coil of specified type, false otherwise.

Definition at line 388 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.

Parameters
[in]typeThis is the coil type we are interested in.
Returns
True if set contains an EEG electrode of specified type, false otherwise.

Definition at line 414 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.

Parameters
[in]typeThis is the coil type we are interested in.
Returns
True if set contains a magnetometer of specified type, false otherwise.

Definition at line 402 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.

Parameters
[in]typeThis is the coil type we are interested in.
Returns
True if set contains a planar coil of specified type, false otherwise.

Definition at line 376 of file fwd_coil_set.cpp.

◆ ncoil()

int FWDLIB::FwdCoilSet::ncoil ( ) const
inline

Number of coils (convenience accessor).

Definition at line 223 of file fwd_coil_set.h.

◆ read_coil_defs()

FwdCoilSet::UPtr FwdCoilSet::read_coil_defs ( const QString & name)
static

Read a coil definitions from file

Parameters
[in]nameFile name to read from.
Returns
The read meg coil set.

Definition at line 249 of file fwd_coil_set.cpp.

Member Data Documentation

◆ coils

std::vector<FwdCoil::UPtr> FWDLIB::FwdCoilSet::coils

The coil or electrode positions.

Definition at line 218 of file fwd_coil_set.h.

◆ coord_frame

int FWDLIB::FwdCoilSet::coord_frame

Common coordinate frame.

Definition at line 219 of file fwd_coil_set.h.

◆ user_data

std::unique_ptr<FwdBemSolution> FWDLIB::FwdCoilSet::user_data

Coil-specific BEM solution.

Definition at line 220 of file fwd_coil_set.h.

The documentation for this class was generated from the following files:
Generated on for MNE-CPP by doxygen 1.16.1