UTILSLIB::AcquiredPoints Class Reference

In-memory store of all points captured during a session. More...

#include <acquired_points.h>

Signals
void	pointsChanged ()

Public Member Functions
	AcquiredPoints (QObject *parent=nullptr)
const QVector< DigitizedPoint > &	points () const
void	append (const DigitizedPoint &p)
void	undoLast (PointKind kind)
void	clear ()
QVector3D	fiducial (FiducialId id) const
bool	hasFiducial (FiducialId id) const
void	removeFiducial (FiducialId id)
bool	hasAllFiducials () const
int	countOf (PointKind kind) const
void	setPosition (int index, const QVector3D &pos)
void	emitChanged ()
void	setTwinFiducial (FiducialId id, const QVector3D &pos)
void	clearTwinFiducial (FiducialId id)
bool	hasTwinFiducial (FiducialId id) const
QVector3D	twinFiducial (FiducialId id) const
bool	hasAllTwinFiducials () const

Detailed Description

In-memory store of all points captured during a session.

The wizard hands one of these to the 3-D view (for visualisation) and later to the export step (for FIFF write). Single-threaded, no locking.

Definition at line 95 of file acquired_points.h.

Inheritance diagram for UTILSLIB::AcquiredPoints:

Constructor & Destructor Documentation

AcquiredPoints()

UTILSLIB::AcquiredPoints::AcquiredPoints ( QObject * parent = nullptr )

inlineexplicit

Definition at line 99 of file acquired_points.h.

Member Function Documentation

append()

void UTILSLIB::AcquiredPoints::append ( const DigitizedPoint & p )

inline

Append a new point and emit UTILSLIB::AcquiredPoints::pointsChanged "pointsChanged".

Parameters

[in]

p

Captured point to append.

Definition at line 114 of file acquired_points.h.

clear()

void UTILSLIB::AcquiredPoints::clear ( )

inline

Drop every captured point.

Definition at line 137 of file acquired_points.h.

clearTwinFiducial()

void UTILSLIB::AcquiredPoints::clearTwinFiducial ( FiducialId id )

inline

Definition at line 232 of file acquired_points.h.

countOf()

int UTILSLIB::AcquiredPoints::countOf ( PointKind kind ) const

inline

Definition at line 204 of file acquired_points.h.

emitChanged()

void UTILSLIB::AcquiredPoints::emitChanged ( )

inline

Definition at line 219 of file acquired_points.h.

fiducial()

QVector3D UTILSLIB::AcquiredPoints::fiducial ( FiducialId id ) const

inline

Convenience accessor: returns the captured fiducial position for id, or a default-constructed QVector3D if not yet captured.

Parameters

[in]

id

Fiducial to look up.

Returns

Captured fiducial position, or a zero vector if not yet captured.

Definition at line 152 of file acquired_points.h.

hasAllFiducials()

bool UTILSLIB::AcquiredPoints::hasAllFiducials ( ) const

inline

True iff all three cardinal fiducials have been captured.

Returns

True if NAS, LPA, and RPA have all been captured.

Definition at line 199 of file acquired_points.h.

hasAllTwinFiducials()

bool UTILSLIB::AcquiredPoints::hasAllTwinFiducials ( ) const

inline

Definition at line 248 of file acquired_points.h.

hasFiducial()

bool UTILSLIB::AcquiredPoints::hasFiducial ( FiducialId id ) const

inline

True iff a fiducial of the given id has been captured.

Parameters

[in]

id

Fiducial to check.

Returns

True if the fiducial has been captured, false otherwise.

Definition at line 169 of file acquired_points.h.

hasTwinFiducial()

bool UTILSLIB::AcquiredPoints::hasTwinFiducial ( FiducialId id ) const

inline

Definition at line 238 of file acquired_points.h.

points()

const QVector< DigitizedPoint > & UTILSLIB::AcquiredPoints::points ( ) const

inline

Definition at line 104 of file acquired_points.h.

pointsChanged

void UTILSLIB::AcquiredPoints::pointsChanged ( )

signal

removeFiducial()

void UTILSLIB::AcquiredPoints::removeFiducial ( FiducialId id )

inline

Remove a previously captured fiducial so it can be re-recorded.

Parameters

[in]

id

Fiducial whose captured points are all removed.

Definition at line 184 of file acquired_points.h.

setPosition()

void UTILSLIB::AcquiredPoints::setPosition ( int index, const QVector3D & pos )

inline

Definition at line 213 of file acquired_points.h.

setTwinFiducial()

void UTILSLIB::AcquiredPoints::setTwinFiducial ( FiducialId id, const QVector3D & pos )

inline

Definition at line 226 of file acquired_points.h.

twinFiducial()

QVector3D UTILSLIB::AcquiredPoints::twinFiducial ( FiducialId id ) const

inline

Definition at line 243 of file acquired_points.h.

undoLast()

void UTILSLIB::AcquiredPoints::undoLast ( PointKind kind )

inline

Remove the most recently captured point matching kind, if any.

Parameters

[in]

kind

Point kind whose most recent entry is removed.

Definition at line 125 of file acquired_points.h.

---

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

• src/libraries/utils/polhemus/acquired_points.h