GestureRecognitionToolkit  Version: 0.1.0
The Gesture Recognition Toolkit (GRT) is a cross-platform, open-source, c++ machine learning library for real-time gesture recognition.
MovementIndex Class Reference

#include <MovementIndex.h>

Inheritance diagram for MovementIndex:
FeatureExtraction MLBase GRTBase Observer< TrainingResult > Observer< TestInstanceResult >

Public Member Functions

 MovementIndex (UINT bufferLength=100, UINT numDimensions=1)
 
 MovementIndex (const MovementIndex &rhs)
 
virtual ~MovementIndex ()
 
MovementIndexoperator= (const MovementIndex &rhs)
 
virtual bool deepCopyFrom (const FeatureExtraction *featureExtraction)
 
virtual bool computeFeatures (const VectorFloat &inputVector)
 
virtual bool reset ()
 
virtual bool saveModelToFile (std::string filename) const
 
virtual bool loadModelFromFile (std::string filename)
 
virtual bool saveModelToFile (std::fstream &file) const
 
virtual bool loadModelFromFile (std::fstream &file)
 
bool init (UINT bufferLength, UINT numDimensions)
 
VectorFloat update (Float x)
 
VectorFloat update (const VectorFloat &x)
 
CircularBuffer< VectorFloatgetData ()
 
- Public Member Functions inherited from FeatureExtraction
 FeatureExtraction ()
 
virtual ~FeatureExtraction ()
 
bool copyBaseVariables (const FeatureExtraction *featureExtractionModule)
 
virtual bool computeFeatures (const MatrixFloat &inputMatrix)
 
virtual bool clear ()
 
std::string getFeatureExtractionType () const
 
UINT getNumInputDimensions () const
 
UINT getNumOutputDimensions () const
 
bool getInitialized () const
 
bool getFeatureDataReady () const
 
const VectorFloatgetFeatureVector () const
 
const MatrixFloatgetFeatureMatrix () const
 
FeatureExtractioncreateNewInstance () const
 
- Public Member Functions inherited from MLBase
 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 (ClassificationDataStream trainingData)
 
virtual bool train_ (ClassificationDataStream &trainingData)
 
virtual bool train (UnlabelledData trainingData)
 
virtual bool train_ (UnlabelledData &trainingData)
 
virtual bool train (MatrixFloat data)
 
virtual bool train_ (MatrixFloat &data)
 
virtual bool predict (VectorFloat inputVector)
 
virtual bool predict_ (VectorFloat &inputVector)
 
virtual bool predict (MatrixFloat inputMatrix)
 
virtual bool predict_ (MatrixFloat &inputMatrix)
 
virtual bool map (VectorFloat inputVector)
 
virtual bool map_ (VectorFloat &inputVector)
 
virtual bool print () const
 
virtual bool save (const std::string filename) const
 
virtual bool load (const std::string filename)
 
virtual bool getModel (std::ostream &stream) const
 
Float scale (const Float &x, const Float &minSource, const Float &maxSource, const Float &minTarget, const Float &maxTarget, const bool constrain=false)
 
virtual std::string getModelAsString () const
 
DataType getInputType () const
 
DataType getOutputType () 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
 
Float getMinChange () const
 
Float getLearningRate () const
 
Float getRootMeanSquaredTrainingError () const
 
Float getTotalSquaredTrainingError () const
 
Float getValidationSetAccuracy () const
 
VectorFloat getValidationSetPrecision () const
 
VectorFloat getValidationSetRecall () 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 (const bool useScaling)
 
bool setMaxNumEpochs (const UINT maxNumEpochs)
 
bool setMinNumEpochs (const UINT minNumEpochs)
 
bool setMinChange (const Float minChange)
 
bool setLearningRate (const Float learningRate)
 
bool setUseValidationSet (const bool useValidationSet)
 
bool setValidationSetSize (const UINT validationSetSize)
 
bool setRandomiseTrainingOrder (const bool randomiseTrainingOrder)
 
bool setTrainingLoggingEnabled (const bool loggingEnabled)
 
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)
 
MLBasegetMLBasePointer ()
 
const MLBasegetMLBasePointer () const
 
Vector< TrainingResult > getTrainingResults () const
 
- Public Member Functions inherited from GRTBase
 GRTBase (void)
 
virtual ~GRTBase (void)
 
bool copyGRTBaseVariables (const GRTBase *GRTBase)
 
std::string getClassType () const
 
std::string getLastWarningMessage () const
 
std::string getLastErrorMessage () const
 
std::string getLastInfoMessage () const
 
bool setInfoLoggingEnabled (const bool loggingEnabled)
 
bool setWarningLoggingEnabled (const bool loggingEnabled)
 
bool setErrorLoggingEnabled (const bool loggingEnabled)
 
GRTBasegetGRTBasePointer ()
 
const GRTBasegetGRTBasePointer () const
 
- Public Member Functions inherited from Observer< TrainingResult >
virtual void notify (const TrainingResult &data)
 
- Public Member Functions inherited from Observer< TestInstanceResult >
virtual void notify (const TestInstanceResult &data)
 

Protected Attributes

UINT bufferLength
 
CircularBuffer< VectorFloatdataBuffer
 
- Protected Attributes inherited from FeatureExtraction
std::string featureExtractionType
 
bool initialized
 
bool featureDataReady
 
VectorFloat featureVector
 
MatrixFloat featureMatrix
 
- Protected Attributes inherited from MLBase
bool trained
 
bool useScaling
 
DataType inputType
 
DataType outputType
 
UINT baseType
 
UINT numInputDimensions
 
UINT numOutputDimensions
 
UINT numTrainingIterationsToConverge
 
UINT minNumEpochs
 
UINT maxNumEpochs
 
UINT validationSetSize
 
Float learningRate
 
Float minChange
 
Float rootMeanSquaredTrainingError
 
Float totalSquaredTrainingError
 
Float validationSetAccuracy
 
bool useValidationSet
 
bool randomiseTrainingOrder
 
VectorFloat validationSetPrecision
 
VectorFloat validationSetRecall
 
Random random
 
std::vector< TrainingResult > trainingResults
 
TrainingResultsObserverManager trainingResultsObserverManager
 
TestResultsObserverManager testResultsObserverManager
 
- Protected Attributes inherited from GRTBase
std::string classType
 
DebugLog debugLog
 
ErrorLog errorLog
 
InfoLog infoLog
 
TrainingLog trainingLog
 
TestingLog testingLog
 
WarningLog warningLog
 

Static Protected Attributes

static RegisterFeatureExtractionModule< MovementIndexregisterModule
 

Additional Inherited Members

- Public Types inherited from FeatureExtraction
typedef std::map< std::string, FeatureExtraction *(*)() > StringFeatureExtractionMap
 
- Public Types inherited from MLBase
enum  BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }
 
- Static Public Member Functions inherited from FeatureExtraction
static FeatureExtractioncreateInstanceFromString (const std::string &featureExtractionType)
 
- Static Public Member Functions inherited from GRTBase
static std::string getGRTVersion (bool returnRevision=true)
 
static std::string getGRTRevison ()
 
- Protected Member Functions inherited from FeatureExtraction
bool init ()
 
bool saveFeatureExtractionSettingsToFile (std::fstream &file) const
 
bool loadFeatureExtractionSettingsFromFile (std::fstream &file)
 
- Protected Member Functions inherited from MLBase
bool saveBaseSettingsToFile (std::fstream &file) const
 
bool loadBaseSettingsFromFile (std::fstream &file)
 
- Protected Member Functions inherited from GRTBase
Float SQR (const Float &x) const
 
- Static Protected Member Functions inherited from FeatureExtraction
static StringFeatureExtractionMapgetMap ()
 

Detailed Description

GRT MIT License Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition at line 41 of file MovementIndex.h.

Constructor & Destructor Documentation

MovementIndex::MovementIndex ( UINT  bufferLength = 100,
UINT  numDimensions = 1 
)

Default Constructor. Sets the buffer length and the number of input dimensions.

Parameters
bufferLengththe size of the buffer that will hold the last N samples used to compute the movement index
numDimensionssets the number of dimensions

Definition at line 28 of file MovementIndex.cpp.

MovementIndex::MovementIndex ( const MovementIndex rhs)

Copy constructor, copies the MovementIndex from the rhs instance to this instance.

Parameters
rhsanother instance of the MovementIndex class from which the data will be copied to this instance

Definition at line 38 of file MovementIndex.cpp.

MovementIndex::~MovementIndex ( )
virtual

Default Destructor

Definition at line 50 of file MovementIndex.cpp.

Member Function Documentation

bool MovementIndex::computeFeatures ( const VectorFloat inputVector)
virtual

Sets the FeatureExtraction computeFeatures function, overwriting the base FeatureExtraction 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 MovementIndex's update function.

Parameters
inputVectorthe inputVector that should be processed. Must have the same dimensionality as the FeatureExtraction module
Returns
returns true if the data was processed, false otherwise

Reimplemented from FeatureExtraction.

Definition at line 82 of file MovementIndex.cpp.

bool MovementIndex::deepCopyFrom ( const FeatureExtraction featureExtraction)
virtual

Sets the FeatureExtraction deepCopyFrom function, overwriting the base FeatureExtraction function. This function is used to deep copy the values from the input pointer to this instance of the FeatureExtraction module. This function is called by the GestureRecognitionPipeline when the user adds a new FeatureExtraction module to the pipeleine.

Parameters
featureExtractiona pointer to another instance of a MovementIndex, the values of that instance will be cloned to this instance
Returns
returns true if the deep copy was successful, false otherwise

Reimplemented from FeatureExtraction.

Definition at line 65 of file MovementIndex.cpp.

CircularBuffer< VectorFloat > MovementIndex::getData ( )

Gets the current values in the data buffer. An empty circular buffer will be returned if the feature extraction module has not been initialized.

Returns
returns a curcular buffer containing the data buffer values, an empty circular buffer will be returned if the feature extraction module has not been initialized

Definition at line 275 of file MovementIndex.cpp.

bool MovementIndex::init ( UINT  bufferLength,
UINT  numDimensions 
)

Initializes the MovementIndex. This sets the bufferLength and the number of input dimensions.

Parameters
bufferLengththe size of the buffer that will hold the last N samples used to compute the movement index
numDimensionssets the number of dimensions
Returns
returns true if the module was initialized

Definition at line 191 of file MovementIndex.cpp.

bool MovementIndex::loadModelFromFile ( std::string  filename)
virtual

This saves the feature extraction settings to a file.

Parameters
filea reference to the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from MLBase.

Definition at line 120 of file MovementIndex.cpp.

bool MovementIndex::loadModelFromFile ( std::fstream &  file)
virtual

This loads the feature extraction settings from a file. This overrides the loadSettingsFromFile function in the FeatureExtraction base class.

Parameters
filea reference to the file to load the settings from
Returns
returns true if the settings were loaded successfully, false otherwise

Reimplemented from FeatureExtraction.

Definition at line 157 of file MovementIndex.cpp.

MovementIndex & MovementIndex::operator= ( const MovementIndex rhs)

Sets the equals operator, copies the data from the rhs instance to this instance.

Parameters
rhsanother instance of the MovementIndex class from which the data will be copied to this instance
Returns
a reference to this instance of MovementIndex

Definition at line 54 of file MovementIndex.cpp.

bool MovementIndex::reset ( )
virtual

Sets the FeatureExtraction reset function, overwriting the base FeatureExtraction function. This function is called by the GestureRecognitionPipeline when the pipelines main reset() function is called. This function resets the feature extraction by re-initiliazing the instance.

Returns
true if the filter was reset, false otherwise

Reimplemented from FeatureExtraction.

Definition at line 99 of file MovementIndex.cpp.

bool MovementIndex::saveModelToFile ( std::string  filename) const
virtual

This saves the feature extraction settings to a file.

Parameters
filenamethe filename to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from MLBase.

Definition at line 106 of file MovementIndex.cpp.

bool MovementIndex::saveModelToFile ( std::fstream &  file) const
virtual

This saves the feature extraction settings to a file. This overrides the saveSettingsToFile function in the FeatureExtraction base class.

Parameters
filea reference to the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from FeatureExtraction.

Definition at line 135 of file MovementIndex.cpp.

VectorFloat MovementIndex::update ( Float  x)

Computes the features from the input, this should only be called if the dimensionality of this instance was set to 1.

Parameters
xthe value to compute features from, this should only be called if the dimensionality of the filter was set to 1
Returns
a vector containing the features, an empty vector will be returned if the features were not computed

Definition at line 223 of file MovementIndex.cpp.

VectorFloat MovementIndex::update ( const VectorFloat x)

Computes the features from the input, the dimensionality of x should match that of this instance.

Parameters
xa vector containing the values to be processed, must be the same size as the numInputDimensions
Returns
a vector containing the features, an empty vector will be returned if the features were not computed

Definition at line 227 of file MovementIndex.cpp.


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