FIFFLIB::FiffChPos Class Reference

Channel coil-frame placement: origin r0 (m) and orthonormal axes ex / ey / ez in FIFFV_COORD_DEVICE. More...

#include <fiff_ch_pos.h>

Public Types
using	SPtr = QSharedPointer<FiffChPos>
using	ConstSPtr = QSharedPointer<const FiffChPos>
using	UPtr = std::unique_ptr<FiffChPos>
using	ConstUPtr = std::unique_ptr<const FiffChPos>

Public Member Functions
	FiffChPos ()
	FiffChPos (const FiffChPos &p_FiffChPos)
FiffChPos &	operator= (const FiffChPos &other)=default
	~FiffChPos ()

Static Public Member Functions
static qint32	storageSize ()

Public Attributes
fiff_int_t	coil_type
Eigen::Vector3f	r0
Eigen::Vector3f	ex
Eigen::Vector3f	ey
Eigen::Vector3f	ez

Friends
bool	operator== (const FiffChPos &a, const FiffChPos &b)

Detailed Description

Channel coil-frame placement: origin r0 (m) and orthonormal axes ex / ey / ez in FIFFV_COORD_DEVICE.

Twelve floats laid out exactly like the fiffChPosRec struct: three for r0 and three each for ex, ey, ez. Consumed by forward-solution coil integration and by sensor visualization to draw oriented coil glyphs in the device frame.

Definition at line 64 of file fiff_ch_pos.h.

Member Typedef Documentation

ConstSPtr

using FIFFLIB::FiffChPos::ConstSPtr = QSharedPointer<const FiffChPos>

Const shared pointer type for FiffChPos.

Definition at line 68 of file fiff_ch_pos.h.

ConstUPtr

using FIFFLIB::FiffChPos::ConstUPtr = std::unique_ptr<const FiffChPos>

Const unique pointer type for FiffChPos.

Definition at line 70 of file fiff_ch_pos.h.

SPtr

using FIFFLIB::FiffChPos::SPtr = QSharedPointer<FiffChPos>

Shared pointer type for FiffChPos.

Definition at line 67 of file fiff_ch_pos.h.

UPtr

using FIFFLIB::FiffChPos::UPtr = std::unique_ptr<FiffChPos>

Unique pointer type for FiffChPos.

Definition at line 69 of file fiff_ch_pos.h.

Constructor & Destructor Documentation

FiffChPos() [1/2]

FiffChPos::FiffChPos

(

)

Constructs the coil position descriptor.

Definition at line 35 of file fiff_ch_pos.cpp.

FiffChPos() [2/2]

FiffChPos::FiffChPos

(

const FiffChPos &

p_FiffChPos

)

Copy constructor.

Parameters

[in]

p_FiffChPos

Coil position descriptor which should be copied.

Definition at line 46 of file fiff_ch_pos.cpp.

~FiffChPos()

FiffChPos::~FiffChPos

(

)

Destroys the coil position descriptor.

Definition at line 59 of file fiff_ch_pos.cpp.

Member Function Documentation

operator=()

FiffChPos & FIFFLIB::FiffChPos::operator= ( const FiffChPos & other )

default

Copy assignment. Every member has value semantics, so the compiler-generated member-wise assignment is correct. It is declared explicitly because declaring a copy constructor and/or a destructor deprecates the implicitly generated one.

Parameters

[in]

other

Object to assign from.

Returns

reference to this object.

storageSize()

qint32 FIFFLIB::FiffChPos::storageSize ( )

inlinestatic

Size of the old struct (fiffChPosRec) 13*int = 13*4 = 52

Returns

the size of the old struct fiffChPosRec.

Definition at line 136 of file fiff_ch_pos.h.

Friends And Related Symbol Documentation

operator==

bool operator== ( const FiffChPos & a, const FiffChPos & b )

friend

Overloaded == operator to compare an object to this instance.

Parameters

[in]	a	The object which should be compared to.
[in]	b	Right-hand channel position.

Returns

true if equal, false otherwise.

Definition at line 143 of file fiff_ch_pos.h.

Member Data Documentation

coil_type

fiff_int_t FIFFLIB::FiffChPos::coil_type

What kind of coil.

Definition at line 125 of file fiff_ch_pos.h.

ex

Eigen::Vector3f FIFFLIB::FiffChPos::ex

Coil coordinate system x-axis unit vector.

Definition at line 127 of file fiff_ch_pos.h.

ey

Eigen::Vector3f FIFFLIB::FiffChPos::ey

Coil coordinate system y-axis unit vector.

Definition at line 128 of file fiff_ch_pos.h.

ez

Eigen::Vector3f FIFFLIB::FiffChPos::ez

Coil coordinate system z-axis unit vector.

Definition at line 129 of file fiff_ch_pos.h.

r0

Eigen::Vector3f FIFFLIB::FiffChPos::r0

Coil coordinate system origin.

Definition at line 126 of file fiff_ch_pos.h.

---

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

• src/libraries/fiff/fiff_ch_pos.h
• src/libraries/fiff/fiff_ch_pos.cpp