![]() |
GestureRecognitionToolkit
Version: 1.0 Revision: 04-03-15
The Gesture Recognition Toolkit (GRT) is a cross-platform, open-source, c++ machine learning library for real-time gesture recognition.
|
Public Member Functions | |
ParticleClassifier (const unsigned int numParticles=2000, const double sensorNoise=20.0, const double transitionSigma=0.005, const double phaseSigma=0.1, const double velocitySigma=0.01) | |
ParticleClassifier (const ParticleClassifier &rhs) | |
virtual | ~ParticleClassifier (void) |
ParticleClassifier & | operator= (const ParticleClassifier &rhs) |
virtual bool | deepCopyFrom (const Classifier *classifier) |
virtual bool | train_ (TimeSeriesClassificationData &trainingData) |
virtual bool | predict_ (VectorDouble &inputVector) |
virtual bool | saveModelToFile (fstream &file) const |
virtual bool | loadModelFromFile (fstream &file) |
virtual bool | clear () |
virtual bool | reset () |
const vector< ParticleClassifierGestureTemplate > & | getGestureTemplates () const |
const ParticleClassifierParticleFilter & | getParticleFilter () const |
VectorDouble | getStateEstimation () const |
double | getPhase () const |
double | getVelocity () const |
bool | setNumParticles (const unsigned int numParticles) |
bool | setSensorNoise (const unsigned int sensorNoise) |
bool | setTransitionSigma (const unsigned int transitionSigma) |
bool | setPhaseSigma (const unsigned int phaseSigma) |
bool | setVelocitySigma (const unsigned int velocitySigma) |
![]() | |
Classifier (void) | |
virtual | ~Classifier (void) |
bool | copyBaseVariables (const Classifier *classifier) |
string | getClassifierType () const |
bool | getSupportsNullRejection () const |
bool | getNullRejectionEnabled () const |
double | getNullRejectionCoeff () const |
double | getMaximumLikelihood () const |
double | getBestDistance () const |
double | getPhase () const |
virtual UINT | getNumClasses () const |
UINT | getClassLabelIndexValue (UINT classLabel) const |
UINT | getPredictedClassLabel () const |
VectorDouble | getClassLikelihoods () const |
VectorDouble | getClassDistances () const |
VectorDouble | getNullRejectionThresholds () const |
vector< UINT > | getClassLabels () const |
vector< MinMax > | getRanges () const |
bool | enableNullRejection (bool useNullRejection) |
virtual bool | setNullRejectionCoeff (double nullRejectionCoeff) |
virtual bool | setNullRejectionThresholds (VectorDouble newRejectionThresholds) |
virtual bool | recomputeNullRejectionThresholds () |
bool | getTimeseriesCompatible () const |
Classifier * | createNewInstance () const |
Classifier * | deepCopy () const |
const Classifier * | getClassifierPointer () const |
const Classifier & | getBaseClassifier () const |
![]() | |
MLBase (void) | |
virtual | ~MLBase (void) |
bool | copyMLBaseVariables (const MLBase *mlBase) |
virtual bool | train (ClassificationData trainingData) |
virtual bool | train_ (ClassificationData &trainingData) |
virtual bool | train (RegressionData trainingData) |
virtual bool | train_ (RegressionData &trainingData) |
virtual bool | train (TimeSeriesClassificationData trainingData) |
virtual bool | train (TimeSeriesClassificationDataStream trainingData) |
virtual bool | train_ (TimeSeriesClassificationDataStream &trainingData) |
virtual bool | train (UnlabelledData trainingData) |
virtual bool | train_ (UnlabelledData &trainingData) |
virtual bool | train (MatrixDouble data) |
virtual bool | train_ (MatrixDouble &data) |
virtual bool | predict (VectorDouble inputVector) |
virtual bool | predict (MatrixDouble inputMatrix) |
virtual bool | predict_ (MatrixDouble &inputMatrix) |
virtual bool | map (VectorDouble inputVector) |
virtual bool | map_ (VectorDouble &inputVector) |
virtual bool | print () const |
virtual bool | save (const string filename) const |
virtual bool | load (const string filename) |
virtual bool | saveModelToFile (string filename) const |
virtual bool | loadModelFromFile (string filename) |
virtual bool | getModel (ostream &stream) const |
double | scale (const double &x, const double &minSource, const double &maxSource, const double &minTarget, const double &maxTarget, const bool constrain=false) |
virtual string | getModelAsString () const |
UINT | getBaseType () const |
UINT | getNumInputFeatures () const |
UINT | getNumInputDimensions () const |
UINT | getNumOutputDimensions () const |
UINT | getMinNumEpochs () const |
UINT | getMaxNumEpochs () const |
UINT | getValidationSetSize () const |
UINT | getNumTrainingIterationsToConverge () const |
double | getMinChange () const |
double | getLearningRate () const |
double | getRootMeanSquaredTrainingError () const |
double | getTotalSquaredTrainingError () const |
bool | getUseValidationSet () const |
bool | getRandomiseTrainingOrder () const |
bool | getTrained () const |
bool | getModelTrained () const |
bool | getScalingEnabled () const |
bool | getIsBaseTypeClassifier () const |
bool | getIsBaseTypeRegressifier () const |
bool | getIsBaseTypeClusterer () const |
bool | enableScaling (bool useScaling) |
bool | setMaxNumEpochs (const UINT maxNumEpochs) |
bool | setMinNumEpochs (const UINT minNumEpochs) |
bool | setMinChange (const double minChange) |
bool | setLearningRate (double learningRate) |
bool | setUseValidationSet (const bool useValidationSet) |
bool | setValidationSetSize (const UINT validationSetSize) |
bool | setRandomiseTrainingOrder (const bool randomiseTrainingOrder) |
bool | registerTrainingResultsObserver (Observer< TrainingResult > &observer) |
bool | registerTestResultsObserver (Observer< TestInstanceResult > &observer) |
bool | removeTrainingResultsObserver (const Observer< TrainingResult > &observer) |
bool | removeTestResultsObserver (const Observer< TestInstanceResult > &observer) |
bool | removeAllTrainingObservers () |
bool | removeAllTestObservers () |
bool | notifyTrainingResultsObservers (const TrainingResult &data) |
bool | notifyTestResultsObservers (const TestInstanceResult &data) |
MLBase * | getMLBasePointer () |
const MLBase * | getMLBasePointer () const |
vector< TrainingResult > | getTrainingResults () const |
![]() | |
GRTBase (void) | |
virtual | ~GRTBase (void) |
bool | copyGRTBaseVariables (const GRTBase *GRTBase) |
string | getClassType () const |
string | getLastWarningMessage () const |
string | getLastErrorMessage () const |
string | getLastInfoMessage () const |
GRTBase * | getGRTBasePointer () |
const GRTBase * | getGRTBasePointer () const |
![]() | |
virtual void | notify (const TrainingResult &data) |
![]() | |
virtual void | notify (const TestInstanceResult &data) |
Protected Attributes | |
unsigned int | numParticles |
double | sensorNoise |
double | transitionSigma |
double | phaseSigma |
double | velocitySigma |
ParticleClassifierParticleFilter | particleFilter |
![]() | |
string | classifierType |
bool | supportsNullRejection |
bool | useNullRejection |
UINT | numClasses |
UINT | predictedClassLabel |
UINT | classifierMode |
double | nullRejectionCoeff |
double | maxLikelihood |
double | bestDistance |
double | phase |
VectorDouble | classLikelihoods |
VectorDouble | classDistances |
VectorDouble | nullRejectionThresholds |
vector< UINT > | classLabels |
vector< MinMax > | ranges |
![]() | |
bool | trained |
bool | useScaling |
UINT | baseType |
UINT | numInputDimensions |
UINT | numOutputDimensions |
UINT | numTrainingIterationsToConverge |
UINT | minNumEpochs |
UINT | maxNumEpochs |
UINT | validationSetSize |
double | learningRate |
double | minChange |
double | rootMeanSquaredTrainingError |
double | totalSquaredTrainingError |
bool | useValidationSet |
bool | randomiseTrainingOrder |
Random | random |
vector< TrainingResult > | trainingResults |
TrainingResultsObserverManager | trainingResultsObserverManager |
TestResultsObserverManager | testResultsObserverManager |
![]() | |
string | classType |
DebugLog | debugLog |
ErrorLog | errorLog |
InfoLog | infoLog |
TrainingLog | trainingLog |
TestingLog | testingLog |
WarningLog | warningLog |
Additional Inherited Members | |
![]() | |
typedef std::map< string, Classifier *(*)() > | StringClassifierMap |
![]() | |
enum | BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER } |
![]() | |
static Classifier * | createInstanceFromString (string const &classifierType) |
static vector< string > | getRegisteredClassifiers () |
![]() | |
static string | getGRTVersion (bool returnRevision=true) |
static string | getGRTRevison () |
![]() | |
enum | ClassifierModes { STANDARD_CLASSIFIER_MODE =0, TIMESERIES_CLASSIFIER_MODE } |
![]() | |
bool | saveBaseSettingsToFile (fstream &file) const |
bool | loadBaseSettingsFromFile (fstream &file) |
![]() | |
bool | saveBaseSettingsToFile (fstream &file) const |
bool | loadBaseSettingsFromFile (fstream &file) |
![]() | |
double | SQR (const double &x) const |
![]() | |
static StringClassifierMap * | getMap () |
Definition at line 29 of file ParticleClassifier.h.
GRT::ParticleClassifier::ParticleClassifier | ( | const unsigned int | numParticles = 2000 , |
const double | sensorNoise = 20.0 , |
||
const double | transitionSigma = 0.005 , |
||
const double | phaseSigma = 0.1 , |
||
const double | velocitySigma = 0.01 |
||
) |
Default Constructor
Definition at line 28 of file ParticleClassifier.cpp.
GRT::ParticleClassifier::ParticleClassifier | ( | const ParticleClassifier & | rhs | ) |
Default copy constructor
Defines how the data from the rhs ParticleClassifier should be copied to this ParticleClassifier
const | ParticleClassifier &rhs: another instance of a ParticleClassifier |
Definition at line 46 of file ParticleClassifier.cpp.
|
virtual |
Default Destructor
Definition at line 50 of file ParticleClassifier.cpp.
|
virtual |
This clears the ParticleClassifier classifier.
Reimplemented from GRT::Classifier.
Definition at line 183 of file ParticleClassifier.cpp.
|
virtual |
This is required for the Gesture Recognition Pipeline for when the pipeline.setClassifier(...) method is called. It clones the data from the Base Class Classifier pointer (which should be pointing to an ParticleClassifier instance) into this instance
Classifier | *classifier: a pointer to the Classifier Base Class, this should be pointing to another ParticleClassifier instance |
Reimplemented from GRT::Classifier.
Definition at line 71 of file ParticleClassifier.cpp.
|
virtual |
This loads a trained ParticleClassifier model from a file. This overrides the loadModelFromFile function in the Classifier base class.
fstream | &file: a reference to the file the ParticleClassifier model will be loaded from |
Reimplemented from GRT::MLBase.
Definition at line 214 of file ParticleClassifier.cpp.
ParticleClassifier & GRT::ParticleClassifier::operator= | ( | const ParticleClassifier & | rhs | ) |
Defines how the data from the rhs ParticleClassifier should be copied to this ParticleClassifier
const | ParticleClassifier &rhs: another instance of a ParticleClassifier |
Definition at line 54 of file ParticleClassifier.cpp.
|
virtual |
This predicts the class of the inputVector. This overrides the predict function in the Classifier base class.
VectorDouble | inputVector: the input vector to classify |
Reimplemented from GRT::MLBase.
Definition at line 119 of file ParticleClassifier.cpp.
|
virtual |
This resets the ParticleClassifier classifier.
Reimplemented from GRT::Classifier.
Definition at line 192 of file ParticleClassifier.cpp.
|
virtual |
This saves the trained ParticleClassifier model to a file. This overrides the saveModelToFile function in the Classifier base class.
fstream | &file: a reference to the file the ParticleClassifier model will be saved to |
Reimplemented from GRT::MLBase.
Definition at line 201 of file ParticleClassifier.cpp.
|
virtual |
This trains the ParticleClassifier model, using the labelled timeseries classification data. This overrides the train function in the Classifier base class.
TimeSeriesClassificationData | trainingData: a reference to the training data |
Reimplemented from GRT::MLBase.
Definition at line 90 of file ParticleClassifier.cpp.