![]() |
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 | |
DeadZone (double lowerLimit=-0.1, double upperLimit=0.1, UINT numDimensions=1) | |
DeadZone (const DeadZone &rhs) | |
virtual | ~DeadZone () |
DeadZone & | operator= (const DeadZone &rhs) |
virtual bool | deepCopyFrom (const PreProcessing *preProcessing) |
virtual bool | process (const VectorDouble &inputVector) |
virtual bool | reset () |
virtual bool | saveModelToFile (string filename) const |
virtual bool | saveModelToFile (fstream &file) const |
virtual bool | loadModelFromFile (string filename) |
virtual bool | loadModelFromFile (fstream &file) |
bool | init (double lowerLimit, double upperLimit, UINT numDimensions) |
double | filter (const double x) |
VectorDouble | filter (const VectorDouble &x) |
bool | setLowerLimit (double lowerLimit) |
bool | setUpperLimit (double upperLimit) |
double | getLowerLimit () |
double | getUpperLimit () |
![]() | |
PreProcessing (void) | |
virtual | ~PreProcessing (void) |
bool | copyBaseVariables (const PreProcessing *preProcessingModule) |
virtual bool | clear () |
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 | lowerLimit |
The lower limit of the dead-zone region. | |
double | upperLimit |
The upper limit of the dead-zone region. | |
![]() | |
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< DeadZone > | 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 39 of file DeadZone.h.
GRT::DeadZone::DeadZone | ( | double | lowerLimit = -0.1 , |
double | upperLimit = 0.1 , |
||
UINT | numDimensions = 1 |
||
) |
Constructor, sets the lower and upper limits of the dead-zone region and the dimensionality of the input data.
double | lowerLimit: sets the lower limit of the dead-zone region. Default lowerLimit = -0.1 |
UINT | upperLimit: sets the upper limit of the dead-zone region. Default upperLimit = 0.1 |
UINT | numDimensions: the dimensionality of the input data. Default numDimensions = 1 |
Definition at line 28 of file DeadZone.cpp.
GRT::DeadZone::DeadZone | ( | const DeadZone & | rhs | ) |
Copy Constructor, copies the DeadZone from the rhs instance to this instance
const | DeadZone &rhs: another instance of the DeadZone class from which the data will be copied to this instance |
Definition at line 37 of file DeadZone.cpp.
|
virtual |
Default Destructor
Definition at line 48 of file DeadZone.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 DeadZone, the values of that instance will be cloned to this instance |
Reimplemented from GRT::PreProcessing.
Definition at line 61 of file DeadZone.cpp.
double GRT::DeadZone::filter | ( | const double | x | ) |
Filters the value x using the dead-zone values, this should only be called if the dimensionality of the instance was set to 1.
const | double x: the value to be filtered, this should only be called if the dimensionality of the filter was set to 1 |
Definition at line 233 of file DeadZone.cpp.
VectorDouble GRT::DeadZone::filter | ( | const VectorDouble & | x | ) |
Filters x using the dead-zone values, the dimensionality of the input should match the number of inputs for the dead zone
const | VectorDouble &x: the values to be filtered, the dimensionality of the input should match the number of inputs for the derivative |
Definition at line 239 of file DeadZone.cpp.
|
inline |
Gets the lower limit of the dead-zone region.
Definition at line 182 of file DeadZone.h.
|
inline |
Gets the upper limit of the dead-zone region.
Definition at line 189 of file DeadZone.h.
bool GRT::DeadZone::init | ( | double | lowerLimit, |
double | upperLimit, | ||
UINT | numDimensions | ||
) |
Initializes the instance, sets the lower and upper limits of the dead-zone region and the dimensionality of the input data.
double | lowerLimit: sets the lower limit of the dead-zone region |
UINT | upperLimit: sets the upper limit of the dead-zone region |
UINT | numDimensions: the dimensionality of the input data |
Definition at line 208 of file DeadZone.cpp.
|
virtual |
This loads the DeadZone settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.
string | filename: the name of the file to load the settings from |
Reimplemented from GRT::PreProcessing.
Definition at line 140 of file DeadZone.cpp.
|
virtual |
This loads the DeadZone 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 156 of file DeadZone.cpp.
Sets the equals operator, copies the data from the rhs instance to this instance
const | DeadZone &rhs: another instance of the DeadZone class from which the data will be copied to this instance |
Definition at line 52 of file DeadZone.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 DeadZone's filter 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 81 of file DeadZone.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 deadZone by re-initiliazing the instance.
Reimplemented from GRT::PreProcessing.
Definition at line 99 of file DeadZone.cpp.
|
virtual |
This saves the current settings of the DeadZone to a file. This overrides the saveModelToFile function in the PreProcessing base class.
string | filename: the name of the file to save the settings to |
Reimplemented from GRT::PreProcessing.
Definition at line 103 of file DeadZone.cpp.
|
virtual |
This saves the current settings of the DeadZone 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 123 of file DeadZone.cpp.
bool GRT::DeadZone::setLowerLimit | ( | double | lowerLimit | ) |
Sets the lower limit of the dead-zone region.
double | lowerLimit: the new lower limit for the dead zone |
Definition at line 262 of file DeadZone.cpp.
bool GRT::DeadZone::setUpperLimit | ( | double | upperLimit | ) |
Sets the upper limit of the dead-zone region.
double | upperLimit: the new upper limit for the dead zone |
Definition at line 267 of file DeadZone.cpp.