![]() |
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 | |
LeakyIntegrator (const double leakRate=0.99, const UINT numDimensions=1) | |
LeakyIntegrator (const LeakyIntegrator &rhs) | |
virtual | ~LeakyIntegrator () |
LeakyIntegrator & | operator= (const LeakyIntegrator &rhs) |
virtual bool | deepCopyFrom (const PreProcessing *preProcessing) |
virtual bool | process (const VectorDouble &inputVector) |
virtual bool | reset () |
virtual bool | saveModelToFile (fstream &file) const |
virtual bool | loadModelFromFile (fstream &file) |
bool | init (const double leakRate, const UINT numDimensions) |
double | update (const double x) |
VectorDouble | update (const VectorDouble &x) |
bool | setLeakRate (const double leakRate) |
double | getLeakRate () |
![]() | |
PreProcessing (void) | |
virtual | ~PreProcessing (void) |
bool | copyBaseVariables (const PreProcessing *preProcessingModule) |
virtual bool | clear () |
virtual bool | saveModelToFile (string filename) const |
virtual bool | loadModelFromFile (string filename) |
string | getPreProcessingType () const |
UINT | getNumInputDimensions () const |
UINT | getNumOutputDimensions () const |
bool | getInitialized () const |
VectorDouble | getProcessedData () const |
PreProcessing * | createNewInstance () 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_ (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_ (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 | 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 | |
double | leakRate |
The current leak rate. | |
VectorDouble | y |
A buffer holding the previous input value(s) | |
![]() | |
string | preProcessingType |
bool | initialized |
VectorDouble | processedData |
![]() | |
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 |
Static Protected Attributes | |
static RegisterPreProcessingModule< LeakyIntegrator > | registerModule |
Additional Inherited Members | |
![]() | |
typedef std::map< string, PreProcessing *(*)() > | StringPreProcessingMap |
![]() | |
enum | BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER } |
![]() | |
static PreProcessing * | createInstanceFromString (string const &preProcessingType) |
![]() | |
static string | getGRTVersion (bool returnRevision=true) |
static string | getGRTRevison () |
![]() | |
bool | init () |
bool | savePreProcessingSettingsToFile (fstream &file) const |
bool | loadPreProcessingSettingsFromFile (fstream &file) |
![]() | |
bool | saveBaseSettingsToFile (fstream &file) const |
bool | loadBaseSettingsFromFile (fstream &file) |
![]() | |
double | SQR (const double &x) const |
![]() | |
static StringPreProcessingMap * | getMap () |
Definition at line 36 of file LeakyIntegrator.h.
GRT::LeakyIntegrator::LeakyIntegrator | ( | const double | leakRate = 0.99 , |
const UINT | numDimensions = 1 |
||
) |
Constructor, sets the leak rate and the dimensionality of the input data.
const | double leakRate: sets the leak rate of the filter, this should be in the range [0 1]. Default delta = 0.99 |
const | UINT numDimensions: the dimensionality of the input data. Default numDimensions = 1 |
Definition at line 28 of file LeakyIntegrator.cpp.
GRT::LeakyIntegrator::LeakyIntegrator | ( | const LeakyIntegrator & | rhs | ) |
Copy Constructor, copies the LeakyIntegrator from the rhs instance to this instance
const | LeakyIntegrator &rhs: another instance of the LeakyIntegrator class from which the data will be copied to this instance |
Definition at line 37 of file LeakyIntegrator.cpp.
|
virtual |
Default Destructor
Definition at line 51 of file LeakyIntegrator.cpp.
|
virtual |
Sets the PreProcessing deepCopyFrom function, overwriting the base PreProcessing function. This function is used to clone the values from the input pointer to this instance of the PreProcessing module. This function is called by the GestureRecognitionPipeline when the user adds a new PreProcessing module to the pipeline.
const | PreProcessing *preProcessing: a pointer to another instance of a LeakyIntegrator, the values of that instance will be cloned to this instance |
Reimplemented from GRT::PreProcessing.
Definition at line 64 of file LeakyIntegrator.cpp.
double GRT::LeakyIntegrator::getLeakRate | ( | ) |
Gets the leak rate.
Definition at line 230 of file LeakyIntegrator.cpp.
bool GRT::LeakyIntegrator::init | ( | const double | leakRate, |
const UINT | numDimensions | ||
) |
Initializes the instance, sets the leak rate and the dimensionality of the input data.
const | double leakRate: sets the leak rate of the filter, this should be in the range [0 1]. Default delta = 0.99 |
const | UINT numDimensions: the dimensionality of the input data. Default numDimensions = 1 |
Definition at line 161 of file LeakyIntegrator.cpp.
|
virtual |
This loads the LeakyIntegrator settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.
fstream | &file: a reference to the file to load the settings from |
Reimplemented from GRT::PreProcessing.
Definition at line 127 of file LeakyIntegrator.cpp.
LeakyIntegrator & GRT::LeakyIntegrator::operator= | ( | const LeakyIntegrator & | rhs | ) |
Sets the equals operator, copies the data from the rhs instance to this instance
const | LeakyIntegrator &rhs: another instance of the LeakyIntegrator class from which the data will be copied to this instance |
Definition at line 55 of file LeakyIntegrator.cpp.
|
virtual |
Sets the PreProcessing process function, overwriting the base PreProcessing function. This function is called by the GestureRecognitionPipeline when any new input data needs to be processed (during the prediction phase for example). This function calls the LeakyIntegrator's computeLeakyIntegrator function.
const | VectorDouble &inputVector: the inputVector that should be processed. Must have the same dimensionality as the PreProcessing module |
Reimplemented from GRT::PreProcessing.
Definition at line 85 of file LeakyIntegrator.cpp.
|
virtual |
Sets the PreProcessing reset function, overwriting the base PreProcessing function. This function is called by the GestureRecognitionPipeline when the pipelines main reset() function is called. This function resets the LeakyIntegrator values by re-initiliazing the filter.
Reimplemented from GRT::PreProcessing.
Definition at line 103 of file LeakyIntegrator.cpp.
|
virtual |
This saves the current settings of the LeakyIntegrator to a file. This overrides the saveModelToFile function in the PreProcessing base class.
fstream | &file: a reference to the file the settings will be saved to |
Reimplemented from GRT::PreProcessing.
Definition at line 108 of file LeakyIntegrator.cpp.
bool GRT::LeakyIntegrator::setLeakRate | ( | const double | leakRate | ) |
Sets the leak rate. This should be in the range [0 1]. Setting delta will re-initialize this instance.
double | leakRate: the new leak rate value |
Definition at line 220 of file LeakyIntegrator.cpp.
double GRT::LeakyIntegrator::update | ( | const double | x | ) |
Computes the LeakyIntegrator of the input, this should only be called if the dimensionality of the instance was set to 1.
double | x: the value to compute the LeakyIntegrator of, this should only be called if the dimensionality of the filter was set to 1 |
Definition at line 186 of file LeakyIntegrator.cpp.
VectorDouble GRT::LeakyIntegrator::update | ( | const VectorDouble & | x | ) |
Computes the LeakyIntegrator of the input, the dimensionality of the input should match the number of inputs for the LeakyIntegrator
const | VectorDouble &x: the values to compute the LeakyIntegrator of, the dimensionality of the input should match the number of inputs for the LeakyIntegrator |
Definition at line 200 of file LeakyIntegrator.cpp.