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

An interface which defines an abstract artifact detector You can implement this to utilize classes which find the best detector implementation. More...

Inheritance diagram for SharpBCI.IArtifactDetector:
SharpBCI.ARArtifactDetector SharpBCI.TournamentArtifactDetector

Public Member Functions

bool Detect (double next)
 Update artifact detector using next. More...
 
double Error ()
 Inform the caller of the current confusion of this implementation The returned value should be a double greater than or equal to zero Otherwise no range is assumed, but lower values should indicate lower confusion For example, a detector that perfectly models the signal with no artifacts should have an error of zero Pragmatically, error will generally be non-zero due to presence of artifacts and noise. More...
 

Detailed Description

An interface which defines an abstract artifact detector You can implement this to utilize classes which find the best detector implementation.

See Also
TournamentArtifactDetector

Member Function Documentation

bool SharpBCI.IArtifactDetector.Detect ( double  next)

Update artifact detector using next.

Returns
true iff next is an artifact, false otherwise

Implemented in SharpBCI.TournamentArtifactDetector, and SharpBCI.ARArtifactDetector.

double SharpBCI.IArtifactDetector.Error ( )

Inform the caller of the current confusion of this implementation The returned value should be a double greater than or equal to zero Otherwise no range is assumed, but lower values should indicate lower confusion For example, a detector that perfectly models the signal with no artifacts should have an error of zero Pragmatically, error will generally be non-zero due to presence of artifacts and noise.

Returns
the internal confusion metric of this implementation

Implemented in SharpBCI.TournamentArtifactDetector, and SharpBCI.ARArtifactDetector.


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