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

Public Types

enum  SwipeDirections { POSITIVE_SWIPE =0, NEGATIVE_SWIPE }
 
- Public Types inherited from GRT::Classifier
typedef std::map< string, Classifier *(*)() > StringClassifierMap
 
- Public Types inherited from GRT::MLBase
enum  BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }
 

Public Member Functions

 SwipeDetector (const unsigned int swipeIndex=0, const unsigned int swipeThreshold=100, const unsigned int hysteresisThreshold=0, const unsigned int swipeDirection=POSITIVE_SWIPE, bool useScaling=false)
 
 SwipeDetector (const SwipeDetector &rhs)
 
virtual ~SwipeDetector (void)
 
SwipeDetectoroperator= (const SwipeDetector &rhs)
 
virtual bool deepCopyFrom (const Classifier *classifier)
 
bool init (const unsigned int numInputDimensions)
 
virtual bool train_ (ClassificationData &trainingData)
 
virtual bool predict_ (VectorDouble &inputVector)
 
virtual bool clear ()
 
virtual bool reset ()
 
virtual bool saveModelToFile (fstream &file) const
 
virtual bool loadModelFromFile (fstream &file)
 
bool getSwipeDetected () const
 
double getSwipeValue () const
 
double getSwipeThreshold () const
 
double getHysteresisThreshold () const
 
double getMovementVelocity () const
 
double getMovementThreshold () const
 
double getContextValue () const
 
double getSwipeIntegrationCoeff () const
 
bool setContext (const bool context)
 
bool setSwipeIndex (const unsigned int swipeIndex)
 
bool setSwipeDirection (const unsigned int swipeDirection)
 
bool setSwipeThreshold (const double swipeThreshold)
 
bool setHysteresisThreshold (const double hysteresisThreshold)
 
bool setMovementThreshold (const double movementThreshold)
 
bool setSwipeIntegrationCoeff (const double swipeIntegrationCoeff)
 
- Public Member Functions inherited from GRT::Classifier
 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< MinMaxgetRanges () const
 
bool enableNullRejection (bool useNullRejection)
 
virtual bool setNullRejectionCoeff (double nullRejectionCoeff)
 
virtual bool setNullRejectionThresholds (VectorDouble newRejectionThresholds)
 
virtual bool recomputeNullRejectionThresholds ()
 
bool getTimeseriesCompatible () const
 
ClassifiercreateNewInstance () const
 
ClassifierdeepCopy () const
 
const ClassifiergetClassifierPointer () const
 
const ClassifiergetBaseClassifier () 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 (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 (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)
 
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

bool firstSample
 
bool swipeDetected
 
bool contextInput
 
unsigned int swipeIndex
 
unsigned int swipeDirection
 
unsigned int contextFilterSize
 
double swipeIntegrationCoeff
 
double movementIntegrationCoeff
 
double swipeThreshold
 
double hysteresisThreshold
 
double swipeVelocity
 
double movementVelocity
 
double movementThreshold
 
double contextFilteredValue
 
vector< double > lastX
 
GRT::ThresholdCrossingDetector thresholdDetector
 
GRT::MedianFilter contextFilter
 
- Protected Attributes inherited from GRT::Classifier
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< MinMaxranges
 
- 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 RegisterClassifierModule< SwipeDetectorregisterModule
 

Additional Inherited Members

- Static Public Member Functions inherited from GRT::Classifier
static ClassifiercreateInstanceFromString (string const &classifierType)
 
static vector< string > getRegisteredClassifiers ()
 
- Static Public Member Functions inherited from GRT::GRTBase
static string getGRTVersion (bool returnRevision=true)
 
static string getGRTRevison ()
 
- Protected Types inherited from GRT::Classifier
enum  ClassifierModes { STANDARD_CLASSIFIER_MODE =0, TIMESERIES_CLASSIFIER_MODE }
 
- Protected Member Functions inherited from GRT::Classifier
bool saveBaseSettingsToFile (fstream &file) const
 
bool loadBaseSettingsFromFile (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::Classifier
static StringClassifierMapgetMap ()
 

Detailed Description

Definition at line 40 of file SwipeDetector.h.

Constructor & Destructor Documentation

GRT::SwipeDetector::SwipeDetector ( const unsigned int  swipeIndex = 0,
const unsigned int  swipeThreshold = 100,
const unsigned int  hysteresisThreshold = 0,
const unsigned int  swipeDirection = POSITIVE_SWIPE,
bool  useScaling = false 
)

Default Constructor

Parameters
booluseScaling: sets if the training and prediction data should be scaled to a specific range. Default value is useScaling = false

Definition at line 28 of file SwipeDetector.cpp.

GRT::SwipeDetector::SwipeDetector ( const SwipeDetector rhs)

Defines the copy constructor.

Parameters
constSwipeDetector &rhs: the instance from which all the data will be copied into this instance

Definition at line 55 of file SwipeDetector.cpp.

GRT::SwipeDetector::~SwipeDetector ( void  )
virtual

Default Destructor

Definition at line 73 of file SwipeDetector.cpp.

Member Function Documentation

bool GRT::SwipeDetector::clear ( )
virtual

This overrides the clear function in the Classifier base class. It will completely clear the ML module, removing any trained model and setting all the base variables to their default values.

Returns
returns true if the module was cleared succesfully, false otherwise

Reimplemented from GRT::Classifier.

Definition at line 247 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::deepCopyFrom ( const Classifier classifier)
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 SwipeDetector instance) into this instance

Parameters
Classifier*classifier: a pointer to the Classifier Base Class, this should be pointing to another SwipeDetector instance
Returns
returns true if the clone was successfull, false otherwise

Reimplemented from GRT::Classifier.

Definition at line 104 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getContextValue ( ) const
Returns
returns the context value, this is the latest output of the context filter

Definition at line 445 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getHysteresisThreshold ( ) const
Returns
returns the hysteresis threshold, this is the value that the swipe analysis value must cross (after a valid swipe detection), before the next swipe will be detected

Definition at line 433 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getMovementThreshold ( ) const
Returns
returns the movement threshold, the movement velocity must be below this value for a valid swipe to be detected

Definition at line 441 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getMovementVelocity ( ) const

This function returns the movement velocity. This is the integrated difference between each of the additional inputs (that are not the swipe index) that is used to detected a valid swipe. The movement velocity must be below the movement threshold for a valid swipe to be detected.

Returns
returns the movement velocity

Definition at line 437 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::getSwipeDetected ( ) const
Returns
returns true if a swipe was detected, false otherwise

Definition at line 421 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getSwipeIntegrationCoeff ( ) const
Returns
returns the swipe integration coeff

Definition at line 449 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getSwipeThreshold ( ) const
Returns
returns the swipe threshold, this is the value that the swipe analysis value must cross for a swipe to be trigger

Definition at line 429 of file SwipeDetector.cpp.

double GRT::SwipeDetector::getSwipeValue ( ) const
Returns
returns the swipe analysis value, this is the value that the swipe threshold is matched against

Definition at line 425 of file SwipeDetector.cpp.

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

This loads a trained SwipeDetector model from a file. This overrides the loadModelFromFile function in the Classifier base class.

Parameters
fstream&file: a reference to the file the SwipeDetector model will be loaded from
Returns
returns true if the model was loaded successfully, false otherwise

Reimplemented from GRT::MLBase.

Definition at line 321 of file SwipeDetector.cpp.

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

Defines how the data from the rhs SwipeDetector should be copied to this SwipeDetector

Parameters
constSwipeDetector &rhs: another instance of a SwipeDetector
Returns
returns a pointer to this instance of the SwipeDetector

Definition at line 77 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::predict_ ( VectorDouble &  inputVector)
virtual

This predicts the class of the inputVector. This overrides the predict function in the Classifier base class.

Parameters
VectorDoubleinputVector: the input vector to classify
Returns
returns true if the prediction was performed, false otherwise

Reimplemented from GRT::MLBase.

Definition at line 189 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::reset ( )
virtual

This overrides the reset function in the Classifier base class.

Returns
returns true if the module was reset succesfully, false otherwise

Reimplemented from GRT::Classifier.

Definition at line 257 of file SwipeDetector.cpp.

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

This saves the trained SwipeDetector model to a file. This overrides the saveModelToFile function in the Classifier base class.

Parameters
fstream&file: a reference to the file the SwipeDetector model will be saved to
Returns
returns true if the model was saved successfully, false otherwise

Reimplemented from GRT::MLBase.

Definition at line 284 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setContext ( const bool  context)

This function lets you set the current context input. This should be called before you call the predict function.

Returns
returns true if the context value was updated, false otherwise

Definition at line 453 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setHysteresisThreshold ( const double  hysteresisThreshold)

This function lets you set the swipe hysteresisThreshold, this is the threshold that the swipe analysis value must pass after a valid swipe before a new swipe can be detected.

Parameters
constdouble hysteresisThreshold: the new hysteresis threshold
Returns
returns true if the parameter was updated, false otherwise

Definition at line 483 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setMovementThreshold ( const double  movementThreshold)

This function lets you set the swipe movementThreshold. The movement index must be below the movementThreshold for a valid swipe to be detected.

Parameters
constdouble movementThreshold: the new movement threshold
Returns
returns true if the parameter was updated, false otherwise

Definition at line 489 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setSwipeDirection ( const unsigned int  swipeDirection)

This function lets you set the swipe direction, this should be one of the SwipeDirections enums.

Parameters
constunsigned int swipeDirection: the direction you want to search for a swipe in
Returns
returns true if the parameter was updated, false otherwise

Definition at line 464 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setSwipeIndex ( const unsigned int  swipeIndex)

This function lets you set the swipe index, this is the index in the input vector that contains the main axis you want to use for the swipe detection. The other elements in the input vector will be combined to compute the movement index. The swipeIndex should be a valid index in your input vector.

Parameters
constunsigned int swipeIndex: the index in the input vector you want to use for the swipe detection
Returns
returns true if the parameter was updated, false otherwise

Definition at line 458 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setSwipeIntegrationCoeff ( const double  swipeIntegrationCoeff)

This function lets you set the swipe integration coeff. This controls how much 'memory' is used to when integrating the input data.

Parameters
constdouble swipeIntegrationCoeff: the new integration coefficient
Returns
returns true if the parameter was updated, false otherwise

Definition at line 495 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::setSwipeThreshold ( const double  swipeThreshold)

This function lets you set the swipe threshold, this is the threshold that the swipe analysis value must pass for a swipe to be detected.

Parameters
constdouble swipeThreshold: the new swipe threshold
Returns
returns true if the parameter was updated, false otherwise

Definition at line 477 of file SwipeDetector.cpp.

bool GRT::SwipeDetector::train_ ( ClassificationData trainingData)
virtual

This trains the SwipeDetector model, using the labelled classification data. This overrides the train function in the Classifier base class.

Parameters
ClassificationDatatrainingData: a reference to the training data
Returns
returns true if the SwipeDetector model was trained, false otherwise

Reimplemented from GRT::MLBase.

Definition at line 155 of file SwipeDetector.cpp.


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