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

Interface for all predictors. More...

Inheritance diagram for SharpBCI.IPredictor< T >:
SharpBCI.Predictor SharpBCI.AggregateKNNCorrelationPredictor SharpBCI.AggregateKNNDTWPredictor

Public Member Functions

void AddTrainingData (int label, T data)
 Add data to labeled training data set. More...
 
void ClearTrainingData ()
 Clears all training data stored within the predictor Essentially a reset of the entire prediction system Use between changing environments and/or participants. More...
 
int Predict (T test)
 Makes a prediction from the underlying model based off the new data. More...
 

Detailed Description

Interface for all predictors.

All current predictors take double[] as data. Should be encapsulated in an IPredictorPipeable.

See Also
IPredictorPipeable

Member Function Documentation

void SharpBCI.IPredictor< T >.AddTrainingData ( int  label,
data 
)

Add data to labeled training data set.

The collection of trained data is used to create a model for Predict.

See Also
Predict(T test)
Parameters
label- a unique non-negative non-zero integer which identifies the label being trained on
data- training data for predictor. Generally double[]
void SharpBCI.IPredictor< T >.ClearTrainingData ( )

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

Implemented in SharpBCI.Predictor.

int SharpBCI.IPredictor< T >.Predict ( test)

Makes a prediction from the underlying model based off the new data.

See Also
AddTrainingData(int label, T data)
Parameters
test- data to be predicted on. Must be the same type/shape/format of AddTrainingData data
Returns
int the corresponds with the label of the predicted class

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