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.
GRT::MovementTrajectoryFeatures Class Reference
Inheritance diagram for GRT::MovementTrajectoryFeatures:
GRT::FeatureExtraction GRT::MLBase GRT::GRTBase GRT::Observer< TrainingResult > GRT::Observer< TestInstanceResult >

Public Types

enum  FeatureModes { CENTROID_VALUE =0, NORMALIZED_CENTROID_VALUE, CENTROID_DERIVATIVE, CENTROID_ANGLE_2D }
 
- Public Types inherited from GRT::FeatureExtraction
typedef std::map< string, FeatureExtraction *(*)() > StringFeatureExtractionMap
 
- Public Types inherited from GRT::MLBase
enum  BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }
 

Public Member Functions

 MovementTrajectoryFeatures (UINT trajectoryLength=100, UINT numCentroids=10, UINT featureMode=CENTROID_VALUE, UINT numHistogramBins=10, UINT numDimensions=1, bool useTrajStartAndEndValues=false, bool useWeightedMagnitudeValues=true)
 
 MovementTrajectoryFeatures (const MovementTrajectoryFeatures &rhs)
 
virtual ~MovementTrajectoryFeatures ()
 
MovementTrajectoryFeaturesoperator= (const MovementTrajectoryFeatures &rhs)
 
virtual bool deepCopyFrom (const FeatureExtraction *featureExtraction)
 
virtual bool computeFeatures (const VectorDouble &inputVector)
 
virtual bool reset ()
 
virtual bool saveModelToFile (string filename) const
 
virtual bool loadModelFromFile (string filename)
 
virtual bool saveModelToFile (fstream &file) const
 
virtual bool loadModelFromFile (fstream &file)
 
bool init (UINT trajectoryLength, UINT numCentroids, UINT featureMode, UINT numHistogramBins, UINT numDimensions, bool useTrajStartAndEndValues, bool useWeightedMagnitudeValues)
 
VectorDouble update (double x)
 
VectorDouble update (const VectorDouble &x)
 
CircularBuffer< VectorDouble > getTrajectoryData ()
 
MatrixDouble getCentroids ()
 
UINT getFeatureMode ()
 
- Public Member Functions inherited from GRT::FeatureExtraction
 FeatureExtraction ()
 
virtual ~FeatureExtraction ()
 
bool copyBaseVariables (const FeatureExtraction *featureExtractionModule)
 
virtual bool clear ()
 
string getFeatureExtractionType () const
 
UINT getNumInputDimensions () const
 
UINT getNumOutputDimensions () const
 
bool getInitialized () const
 
bool getFeatureDataReady () const
 
VectorDouble getFeatureVector () const
 
FeatureExtractioncreateNewInstance () const
 
- Public Member Functions inherited from GRT::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 (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)
 
MLBasegetMLBasePointer ()
 
const MLBasegetMLBasePointer () const
 
vector< TrainingResultgetTrainingResults () const
 
- Public Member Functions inherited from GRT::GRTBase
 GRTBase (void)
 
virtual ~GRTBase (void)
 
bool copyGRTBaseVariables (const GRTBase *GRTBase)
 
string getClassType () const
 
string getLastWarningMessage () const
 
string getLastErrorMessage () const
 
string getLastInfoMessage () const
 
GRTBasegetGRTBasePointer ()
 
const GRTBasegetGRTBasePointer () const
 
- Public Member Functions inherited from GRT::Observer< TrainingResult >
virtual void notify (const TrainingResult &data)
 
- Public Member Functions inherited from GRT::Observer< TestInstanceResult >
virtual void notify (const TestInstanceResult &data)
 

Protected Attributes

UINT trajectoryLength
 
UINT numCentroids
 
UINT featureMode
 
UINT numHistogramBins
 
bool useTrajStartAndEndValues
 
bool useWeightedMagnitudeValues
 
CircularBuffer< VectorDouble > trajectoryDataBuffer
 
MatrixDouble centroids
 
- Protected Attributes inherited from GRT::FeatureExtraction
string featureExtractionType
 
bool initialized
 
bool featureDataReady
 
VectorDouble featureVector
 
- Protected Attributes inherited from GRT::MLBase
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< TrainingResulttrainingResults
 
TrainingResultsObserverManager trainingResultsObserverManager
 
TestResultsObserverManager testResultsObserverManager
 
- Protected Attributes inherited from GRT::GRTBase
string classType
 
DebugLog debugLog
 
ErrorLog errorLog
 
InfoLog infoLog
 
TrainingLog trainingLog
 
TestingLog testingLog
 
WarningLog warningLog
 

Static Protected Attributes

static RegisterFeatureExtractionModule< MovementTrajectoryFeaturesregisterModule
 

Additional Inherited Members

- Static Public Member Functions inherited from GRT::FeatureExtraction
static FeatureExtractioncreateInstanceFromString (string const &featureExtractionType)
 
- Static Public Member Functions inherited from GRT::GRTBase
static string getGRTVersion (bool returnRevision=true)
 
static string getGRTRevison ()
 
- Protected Member Functions inherited from GRT::FeatureExtraction
bool init ()
 
bool saveFeatureExtractionSettingsToFile (fstream &file) const
 
bool loadFeatureExtractionSettingsFromFile (fstream &file)
 
- Protected Member Functions inherited from GRT::MLBase
bool saveBaseSettingsToFile (fstream &file) const
 
bool loadBaseSettingsFromFile (fstream &file)
 
- Protected Member Functions inherited from GRT::GRTBase
double SQR (const double &x) const
 
- Static Protected Member Functions inherited from GRT::FeatureExtraction
static StringFeatureExtractionMapgetMap ()
 

Detailed Description

Definition at line 47 of file MovementTrajectoryFeatures.h.

Constructor & Destructor Documentation

GRT::MovementTrajectoryFeatures::MovementTrajectoryFeatures ( UINT  trajectoryLength = 100,
UINT  numCentroids = 10,
UINT  featureMode = CENTROID_VALUE,
UINT  numHistogramBins = 10,
UINT  numDimensions = 1,
bool  useTrajStartAndEndValues = false,
bool  useWeightedMagnitudeValues = true 
)

Default Constructor.

Definition at line 28 of file MovementTrajectoryFeatures.cpp.

GRT::MovementTrajectoryFeatures::MovementTrajectoryFeatures ( const MovementTrajectoryFeatures rhs)

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

Parameters
constMovementTrajectoryFeatures &rhs: another instance of the MovementTrajectoryFeatures class from which the data will be copied to this instance

Definition at line 39 of file MovementTrajectoryFeatures.cpp.

GRT::MovementTrajectoryFeatures::~MovementTrajectoryFeatures ( )
virtual

Default Destructor

Definition at line 51 of file MovementTrajectoryFeatures.cpp.

Member Function Documentation

bool GRT::MovementTrajectoryFeatures::computeFeatures ( const VectorDouble &  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 MovementTrajectoryFeatures's update function.

Parameters
constvector< double > &inputVector: the 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 GRT::FeatureExtraction.

Definition at line 89 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::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 pipeline.

Parameters
FeatureExtraction*featureExtraction: a pointer to another instance of a MovementTrajectoryFeatures, the values of that instance will be cloned to this instance
Returns
returns true if the deep copy was successful, false otherwise

Reimplemented from GRT::FeatureExtraction.

Definition at line 72 of file MovementTrajectoryFeatures.cpp.

MatrixDouble GRT::MovementTrajectoryFeatures::getCentroids ( )

Gets a matrix containing the centroids of the trajectory data. Each row represents the centroids from a subsection of the trajectory data, each column represents a dimension.

Returns
returns a MatrixDouble containing the centroids of the trajectory data

Definition at line 481 of file MovementTrajectoryFeatures.cpp.

UINT GRT::MovementTrajectoryFeatures::getFeatureMode ( )

Gets an unsigned int representing the current feature mode. This will be one of the FeatureModes enums.

Returns
returns the current feature mode

Definition at line 488 of file MovementTrajectoryFeatures.cpp.

CircularBuffer< VectorDouble > GRT::MovementTrajectoryFeatures::getTrajectoryData ( )

Gets the current values in the trajectory 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 474 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::init ( UINT  trajectoryLength,
UINT  numCentroids,
UINT  featureMode,
UINT  numHistogramBins,
UINT  numDimensions,
bool  useTrajStartAndEndValues,
bool  useWeightedMagnitudeValues 
)

Initializes the MovementTrajectoryFeatures

Definition at line 243 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::loadModelFromFile ( string  filename)
virtual

This saves the feature extraction settings to a file.

Parameters
fstream&file: a reference to the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from GRT::MLBase.

Definition at line 127 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::loadModelFromFile ( fstream &  file)
virtual

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

Parameters
fstream&file: a reference to the file to load the settings from
Returns
returns true if the settings were loaded successfully, false otherwise

Reimplemented from GRT::FeatureExtraction.

Definition at line 169 of file MovementTrajectoryFeatures.cpp.

MovementTrajectoryFeatures & GRT::MovementTrajectoryFeatures::operator= ( const MovementTrajectoryFeatures rhs)

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

Parameters
constMovementTrajectoryFeatures &rhs: another instance of the MovementTrajectoryFeatures class from which the data will be copied to this instance
Returns
a reference to this instance of MovementTrajectoryFeatures

Definition at line 55 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::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 GRT::FeatureExtraction.

Definition at line 106 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::saveModelToFile ( string  filename) const
virtual

This saves the feature extraction settings to a file.

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

Reimplemented from GRT::MLBase.

Definition at line 113 of file MovementTrajectoryFeatures.cpp.

bool GRT::MovementTrajectoryFeatures::saveModelToFile ( fstream &  file) const
virtual

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

Parameters
fstream&file: a reference to the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from GRT::FeatureExtraction.

Definition at line 142 of file MovementTrajectoryFeatures.cpp.

VectorDouble GRT::MovementTrajectoryFeatures::update ( double  x)

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

Parameters
doublex: the 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 324 of file MovementTrajectoryFeatures.cpp.

VectorDouble GRT::MovementTrajectoryFeatures::update ( const VectorDouble &  x)

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

Parameters
constvector<double> &x: a 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 328 of file MovementTrajectoryFeatures.cpp.


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