MNE-CPP  beta 1.0
Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
BCIPlugin::BCI Class Reference

The BCI class provides an EEG BCI. More...

#include <bci.h>

Inheritance diagram for BCIPlugin::BCI:
MNEX::IAlgorithm MNEX::IPlugin

Signals

void paintFeatures (MyQList features, bool bTrigerActivated)
 

Public Member Functions

 BCI ()
 
virtual ~BCI ()
 
virtual QSharedPointer< IPluginclone () const
 
virtual void init ()
 
virtual void unload ()
 
virtual bool start ()
 
virtual bool stop ()
 
virtual IPlugin::PluginType getType () const
 
virtual QString getName () const
 
virtual QWidget * setupWidget ()
 
- Public Member Functions inherited from MNEX::IAlgorithm
virtual ~IAlgorithm ()
 
virtual bool multiInstanceAllowed () const
 
- Public Member Functions inherited from MNEX::IPlugin
virtual ~IPlugin ()
 
QList< QAction * > getPluginActions ()
 
InputConnectorListgetInputConnectors ()
 
OutputConnectorListgetOutputConnectors ()
 

Protected Member Functions

void updateSensor (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
void updateSource (XMEASLIB::NewMeasurement::SPtr pMeasurement)
 
void applyMeanCorrectionConcurrently (QPair< int, RowVectorXd > &rowdata)
 
void applyFilterOperatorConcurrently (QPair< int, RowVectorXd > &chdata)
 
QPair< int, QList< double > > applyFeatureCalcConcurrentlyOnSensorLevel (const QPair< int, RowVectorXd > &chdata)
 
double applyClassificationCalcConcurrentlyOnSensorLevel (QList< double > &featData)
 
double classificationBoundaryValue (const QList< double > &featData)
 
void clearFeatures ()
 
void clearClassifications ()
 
bool hasThresholdArtefact (const QList< QPair< int, RowVectorXd > > &data)
 
bool lookForTrigger (const MatrixXd &data)
 
virtual void run ()
 
void BCIOnSensorLevel ()
 
void BCIOnSourceLevel ()
 
- Protected Member Functions inherited from MNEX::IPlugin
void addPluginAction (QAction *pAction)
 

Friends

class BCIFeatureWindow
 

Additional Inherited Members

- Public Types inherited from MNEX::IAlgorithm
typedef QSharedPointer< IAlgorithmSPtr
 
typedef QSharedPointer< const IAlgorithmConstSPtr
 
- Public Types inherited from MNEX::IPlugin
enum  PluginType { _ISensor, _IAlgorithm, _IIO, _PluginSet }
 
typedef QSharedPointer< IPluginSPtr
 
typedef QSharedPointer< const IPluginConstSPtr
 
typedef QVector< QSharedPointer< PluginInputConnector > > InputConnectorList
 
typedef QVector< QSharedPointer< PluginOutputConnector > > OutputConnectorList
 
- Protected Attributes inherited from MNEX::IPlugin
InputConnectorList m_inputConnectors
 
OutputConnectorList m_outputConnectors
 

Detailed Description

The BCI class provides an EEG BCI.

BCI...

Definition at line 103 of file bci.h.

Constructor & Destructor Documentation

BCI::BCI ( )

Constructs a BCI.

Definition at line 69 of file bci.cpp.

BCI::~BCI ( )
virtual

Destroys the BCI.

Definition at line 78 of file bci.cpp.

Member Function Documentation

double BCI::applyClassificationCalcConcurrentlyOnSensorLevel ( QList< double > &  featData)
protected

Classifies the features on sensor level

Parameters
[in]featDataQList<double> holds the feature data point (i.e. 2 electrodes make this parameter have size of 2).
[out]doublecalculated classification value.

Definition at line 490 of file bci.cpp.

QPair< int, QList< double > > BCI::applyFeatureCalcConcurrentlyOnSensorLevel ( const QPair< int, RowVectorXd > &  chdata)
protected

Calculates the features on sensor level

Parameters
[in]chdataQPair with number of the row and the data samples as a RowVectorXd.
[out]QPair<int,QList<double>>calculated features.

Definition at line 465 of file bci.cpp.

void BCI::applyFilterOperatorConcurrently ( QPair< int, RowVectorXd > &  chdata)
protected

Calculates the filtered signal of chdata

Parameters
[in]chdataQPair with number of the row and the data samples as a RowVectorXd.

Definition at line 457 of file bci.cpp.

void BCI::applyMeanCorrectionConcurrently ( QPair< int, RowVectorXd > &  rowdata)
protected

Calculates the filtered signal of chdata

Parameters
[in]rowdataQPair with number of the row and the data samples as a RowVectorXd.

Definition at line 449 of file bci.cpp.

void BCI::BCIOnSensorLevel ( )
protected

Do BCI stuff with data received from sensor level

Definition at line 602 of file bci.cpp.

void BCI::BCIOnSourceLevel ( )
protected

Do BCI stuff with data received from source level

Definition at line 870 of file bci.cpp.

double BCI::classificationBoundaryValue ( const QList< double > &  featData)
protected

Calculates the function value of the decision function (boundary) for a given feature point

Parameters
[in]featDataQList<double> holds the feature data point (i.e. 2 electrodes make this parameter have size of 2).
[out]doublefunction value.

Definition at line 498 of file bci.cpp.

void BCI::clearClassifications ( )
protected

Clears all classification results

Definition at line 527 of file bci.cpp.

void BCI::clearFeatures ( )
protected

Clears features

Definition at line 517 of file bci.cpp.

QSharedPointer< IPlugin > BCI::clone ( ) const
virtual

Clone the plugin

Implements MNEX::IAlgorithm.

Definition at line 90 of file bci.cpp.

QString BCI::getName ( ) const
virtual

Returns the plugin name. Pure virtual method inherited by IPlugin.

Returns
the name of the IAlgorithm.

Implements MNEX::IAlgorithm.

Definition at line 333 of file bci.cpp.

IPlugin::PluginType BCI::getType ( ) const
virtual

Returns the plugin type. Pure virtual method inherited by IPlugin.

Returns
type of the IAlgorithm

Implements MNEX::IAlgorithm.

Definition at line 325 of file bci.cpp.

bool BCI::hasThresholdArtefact ( const QList< QPair< int, RowVectorXd > > &  data)
protected

Check for artefact in data

Definition at line 537 of file bci.cpp.

void BCI::init ( )
virtual

Initialise input and output connectors.

Implements MNEX::IAlgorithm.

Definition at line 99 of file bci.cpp.

bool BCI::lookForTrigger ( const MatrixXd &  data)
protected

Look for trigger in stim channel

Definition at line 571 of file bci.cpp.

void BCI::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.

Implements MNEX::IAlgorithm.

Definition at line 586 of file bci.cpp.

QWidget * BCI::setupWidget ( )
virtual

Returns the set up widget for configuration of IAlgorithm. Pure virtual method inherited by IPlugin.

Returns
the setup widget.

Implements MNEX::IAlgorithm.

Definition at line 341 of file bci.cpp.

bool BCI::start ( )
virtual

Starts the BCI by starting the BCI's thread.

Implements MNEX::IAlgorithm.

Definition at line 192 of file bci.cpp.

bool BCI::stop ( )
virtual

Stops the BCI by stopping the BCI's thread.

Implements MNEX::IAlgorithm.

Definition at line 286 of file bci.cpp.

void BCI::unload ( )
virtual

Is called when plugin is detached of the stage. Can be used to safe settings.

Implements MNEX::IAlgorithm.

Definition at line 184 of file bci.cpp.

void BCI::updateSensor ( XMEASLIB::NewMeasurement::SPtr  pMeasurement)
protected

This update function gets called whenever the input buffer stream from the TMSI plugin is full and need to be emptied by this BCI plugin.

Parameters
[in]pMeasurementmeasurement object.

Definition at line 354 of file bci.cpp.

void BCI::updateSource ( XMEASLIB::NewMeasurement::SPtr  pMeasurement)
protected

This update function gets called whenever the input buffer stream from the Sourcelab plugin is full and need to be emptied by this BCI plugin.

Parameters
[in]pMeasurementmeasurement object.

Definition at line 424 of file bci.cpp.


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