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

Holds a set of digitizer points. More...

#include <fiff_dig_point_set.h>

Public Types

typedef QSharedPointer< FiffDigPointSetSPtr
 
typedef QSharedPointer< const FiffDigPointSetConstSPtr
 

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 FiffDigPointoperator[] (qint32 idx) const
 
FiffDigPointoperator[] (qint32 idx)
 
FiffDigPointSet pickTypes (QList< int > includeTypes) const
 
FiffDigPointSetoperator<< (const FiffDigPoint &dig)
 
FiffDigPointSetoperator<< (const FiffDigPoint *dig)
 
void applyTransform (const FiffCoordTrans &coordTrans, bool bApplyInverse=false)
 
QList< FiffDigPointgetList ()
 

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

Const shared pointer type for FiffDigPointSet.

Definition at line 88 of file fiff_dig_point_set.h.

◆ 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]pointListlist 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 96 of file fiff_dig_point_set.cpp.

◆ ~FiffDigPointSet()

FiffDigPointSet::~FiffDigPointSet ( )

Destroys the FiffDigPointSet

Definition at line 113 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]coordTransFiffCoordTrans which is to be applied.
[in]bApplyInverseWhether to apply the inverse. False by default.

Definition at line 288 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 309 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]digFiffDigPoint to be added.
Returns
FiffDigPointSet.

Definition at line 272 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]digFiffDigPoint to be added.
Returns
FiffDigPointSet.

Definition at line 280 of file fiff_dig_point_set.cpp.

◆ operator[]() [1/2]

const FiffDigPoint & FiffDigPointSet::operator[] ( qint32  idx) const

Subscript operator [] to access FiffDigPoint by index

Parameters
[in]idxthe FiffDigPoint index.
Returns
FiffDigPoint related to the parameter index.

Definition at line 233 of file fiff_dig_point_set.cpp.

◆ operator[]() [2/2]

FiffDigPoint & FiffDigPointSet::operator[] ( qint32  idx)

Subscript operator [] to access FiffDigPoint by index

Parameters
[in]idxthe FiffDigPoint index.
Returns
FiffDigPoint related to the parameter index.

Definition at line 245 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]includeTypesThe 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 257 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

Definition at line 119 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 199 of file fiff_dig_point_set.cpp.

◆ writeToStream()

void FiffDigPointSet::writeToStream ( FiffStream p_pStream)

writeToStream

Parameters
[in]p_pStream.

Definition at line 214 of file fiff_dig_point_set.cpp.


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