MNE-CPP  beta 1.0
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
RTINVLIB::RtAve Class Reference

Real-time averaging helper. More...

#include <rtave.h>

Inheritance diagram for RTINVLIB::RtAve:

Public Types

typedef QSharedPointer< RtAveSPtr
 
typedef QSharedPointer< const RtAveConstSPtr
 

Signals

void evokedPreStim (FIFFLIB::FiffEvoked::SPtr p_pEvokedPreStim)
 
void evokedPostStim (FIFFLIB::FiffEvoked::SPtr p_pEvokedPostStim)
 
void evokedStim (FIFFLIB::FiffEvoked::SPtr p_pEvokedStim)
 
void numAveragesChanged ()
 

Public Member Functions

 RtAve (quint32 numAverages, quint32 p_iPreStimSamples, quint32 p_iPostStimSamples, FiffInfo::SPtr p_pFiffInfo, QObject *parent=0)
 
 ~RtAve ()
 
void append (const MatrixXd &p_DataSegment)
 
void setAverages (qint32 numAve)
 
void setPreStim (qint32 samples)
 
void setPostStim (qint32 samples)
 
virtual bool start ()
 
virtual bool stop ()
 
bool isRunning ()
 

Protected Member Functions

virtual void run ()
 

Detailed Description

Real-time averaging helper.

Real-time averaging and returns evoked data

Definition at line 109 of file rtave.h.

Member Typedef Documentation

typedef QSharedPointer<const RtAve> RTINVLIB::RtAve::ConstSPtr

Const shared pointer type for RtCov.

Definition at line 114 of file rtave.h.

typedef QSharedPointer<RtAve> RTINVLIB::RtAve::SPtr

Shared pointer type for RtCov.

Definition at line 113 of file rtave.h.

Constructor & Destructor Documentation

RtAve::RtAve ( quint32  numAverages,
quint32  p_iPreStimSamples,
quint32  p_iPostStimSamples,
FiffInfo::SPtr  p_pFiffInfo,
QObject *  parent = 0 
)
explicit

Creates the real-time covariance estimation object.

Parameters
[in]numAveragesNumber of evkos to average
[in]p_iPreStimSamplesNumber of samples averaged before the stimulus
[in]p_iPostStimSamplesNumber of samples averaged after the stimulus (including the stimulus)
[in]p_pFiffInfoAssociated Fiff Information
[in]parentParent QObject (optional)

Definition at line 74 of file rtave.cpp.

RtAve::~RtAve ( )

Destroys the Real-time covariance estimation object.

Definition at line 89 of file rtave.cpp.

Member Function Documentation

void RtAve::append ( const MatrixXd &  p_DataSegment)

Slot to receive incoming data.

Parameters
[in]p_DataSegmentData to estimate the covariance from -> ToDo Replace this by shared data pointer

Definition at line 98 of file rtave.cpp.

void RTINVLIB::RtAve::evokedPostStim ( FIFFLIB::FiffEvoked::SPtr  p_pEvokedPostStim)
signal

Signal which is emitted when new evoked post stimulus data are available.

Parameters
[out]p_pEvokedPostStimThe evoked post stimulus data
void RTINVLIB::RtAve::evokedPreStim ( FIFFLIB::FiffEvoked::SPtr  p_pEvokedPreStim)
signal

Signal which is emitted when new evoked pre stimulus data are available.

Parameters
[out]p_pEvokedPreStimThe evoked pre stimulus data
void RTINVLIB::RtAve::evokedStim ( FIFFLIB::FiffEvoked::SPtr  p_pEvokedStim)
signal

Signal which is emitted when new evoked stimulus data are available.

Parameters
[out]p_pEvokedStimThe evoked stimulus data
bool RTINVLIB::RtAve::isRunning ( )
inline

Returns true if is running, otherwise false.

Returns
true if is running, false otherwise

Definition at line 284 of file rtave.h.

void RTINVLIB::RtAve::numAveragesChanged ( )
signal

Emitted when number of averages changed

void RtAve::run ( )
protectedvirtual

The starting point for the thread. After calling start(), the newly created thread calls this function. Returning from this method will end the execution of the thread. Pure virtual method inherited by QThread.

Definition at line 324 of file rtave.cpp.

void RtAve::setAverages ( qint32  numAve)

Sets the number of averages

Parameters
[in]numAvenew number of averages

Definition at line 111 of file rtave.cpp.

void RtAve::setPostStim ( qint32  samples)

Sets the number of post stimulus samples

Parameters
[in]samplesnew number of post stimulus samples

Definition at line 131 of file rtave.cpp.

void RtAve::setPreStim ( qint32  samples)

Sets the number of pre stimulus samples

Parameters
[in]samplesnew number of pre stimulus samples

Definition at line 122 of file rtave.cpp.

bool RtAve::start ( )
virtual

Starts the RtAve by starting the producer's thread.

Definition at line 290 of file rtave.cpp.

bool RtAve::stop ( )
virtual

Stops the RtAve by stopping the producer's thread.

Returns
true if succeeded, false otherwise

Definition at line 308 of file rtave.cpp.


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