v2.0.0
Loading...
Searching...
No Matches
FIFFLIB::FiffDigPoint Class Reference

One digitizer point: kind (cardinal/HPI/EEG/extra), ident, 3D position in FIFFV_COORD_HEAD. More...

#include <fiff_dig_point.h>

Public Types

using SPtr = QSharedPointer<FiffDigPoint>
using ConstSPtr = QSharedPointer<const FiffDigPoint>
using UPtr = std::unique_ptr<FiffDigPoint>
using ConstUPtr = std::unique_ptr<const FiffDigPoint>

Public Member Functions

 FiffDigPoint ()
 ~FiffDigPoint ()=default

Static Public Member Functions

static qint32 storageSize ()

Public Attributes

fiff_int_t kind
fiff_int_t ident
fiff_float_t r [3]
fiff_int_t coord_frame

Detailed Description

One digitizer point: kind (cardinal/HPI/EEG/extra), ident, 3D position in FIFFV_COORD_HEAD.

Field layout matches fiffDigPointRec on disk. The (kind, ident) pair is the lookup key used everywhere else in the codebase — for example, the LPA/Nasion/RPA fiducials are found by searching for kind == FIFFV_POINT_CARDINAL and ident == 1 / 2 / 3.

Definition at line 67 of file fiff_dig_point.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffDigPoint.

Definition at line 71 of file fiff_dig_point.h.

◆ ConstUPtr

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

Const unique pointer type for FiffDigPoint.

Definition at line 73 of file fiff_dig_point.h.

◆ SPtr

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

Shared pointer type for FiffDigPoint.

Definition at line 70 of file fiff_dig_point.h.

◆ UPtr

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

Unique pointer type for FiffDigPoint.

Definition at line 72 of file fiff_dig_point.h.

Constructor & Destructor Documentation

◆ FiffDigPoint()

FiffDigPoint::FiffDigPoint ( )

Constructs the digitization point description

Definition at line 41 of file fiff_dig_point.cpp.

◆ ~FiffDigPoint()

FIFFLIB::FiffDigPoint::~FiffDigPoint ( )
default

Destroys the digitization point description

Member Function Documentation

◆ storageSize()

qint32 FIFFLIB::FiffDigPoint::storageSize ( )
inlinestatic

Size of the old struct (fiffDigPointRec) 5*int = 5*4 = 20

Returns
the size of the old struct fiffDigPointRec.

Definition at line 106 of file fiff_dig_point.h.

Member Data Documentation

◆ coord_frame

fiff_int_t FIFFLIB::FiffDigPoint::coord_frame

Newly added to stay consistent with fiff MATLAB implementation.

Definition at line 99 of file fiff_dig_point.h.

◆ ident

fiff_int_t FIFFLIB::FiffDigPoint::ident

Number identifying this point.

Definition at line 97 of file fiff_dig_point.h.

◆ kind

fiff_int_t FIFFLIB::FiffDigPoint::kind

FIFFV_POINT_CARDINAL, FIFFV_POINT_HPI, FIFFV_POINT_EXTRA or FIFFV_POINT_EEG.

Definition at line 96 of file fiff_dig_point.h.

◆ r

fiff_float_t FIFFLIB::FiffDigPoint::r[3]

Point location.

Definition at line 98 of file fiff_dig_point.h.


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