SharpBCI
A multi-threaded brain control interface (BCI) library in C#
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
SharpBCI.TournamentArtifactPipeable Class Reference

An artifact detector which uses a TournamentArtifactDectector on a per-channel basis to detect artifacts Input types: EEG, Output types: EEG. More...

Inheritance diagram for SharpBCI.TournamentArtifactPipeable:
SharpBCI.Pipeable SharpBCI.IPipeable

Public Member Functions

 TournamentArtifactPipeable (int channels, double sampleRate, double learningTime, uint tournamentSize, uint nAccept, uint initialMerits)
 Create a new TournamentArtifactPipeable with following params. More...
 
- Public Member Functions inherited from SharpBCI.Pipeable
void SetInput (BlockingCollection< object > newInput)
 Set the input on this IPipeable to param input Should only be used internally by Connect. More...
 
void Connect (IPipeable other)
 Connect the input of other to our output Note: mirror == false using this override. More...
 
void Connect (IPipeable other, bool mirror)
 Connect the input of other to our output and allow for control of mirror data. More...
 
virtual void Start (TaskFactory taskFactory, CancellationTokenSource cts)
 Actually start doing work (i.e., promise to eventually start pushing data to connected pipeables) More...
 
virtual void Stop ()
 Require this IPipeable to stop, blocking until actually stopped. More...
 

Protected Member Functions

override bool Process (object item)
 
- Protected Member Functions inherited from SharpBCI.Pipeable
void Add (object item)
 

Additional Inherited Members

- Public Attributes inherited from SharpBCI.Pipeable
const int DEFAULT_BUFFER_SIZE = 1000
 

Detailed Description

An artifact detector which uses a TournamentArtifactDectector on a per-channel basis to detect artifacts Input types: EEG, Output types: EEG.

Constructor & Destructor Documentation

SharpBCI.TournamentArtifactPipeable.TournamentArtifactPipeable ( int  channels,
double  sampleRate,
double  learningTime,
uint  tournamentSize,
uint  nAccept,
uint  initialMerits 
)

Create a new TournamentArtifactPipeable with following params.

Parameters
channelschannels as reported by the underlying EEGDeviceAdapter
sampleRatesample rate as reported by the underlying EEGDeviceAdapter
learningTimeThis many seconds of data will be used to fit the underlying TournamentArtifactPipeable
tournamentSizehow many IArtifactDetectors should compete
nAcceptthe majority of the top nAccept IArtifactDetector's determines if the EEGEvent is considered to be an artifact
initialMeritsdetermines how quickly an IArtifactDetector is thrown out of the tournament in the worst case. Should be large in relation to sampleRate.

Member Function Documentation

override bool SharpBCI.TournamentArtifactPipeable.Process ( object  item)
protectedvirtual

Implements SharpBCI.Pipeable.


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