Single MEG or EEG sensor coil with integration points, weights, and coordinate frame. More...

#include <fwd_coil.h>

Public Types
typedef std::unique_ptr< FwdCoil >	UPtr

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
Eigen::Map< const Eigen::Vector3f >	pos (int j) const
Eigen::Map< const Eigen::Vector3f >	dir (int j) const

Static Public Member Functions
static FwdCoil::UPtr	create_eeg_el (const FIFFLIB::FiffChInfo &ch, const FIFFLIB::FiffCoordTrans &t=FIFFLIB::FiffCoordTrans())

Public Attributes
QString	chname
int	coord_frame
QString	desc
int	coil_class
int	type
int	accuracy
float	size
float	base
Eigen::Vector3f	r0
Eigen::Vector3f	ex
Eigen::Vector3f	ey
Eigen::Vector3f	ez
int	np
Eigen::Matrix< float, Eigen::Dynamic, 3, Eigen::RowMajor >	rmag
Eigen::Matrix< float, Eigen::Dynamic, 3, Eigen::RowMajor >	cosmag
Eigen::VectorXf	w

Detailed Description

Single MEG or EEG sensor coil with integration points, weights, and coordinate frame.

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

Definition at line 92 of file fwd_coil.h.

Member Typedef Documentation

◆ UPtr

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

Unique pointer type for FwdCoil.

Definition at line 95 of file fwd_coil.h.

Constructor & Destructor Documentation

◆ FwdCoil() [1/2]

FwdCoil::FwdCoil ( int p_np )

Constructs the Forward Coil

Definition at line 66 of file fwd_coil.cpp.

◆ FwdCoil() [2/2]

FwdCoil::FwdCoil ( const FwdCoil & p_FwdCoil )

Copy constructor.

Parameters

[in] p_FwdCoil FwdCoil which should be copied.

Definition at line 92 of file fwd_coil.cpp.

◆ ~FwdCoil()

FwdCoil::~FwdCoil ( )

Destroys the Forward Coil description

Definition at line 119 of file fwd_coil.cpp.

Member Function Documentation

◆ create_eeg_el()

FwdCoil::UPtr FwdCoil::create_eeg_el	(	const FIFFLIB::FiffChInfo &	ch,
		const FIFFLIB::FiffCoordTrans &	t = FIFFLIB::FiffCoordTrans() )

static

Create an electrode definition. Transform coordinate frame if so desired.

Parameters

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

Returns: The created coil.

Definition at line 125 of file fwd_coil.cpp.

◆ dir()

Eigen::Map< const Eigen::Vector3f > FWDLIB::FwdCoil::dir ( int j ) const

inline

Return a read-only map to the j-th integration point direction cosine.

Definition at line 182 of file fwd_coil.h.

◆ is_axial_coil()

bool FwdCoil::is_axial_coil ( ) const

Checks if this is an axial coil.

Returns: True if axial coil, false otherwise.

Definition at line 180 of file fwd_coil.cpp.

◆ is_eeg_electrode()

bool FwdCoil::is_eeg_electrode ( ) const

Checks if this is an EEG electrode.

Returns: True if EEG electrode, false otherwise.

Definition at line 203 of file fwd_coil.cpp.

◆ is_magnetometer_coil()

bool FwdCoil::is_magnetometer_coil ( ) const

Checks if this is an magnetometer.

Returns: True if magnetometer, false otherwise.

Definition at line 189 of file fwd_coil.cpp.

◆ is_planar_coil()

bool FwdCoil::is_planar_coil ( ) const

Checks if this is an planar coil.

Returns: True if planar coil, false otherwise.

Definition at line 196 of file fwd_coil.cpp.

◆ pos()

Eigen::Map< const Eigen::Vector3f > FWDLIB::FwdCoil::pos ( int j ) const

inline

Return a read-only map to the j-th integration point position (3 contiguous floats).

Definition at line 180 of file fwd_coil.h.

Member Data Documentation

◆ accuracy

int FWDLIB::FwdCoil::accuracy

Accuracy.

Definition at line 167 of file fwd_coil.h.

◆ base

float FWDLIB::FwdCoil::base

Baseline.

Definition at line 169 of file fwd_coil.h.

◆ chname

QString FWDLIB::FwdCoil::chname

Name of this channel.

Definition at line 162 of file fwd_coil.h.

◆ coil_class

int FWDLIB::FwdCoil::coil_class

Coil class.

Definition at line 165 of file fwd_coil.h.

◆ coord_frame

int FWDLIB::FwdCoil::coord_frame

Which coordinate frame are we in?.

Definition at line 163 of file fwd_coil.h.

◆ cosmag

Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> FWDLIB::FwdCoil::cosmag

The corresponding direction cosines (np x 3).

Definition at line 176 of file fwd_coil.h.

◆ desc

QString FWDLIB::FwdCoil::desc

Description for this type of a coil.

Definition at line 164 of file fwd_coil.h.

◆ ex

Eigen::Vector3f FWDLIB::FwdCoil::ex

Coil coordinate system x unit vector.

Definition at line 171 of file fwd_coil.h.

◆ ey

Eigen::Vector3f FWDLIB::FwdCoil::ey

Coil coordinate system y unit vector.

Definition at line 172 of file fwd_coil.h.

◆ ez

Eigen::Vector3f FWDLIB::FwdCoil::ez

Coil coordinate system z unit vector.

Definition at line 173 of file fwd_coil.h.

◆ np

int FWDLIB::FwdCoil::np

Number of integration points.

Definition at line 174 of file fwd_coil.h.

◆ r0

Eigen::Vector3f FWDLIB::FwdCoil::r0

Coil coordinate system origin.

Definition at line 170 of file fwd_coil.h.

◆ rmag

Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> FWDLIB::FwdCoil::rmag

The field point locations (np x 3).

Definition at line 175 of file fwd_coil.h.

◆ size

float FWDLIB::FwdCoil::size

Coil size.

Definition at line 168 of file fwd_coil.h.

◆ type

int FWDLIB::FwdCoil::type

Coil type.

Definition at line 166 of file fwd_coil.h.

◆ w

Eigen::VectorXf FWDLIB::FwdCoil::w

The weighting coefficients.

Definition at line 177 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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes