MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FIFFLIB::FiffChPos Class Reference

Measurement channel position and coil type. More...

#include <fiff_ch_pos.h>

Public Types

typedef QSharedPointer< FiffChPosSPtr
 
typedef QSharedPointer< const FiffChPosConstSPtr
 

Public Member Functions

 FiffChPos ()
 
 FiffChPos (const FiffChPos &p_FiffChPos)
 
 ~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

Measurement channel position and coil type.

Coil position description (Replaces fiffChPosRec,*fiffChPos; struct of MNE-C fiff_types.h).

Definition at line 66 of file fiff_ch_pos.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const FiffChPos> FIFFLIB::FiffChPos::ConstSPtr

Const shared pointer type for FiffChPos.

Definition at line 70 of file fiff_ch_pos.h.

◆ SPtr

typedef QSharedPointer<FiffChPos> FIFFLIB::FiffChPos::SPtr

Shared pointer type for FiffChPos.

Definition at line 69 of file fiff_ch_pos.h.

Constructor & Destructor Documentation

◆ FiffChPos() [1/2]

FiffChPos::FiffChPos ( )

Constructors the coil position descriptor.

Definition at line 53 of file fiff_ch_pos.cpp.

◆ FiffChPos() [2/2]

FiffChPos::FiffChPos ( const FiffChPos p_FiffChPos)

Copy constructor.

Parameters
[in]p_FiffChPosCoil position descriptor which should be copied.

Definition at line 67 of file fiff_ch_pos.cpp.

◆ ~FiffChPos()

FiffChPos::~FiffChPos ( )

Destroys the coil position descriptor.

Definition at line 81 of file fiff_ch_pos.cpp.

Member Function Documentation

◆ 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 134 of file fiff_ch_pos.h.

Friends And Related Function Documentation

◆ operator==

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

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

Parameters
[in]objectThe object which should be compared to.
Returns
true if equal, false otherwise.

Definition at line 141 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 111 of file fiff_ch_pos.h.

◆ ex

Eigen::Vector3f FIFFLIB::FiffChPos::ex

Coil coordinate system x-axis unit vector.

Definition at line 113 of file fiff_ch_pos.h.

◆ ey

Eigen::Vector3f FIFFLIB::FiffChPos::ey

Coil coordinate system y-axis unit vector.

Definition at line 114 of file fiff_ch_pos.h.

◆ ez

Eigen::Vector3f FIFFLIB::FiffChPos::ez

Coil coordinate system z-axis unit vector.

Definition at line 115 of file fiff_ch_pos.h.

◆ r0

Eigen::Vector3f FIFFLIB::FiffChPos::r0

Coil coordinate system origin.

Definition at line 112 of file fiff_ch_pos.h.


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