FIFFLIB::FiffDigPointSet Class Reference

Holds a set of digitizer points. More...

#include <fiff_dig_point_set.h>

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

Public Member Functions
	FiffDigPointSet ()
	FiffDigPointSet (const FiffDigPointSet &p_FiffDigPointSet)
	FiffDigPointSet (QList< FIFFLIB::FiffDigPoint > pointList)
	FiffDigPointSet (QIODevice &p_IODevice)
	~FiffDigPointSet ()
void	clear ()
bool	isEmpty () const
qint32	size () const
void	write (QIODevice &p_IODevice)
	write More...
void	writeToStream (FiffStream *p_pStream)
	writeToStream More...
const FiffDigPoint &	operator[] (qint32 idx) const
FiffDigPoint &	operator[] (qint32 idx)
FiffDigPointSet	pickTypes (QList< int > includeTypes) const
FiffDigPointSet &	operator<< (const FiffDigPoint &dig)
FiffDigPointSet &	operator<< (const FiffDigPoint *dig)
void	applyTransform (const FiffCoordTrans &coordTrans, bool bApplyInverse=false)
QList< FiffDigPoint >	getList ()

Static Public Member Functions
static bool	readFromStream (FiffStream::SPtr &p_Stream, FiffDigPointSet &p_Dig)

Detailed Description

Holds a set of digitizer points.

The FiffDigPointSet hold a set of Digitizer Points and read, write and transform function.

Definition at line 83 of file fiff_dig_point_set.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FiffDigPointSet.

Definition at line 88 of file fiff_dig_point_set.h.

SPtr

typedef QSharedPointer<FiffDigPointSet> FIFFLIB::FiffDigPointSet::SPtr

Shared pointer type for FiffDigPointSet.

Definition at line 87 of file fiff_dig_point_set.h.

Constructor & Destructor Documentation

FiffDigPointSet() [1/4]

FiffDigPointSet::FiffDigPointSet

(

)

Constructs a FiffDigPointSet object.

Definition at line 74 of file fiff_dig_point_set.cpp.

FiffDigPointSet() [2/4]

FiffDigPointSet::FiffDigPointSet

(

const FiffDigPointSet &

p_FiffDigPointSet

)

Copy constructor.

Parameters

[in]

p_FiffDigPointSet.

Definition at line 81 of file fiff_dig_point_set.cpp.

FiffDigPointSet() [3/4]

FiffDigPointSet::FiffDigPointSet

(

QList< FIFFLIB::FiffDigPoint >

pointList

)

Construct FiffDigPointSet based on input pointList

Parameters

[in]

pointList

list of digitizer points

Definition at line 88 of file fiff_dig_point_set.cpp.

FiffDigPointSet() [4/4]

FiffDigPointSet::FiffDigPointSet

(

QIODevice &

p_IODevice

)

Default constructor

Definition at line 95 of file fiff_dig_point_set.cpp.

~FiffDigPointSet()

FiffDigPointSet::~FiffDigPointSet

(

)

Destroys the FiffDigPointSet

Definition at line 112 of file fiff_dig_point_set.cpp.

Member Function Documentation

applyTransform()

void FiffDigPointSet::applyTransform	(	const FiffCoordTrans &	coordTrans,
		bool	bApplyInverse = false
	)

Apply a transforamtion matrix on the 3D position of the digitzed points.

Parameters

[in]	coordTrans	FiffCoordTrans which is to be applied.
[in]	bApplyInverse	Whether to apply the inverse. False by default.

Definition at line 287 of file fiff_dig_point_set.cpp.

clear()

void FIFFLIB::FiffDigPointSet::clear ( )

inline

Initializes FiffDigPointSet

Definition at line 257 of file fiff_dig_point_set.h.

getList()

QList< FiffDigPoint > FiffDigPointSet::getList

(

)

Returns list of digitizer point the set contains

Returns

list of digitizer points

Definition at line 308 of file fiff_dig_point_set.cpp.

isEmpty()

bool FIFFLIB::FiffDigPointSet::isEmpty ( ) const

inline

True if FiffDigPointSet is empty.

Returns

true if MNE Bem is empty.

Definition at line 264 of file fiff_dig_point_set.h.

operator<<() [1/2]

FiffDigPointSet & FiffDigPointSet::operator<<

(

const FiffDigPoint &

dig

)

Subscript operator << to add a new FiffDigPoint

Parameters

[in]

dig

FiffDigPoint to be added.

Returns

FiffDigPointSet.

Definition at line 271 of file fiff_dig_point_set.cpp.

operator<<() [2/2]

FiffDigPointSet & FiffDigPointSet::operator<<

(

const FiffDigPoint *

dig

)

Subscript operator << to add a new FiffDigPoint

Parameters

[in]

dig

FiffDigPoint to be added.

Returns

FiffDigPointSet.

Definition at line 279 of file fiff_dig_point_set.cpp.

operator[]() [1/2]

FiffDigPoint & FiffDigPointSet::operator[]

(

qint32

idx

)

Subscript operator [] to access FiffDigPoint by index

Parameters

[in]

idx

the FiffDigPoint index.

Returns

FiffDigPoint related to the parameter index.

Definition at line 244 of file fiff_dig_point_set.cpp.

operator[]() [2/2]

const FiffDigPoint & FiffDigPointSet::operator[]

(

qint32

idx

)

const

Subscript operator [] to access FiffDigPoint by index

Parameters

[in]

idx

the FiffDigPoint index.

Returns

FiffDigPoint related to the parameter index.

Definition at line 232 of file fiff_dig_point_set.cpp.

pickTypes()

FiffDigPointSet FiffDigPointSet::pickTypes

(

QList< int >

includeTypes

)

const

Pick the wanted types from this set and returns them

Parameters

[in]

includeTypes

The include types (FIFFV_POINT_HPI, FIFFV_POINT_CARDINAL, FIFFV_POINT_EEG, FIFFV_POINT_ECG, FIFFV_POINT_EXTRA, FIFFV_POINT_LPA, FIFFV_POINT_NASION, FIFFV_POINT_RPA).

Returns

FiffDigPointSet.

Definition at line 256 of file fiff_dig_point_set.cpp.

readFromStream()

bool FiffDigPointSet::readFromStream ( FiffStream::SPtr &  p_Stream, FiffDigPointSet &  p_Dig  )

static

Reads FiffDigPointSet from a fif file

Parameters

	+[[]in,out]	p_Stream The opened fif file.
[in,out]	p_Dig	The read digitizer point set.

Returns

true if succeeded, false otherwise.

Definition at line 118 of file fiff_dig_point_set.cpp.

size()

qint32 FIFFLIB::FiffDigPointSet::size ( ) const

inline

Returns the number of stored FiffDigPoints

Returns

number of stored FiffDigPoints.

Definition at line 271 of file fiff_dig_point_set.h.

write()

void FiffDigPointSet::write

(

QIODevice &

p_IODevice

)

write

Parameters

[in]

p_IODevice.

Definition at line 198 of file fiff_dig_point_set.cpp.

writeToStream()

void FiffDigPointSet::writeToStream

(

FiffStream *

p_pStream

)

writeToStream

Parameters

[in]

p_pStream.

Definition at line 213 of file fiff_dig_point_set.cpp.

---

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

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