CEBL  2.1
Public Member Functions | Protected Attributes
CEBL::Classifier Class Reference

#include <Classifier.hpp>

Public Member Functions

 Classifier ()
virtual ~Classifier ()
bool isTrained ()
void reset (CEBL::Param param)
virtual bool getProbabilitiesFlag ()
virtual void setProbabilitiesFlag (bool flag)
virtual std::vector
< std::vector< double > > 
getProbabilities ()
int getTrainedClasses ()
int getTrainedLags ()
virtual void update (const EEGTrainingData &data)
virtual void train (const EEGTrainingData &)=0
virtual ublas::vector< int > use (const ublas::matrix< double > &)=0
- Public Member Functions inherited from CEBL::Plugin
 Plugin ()
virtual ~Plugin ()
void halt ()
 tell classifier to halt
string getName () const
 get the name of the plugin
virtual std::map< std::string,
CEBL::Param
getParamsList ()
 get the parameter list
virtual void setParamsList (std::map< std::string, CEBL::Param > &)
 set the parameter list
virtual map< string,
SerializedObject
save () const
 save plugin to list, and return it
virtual void load (map< string, SerializedObject > objects)
 load plugin from list of objects

Protected Attributes

bool trained
bool compute_probs
std::vector< std::vector
< double > > 
probabilities
int using_classes
int using_lags
int trained_classes
int trained_lags
- Protected Attributes inherited from CEBL::Plugin
string plugin_name
bool should_halt

Additional Inherited Members

- Protected Member Functions inherited from CEBL::Plugin
void inturruptionPoint ()

Detailed Description

Author:
Jeshua Bratman

Provides interface for classifier plugins.

Definition at line 41 of file Classifier.hpp.


Constructor & Destructor Documentation

CEBL::Classifier::Classifier ( )
inline

Definition at line 55 of file Classifier.hpp.

References compute_probs, trained, trained_classes, trained_lags, using_classes, and using_lags.

virtual CEBL::Classifier::~Classifier ( )
inlinevirtual

Definition at line 56 of file Classifier.hpp.


Member Function Documentation

virtual std::vector<std::vector<double> > CEBL::Classifier::getProbabilities ( )
inlinevirtual

Gets probabilities for each class from latest classification. If your classifier cannot produce probabilities, just set probabilities to a vector where the winning class gets 100% and others get 0%

Returns:

Definition at line 101 of file Classifier.hpp.

References probabilities.

Referenced by ClassifiersConfig::getLastProbs().

virtual bool CEBL::Classifier::getProbabilitiesFlag ( )
inlinevirtual

Gets flag determining whether classifier should compute probabilities or not.

Returns:

Definition at line 85 of file Classifier.hpp.

References compute_probs.

Referenced by ClassifiersConfig::getUseProbs().

int CEBL::Classifier::getTrainedClasses ( )
inline

Definition at line 106 of file Classifier.hpp.

References trained_classes.

Referenced by ClassifiersConfig::getTrainedClasses().

int CEBL::Classifier::getTrainedLags ( )
inline

Definition at line 108 of file Classifier.hpp.

References trained_lags.

Referenced by ClassifiersConfig::getTrainedLags().

bool CEBL::Classifier::isTrained ( )
inline

Definition at line 57 of file Classifier.hpp.

References trained.

Referenced by ClassifiersConfig::isTrained().

void CEBL::Classifier::reset ( CEBL::Param  param)
inline

Definition at line 63 of file Classifier.hpp.

References CEBL::Param::getInt(), and using_classes.

Referenced by ClassifiersConfig::reset().

virtual void CEBL::Classifier::setProbabilitiesFlag ( bool  flag)
inlinevirtual

Gets flag determining whether classifier should compute probabilities or not

Parameters:
flag

Definition at line 91 of file Classifier.hpp.

References compute_probs.

Referenced by ClassifiersConfig::setUseProbs().

virtual void CEBL::Classifier::train ( const EEGTrainingData )
pure virtual

Train classifier over training data set

Implemented in CEBL::max_var, CEBL::LDA, CEBL::QDA, and CEBL::QDA.

Referenced by ClassifiersConfig::train(), and update().

virtual void CEBL::Classifier::update ( const EEGTrainingData data)
inlinevirtual

Updates classifier with training data set. By default just trains the classifier.

Definition at line 114 of file Classifier.hpp.

References train().

virtual ublas::vector<int> CEBL::Classifier::use ( const ublas::matrix< double > &  )
pure virtual

Use classifier on data and return class for each sample.

 \return 

Implemented in CEBL::LDA, CEBL::QDA, and CEBL::QDA.

Referenced by ClassifiersConfig::use().


Field Documentation

bool CEBL::Classifier::compute_probs
protected

Definition at line 45 of file Classifier.hpp.

Referenced by Classifier(), getProbabilitiesFlag(), and setProbabilitiesFlag().

std::vector<std::vector<double> > CEBL::Classifier::probabilities
protected

Definition at line 46 of file Classifier.hpp.

Referenced by getProbabilities().

bool CEBL::Classifier::trained
protected

Definition at line 44 of file Classifier.hpp.

Referenced by Classifier(), isTrained(), and CEBL::max_var::max_var().

int CEBL::Classifier::trained_classes
protected

Definition at line 51 of file Classifier.hpp.

Referenced by Classifier(), and getTrainedClasses().

int CEBL::Classifier::trained_lags
protected

Definition at line 52 of file Classifier.hpp.

Referenced by Classifier(), and getTrainedLags().

int CEBL::Classifier::using_classes
protected

Definition at line 48 of file Classifier.hpp.

Referenced by Classifier(), and reset().

int CEBL::Classifier::using_lags
protected

Definition at line 49 of file Classifier.hpp.

Referenced by Classifier().


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