SharpBCI
A multi-threaded brain control interface (BCI) library in C#
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | List of all members
SharpBCI.IPredictorPipeable Interface Reference

Extends the typical pipeable to include training controls SharpBCI uses these functions to interface with the prediction mechanisms. More...

Inheritance diagram for SharpBCI.IPredictorPipeable:
SharpBCI.IPipeable SharpBCI.AggregatePredictionPipeable

Public Member Functions

void StartTraining (int id)
 Starts training data collection on a particular id (label) Should continue training on that id until StopTraining() is called on the same id. More...
 
void StopTraining (int id)
 Ends training data collection on a particular id (label) Must be paired with a preceding StartTraining on that label. More...
 
void ClearTrainingData ()
 Clears all training data stored within the encapsulated predictor Essentially a reset of the entire prediction system Use between changing environments and/or participants. More...
 
- Public Member Functions inherited from SharpBCI.IPipeable
void SetInput (BlockingCollection< object > input)
 Set the input on this IPipeable to param input Should only be used internally by Connect. More...
 
void Connect (IPipeable other, bool mirror)
 Connect the input of other to our output and allow for control of mirror data. More...
 
void Connect (IPipeable other)
 Connect the input of other to our output Note: mirror == false using this override. More...
 
void Start (TaskFactory taskFactory, CancellationTokenSource cts)
 Actually start doing work (i.e., promise to eventually start pushing data to connected pipeables) More...
 
void Stop ()
 Require this IPipeable to stop, blocking until actually stopped. More...
 

Detailed Description

Extends the typical pipeable to include training controls SharpBCI uses these functions to interface with the prediction mechanisms.

See Also
IPipeable
IPredictor<T>

Member Function Documentation

void SharpBCI.IPredictorPipeable.ClearTrainingData ( )

Clears all training data stored within the encapsulated predictor Essentially a reset of the entire prediction system Use between changing environments and/or participants.

Implemented in SharpBCI.AggregatePredictionPipeable.

void SharpBCI.IPredictorPipeable.StartTraining ( int  id)

Starts training data collection on a particular id (label) Should continue training on that id until StopTraining() is called on the same id.

Implemented in SharpBCI.AggregatePredictionPipeable.

void SharpBCI.IPredictorPipeable.StopTraining ( int  id)

Ends training data collection on a particular id (label) Must be paired with a preceding StartTraining on that label.

Implemented in SharpBCI.AggregatePredictionPipeable.

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