ZeroCrossingCounter.h

Go to the documentation of this file.

#ifndef GRT_ZERO_CROSSING_COUNTER_HEADER
#define GRT_ZERO_CROSSING_COUNTER_HEADER

#include "../../CoreModules/FeatureExtraction.h"
#include "../../PreProcessingModules/Derivative.h"
#include "../../PreProcessingModules/DeadZone.h"

GRT_BEGIN_NAMESPACE

class GRT_API ZeroCrossingCounter : public FeatureExtraction{
public:
    enum ZeroCrossingFeatureIDs{NUM_ZERO_CROSSINGS_COUNTED=0,ZERO_CROSSING_MAGNITUDE,TOTAL_NUM_ZERO_CROSSING_FEATURES};
    enum FeatureModes{INDEPENDANT_FEATURE_MODE=0,COMBINED_FEATURE_MODE};
    
    ZeroCrossingCounter(const UINT searchWindowSize = 20,const Float deadZoneThreshold = 0.01,const UINT numDimensions = 1,const UINT featureMode = INDEPENDANT_FEATURE_MODE);
    
    ZeroCrossingCounter(const ZeroCrossingCounter &rhs);
    
    virtual ~ZeroCrossingCounter();
    
    ZeroCrossingCounter& operator=(const ZeroCrossingCounter &rhs);
    
    virtual bool deepCopyFrom(const FeatureExtraction *featureExtraction);
    
    virtual bool computeFeatures(const VectorFloat &inputVector);
    
    virtual bool reset();
    
    virtual bool save( std::fstream &file ) const;
    
    virtual bool load( std::fstream &file );
    
    bool init(const UINT searchWindowSize,const Float deadZoneThreshold,const UINT numDimensions,const UINT featureMode);
    
    VectorFloat update(const Float x);
    
    VectorFloat update(const VectorFloat &x);
    
    bool setSearchWindowSize(const UINT searchWindowSize);
    
    bool setFeatureMode(const UINT featureMode);
    
    bool setDeadZoneThreshold(const Float deadZoneThreshold);
    
    UINT getSearchWindowSize() const { if( initialized ){ return searchWindowSize; } return 0; }
    
    UINT getNumFeatures() const { return TOTAL_NUM_ZERO_CROSSING_FEATURES; }
    
    UINT getFeatureMode() const { return featureMode; }
    
    Float getDeadZoneThreshold() const { if( initialized ){ return deadZoneThreshold; } return 0; }
    
    CircularBuffer< VectorFloat > getDataBuffer() const { if( initialized ){ return dataBuffer; } return CircularBuffer< VectorFloat >(); }
    
    //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::train_;
    using MLBase::predict;
    using MLBase::predict_;

    static std::string getId();
    
protected:
    UINT searchWindowSize;                                  
    UINT featureMode;                                       
    Float deadZoneThreshold;                               
    Derivative derivative;                                  
    DeadZone deadZone;                                      
    CircularBuffer< VectorFloat > dataBuffer;              
    
private:
    static RegisterFeatureExtractionModule< ZeroCrossingCounter > registerModule;
    static std::string id;

};

GRT_END_NAMESPACE

#endif //GRT_ZERO_CROSSING_COUNTER_HEADER