SwipeDetector.h

Go to the documentation of this file.

#ifndef GRT_SWIPE_DETECTION_HEADER
#define GRT_SWIPE_DETECTION_HEADER

#include "../../CoreModules/Classifier.h"
#include "../../Util/ThresholdCrossingDetector.h"
#include "../../PreProcessingModules/MedianFilter.h"

GRT_BEGIN_NAMESPACE

class GRT_API SwipeDetector : public Classifier
{
public:
    enum SwipeDirections{POSITIVE_SWIPE=0,NEGATIVE_SWIPE};
    
 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);
    
 SwipeDetector &operator=(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 save( std::fstream &file ) const;
    
    virtual bool load( std::fstream &file );
    
    bool getSwipeDetected() const;
    
    Float getSwipeValue() const;
    
    Float getSwipeThreshold() const ;
    
    Float getHysteresisThreshold() const;
    
    Float getMovementVelocity() const;
    
    Float getMovementThreshold() const;
    
    Float getContextValue() const;
    
    Float getSwipeIntegrationCoeff() const;
    
    bool setContext(const bool context);
    
    bool setSwipeIndex(const unsigned int swipeIndex);
    
    bool setSwipeDirection(const unsigned int swipeDirection);
    
    bool setSwipeThreshold(const Float swipeThreshold);
    
    bool setHysteresisThreshold(const Float hysteresisThreshold);
    
    bool setMovementThreshold(const Float movementThreshold);
    
    bool setSwipeIntegrationCoeff(const Float swipeIntegrationCoeff);

    static std::string getId();

    //Tell the compiler we are using the following functions from the MLBase class to stop hidden virtual function warnings
    using MLBase::save;
    using MLBase::load;
    using MLBase::train_;
    using MLBase::predict_;

protected:
    
    bool firstSample;
    bool swipeDetected;
    bool contextInput;
    unsigned int swipeIndex;
    unsigned int swipeDirection;
    unsigned int contextFilterSize;
    Float swipeIntegrationCoeff;
    Float movementIntegrationCoeff;
    Float swipeThreshold;
    Float hysteresisThreshold;
    Float swipeVelocity;
    Float movementVelocity;
    Float movementThreshold;
    Float contextFilteredValue;
    VectorFloat lastX;
    GRT::ThresholdCrossingDetector thresholdDetector;
    GRT::MedianFilter contextFilter;

private:
    static const std::string id;
    static RegisterClassifierModule< SwipeDetector > registerModule;
};

GRT_END_NAMESPACE

#endif //GRT_SWIPE_DETECTION_HEADER