FIFFLIB::FiffDigitizerData Class Reference

Digitization points container and description. More...

#include <fiff_digitizer_data.h>

Public Types
typedef QSharedPointer< FiffDigitizerData >	SPtr
typedef QSharedPointer< const FiffDigitizerData >	ConstSPtr

Public Member Functions
	FiffDigitizerData ()
	FiffDigitizerData (const FiffDigitizerData &p_FiffDigitizerData)
FiffDigitizerData &	operator= (const FiffDigitizerData &rhs)
	FiffDigitizerData (QIODevice &p_IODevice)
	~FiffDigitizerData ()
void	print () const
int	nfids () const
void	pickCardinalFiducials ()

Public Attributes
QString	filename
std::unique_ptr< FiffCoordTrans >	head_mri_t
std::unique_ptr< FiffCoordTrans >	head_mri_t_adj
QList< FIFFLIB::FiffDigPoint >	points
int	coord_frame
QList< int >	active
QList< int >	discard
int	npoint
QList< FIFFLIB::FiffDigPoint >	mri_fids
bool	show
bool	show_minimal
Eigen::VectorXf	dist
Eigen::VectorXi	closest
Eigen::Matrix< float, Eigen::Dynamic, 3, Eigen::RowMajor >	closest_point
bool	dist_valid

Detailed Description

Digitization points container and description.

Digitizer data including points and transformations.

Definition at line 82 of file fiff_digitizer_data.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FiffDigitizerData.

Definition at line 86 of file fiff_digitizer_data.h.

SPtr

typedef QSharedPointer<FiffDigitizerData> FIFFLIB::FiffDigitizerData::SPtr

Shared pointer type for FiffDigitizerData.

Definition at line 85 of file fiff_digitizer_data.h.

Constructor & Destructor Documentation

FiffDigitizerData() [1/3]

FiffDigitizerData::FiffDigitizerData

(

)

Constructs the FiffDigitizerData.

Definition at line 57 of file fiff_digitizer_data.cpp.

FiffDigitizerData() [2/3]

FiffDigitizerData::FiffDigitizerData

(

const FiffDigitizerData &

p_FiffDigitizerData

)

Copy constructor.

Parameters

[in]

p_FiffDigitizerData

Digitization point descriptor which should be copied.

Definition at line 72 of file fiff_digitizer_data.cpp.

FiffDigitizerData() [3/3]

FiffDigitizerData::FiffDigitizerData

(

QIODevice &

p_IODevice

)

Constructs a FiffDigitizerData by reading from an IO device.

Parameters

[in]

p_IODevice

Input device to read data from.

Definition at line 116 of file fiff_digitizer_data.cpp.

~FiffDigitizerData()

FiffDigitizerData::~FiffDigitizerData ( )

default

Destroys the digitization point description.

Member Function Documentation

nfids()

int FIFFLIB::FiffDigitizerData::nfids ( ) const

inline

Returns the number of MRI fiducial points (cardinal points transformed into MRI coordinates via head_mri_t_adj).

Kept as nfids() for API compatibility with the original MNE C code (digitizerDataRec.nfids in mne_analyze/analyze_types.h).

Returns

Number of fiducials in mri_fids.

Definition at line 178 of file fiff_digitizer_data.h.

operator=()

FiffDigitizerData & FiffDigitizerData::operator=

(

const FiffDigitizerData &

rhs

)

Copy assignment operator (deep-copies unique_ptr members).

Parameters

[in]

rhs

Digitization point descriptor to assign from.

Returns

Reference to this object.

Definition at line 92 of file fiff_digitizer_data.cpp.

pickCardinalFiducials()

void FiffDigitizerData::pickCardinalFiducials

(

)

Extracts cardinal digitizer points (LPA, Nasion, RPA) from the digitizer point list and transforms them into MRI coordinates using head_mri_t_adj, populating the mri_fids list.

This is a port of the original C function update_fids_from_dig_data from mne_analyze/adjust_alignment.c.

Definition at line 178 of file fiff_digitizer_data.cpp.

print()

void FiffDigitizerData::print

(

)

const

Prints class contents.

Definition at line 150 of file fiff_digitizer_data.cpp.

Member Data Documentation

active

QList<int> FIFFLIB::FiffDigitizerData::active

Which points are active.

Definition at line 161 of file fiff_digitizer_data.h.

closest

Eigen::VectorXi FIFFLIB::FiffDigitizerData::closest

Closest vertex number on the head surface.

Definition at line 168 of file fiff_digitizer_data.h.

closest_point

Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> FIFFLIB::FiffDigitizerData::closest_point

Closest vertex locations on the head surface (npoint x 3).

Definition at line 169 of file fiff_digitizer_data.h.

coord_frame

int FIFFLIB::FiffDigitizerData::coord_frame

The coordinate frame of the above points.

Definition at line 160 of file fiff_digitizer_data.h.

discard

QList<int> FIFFLIB::FiffDigitizerData::discard

Which points should be discarded.

Definition at line 162 of file fiff_digitizer_data.h.

dist

Eigen::VectorXf FIFFLIB::FiffDigitizerData::dist

Distance of each point from the head surface.

Definition at line 167 of file fiff_digitizer_data.h.

dist_valid

bool FIFFLIB::FiffDigitizerData::dist_valid

Whether the above distance data is valid.

Definition at line 170 of file fiff_digitizer_data.h.

filename

QString FIFFLIB::FiffDigitizerData::filename

Source file path.

Definition at line 156 of file fiff_digitizer_data.h.

head_mri_t

std::unique_ptr<FiffCoordTrans> FIFFLIB::FiffDigitizerData::head_mri_t

Head to MRI coordinate transformation.

Definition at line 157 of file fiff_digitizer_data.h.

head_mri_t_adj

std::unique_ptr<FiffCoordTrans> FIFFLIB::FiffDigitizerData::head_mri_t_adj

Adjusted head to MRI transformation.

Definition at line 158 of file fiff_digitizer_data.h.

mri_fids

QList<FIFFLIB::FiffDigPoint> FIFFLIB::FiffDigitizerData::mri_fids

MRI coordinate system fiducials.

Definition at line 164 of file fiff_digitizer_data.h.

npoint

int FIFFLIB::FiffDigitizerData::npoint

Number of points.

Definition at line 163 of file fiff_digitizer_data.h.

points

QList<FIFFLIB::FiffDigPoint> FIFFLIB::FiffDigitizerData::points

The digitizer points.

Definition at line 159 of file fiff_digitizer_data.h.

show

bool FIFFLIB::FiffDigitizerData::show

Whether the digitizer data should be shown.

Definition at line 165 of file fiff_digitizer_data.h.

show_minimal

bool FIFFLIB::FiffDigitizerData::show_minimal

Show fiducials and coils only.

Definition at line 166 of file fiff_digitizer_data.h.

---

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

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