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

Real-time covariance estimation. More...

#include <rtcov.h>

Inheritance diagram for RTINVLIB::RtCov:

Public Types

typedef QSharedPointer< RtCovSPtr
 
typedef QSharedPointer< const RtCovConstSPtr
 

Signals

void covCalculated (FIFFLIB::FiffCov::SPtr p_pCov)
 

Public Member Functions

 RtCov (qint32 p_iMaxSamples, FiffInfo::SPtr p_pFiffInfo, QObject *parent=0)
 
 ~RtCov ()
 
void append (const MatrixXd &p_DataSegment)
 
bool isRunning ()
 
void setSamples (qint32 samples)
 
virtual bool start ()
 
virtual bool stop ()
 

Protected Member Functions

virtual void run ()
 

Detailed Description

Real-time covariance estimation.

Real-time covariance estimation

Definition at line 107 of file rtcov.h.

Member Typedef Documentation

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

Const shared pointer type for RtCov.

Definition at line 112 of file rtcov.h.

typedef QSharedPointer<RtCov> RTINVLIB::RtCov::SPtr

Shared pointer type for RtCov.

Definition at line 111 of file rtcov.h.

Constructor & Destructor Documentation

RtCov::RtCov ( qint32  p_iMaxSamples,
FiffInfo::SPtr  p_pFiffInfo,
QObject *  parent = 0 
)
explicit

Creates the real-time covariance estimation object.

Parameters
[in]p_iMaxSamplesNumber of samples to use for each data chunk
[in]p_pFiffInfoAssociated Fiff Information
[in]parentParent QObject (optional)

Definition at line 71 of file rtcov.cpp.

RtCov::~RtCov ( )

Destroys the Real-time covariance estimation object.

Definition at line 83 of file rtcov.cpp.

Member Function Documentation

void RtCov::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 92 of file rtcov.cpp.

void RTINVLIB::RtCov::covCalculated ( FIFFLIB::FiffCov::SPtr  p_pCov)
signal

Signal which is emitted when a new covariance Matrix is estimated.

Parameters
[out]p_pCovThe covariance matrix
bool RTINVLIB::RtCov::isRunning ( )
inline

Returns true if is running, otherwise false.

Returns
true if is running, false otherwise

Definition at line 207 of file rtcov.h.

void RtCov::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 142 of file rtcov.cpp.

void RtCov::setSamples ( qint32  samples)

Set number of estimation samples

Parameters
[in]samplesestimation samples to set

Definition at line 105 of file rtcov.cpp.

bool RtCov::start ( )
virtual

Starts the RtCov by starting the producer's thread.

Returns
true if succeeded, false otherwise

Definition at line 113 of file rtcov.cpp.

bool RtCov::stop ( )
virtual

Stops the RtCov by stopping the producer's thread.

Returns
true if succeeded, false otherwise

Definition at line 128 of file rtcov.cpp.


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