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 ZeroCrossingCounter : public FeatureExtraction{
public:
    ZeroCrossingCounter(UINT searchWindowSize = 20,Float deadZoneThreshold = 0.01,UINT numDimensions = 1,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 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 searchWindowSize,Float deadZoneThreshold,UINT numDimensions,UINT featureMode);
    
 VectorFloat update(Float x);
    
    VectorFloat update(const VectorFloat &x);
    
    bool setSearchWindowSize(UINT searchWindowSize);

    bool setFeatureMode(UINT featureMode);
    
    bool setDeadZoneThreshold(Float deadZoneThreshold);

    UINT getSearchWindowSize(){ if( initialized ){ return searchWindowSize; } return 0; }
    
    UINT getNumFeatures(){ return TOTAL_NUM_ZERO_CROSSING_FEATURES; }
    
    UINT getFeatureMode(){ return featureMode; }
    
    Float getDeadZoneThreshold(){ if( initialized ){ return deadZoneThreshold; } return 0; }
    
    CircularBuffer< VectorFloat > getDataBuffer(){ 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 FeatureExtraction::saveModelToFile;
    using FeatureExtraction::loadModelFromFile;
    using MLBase::train;
    using MLBase::train_;
    using MLBase::predict;
    using MLBase::predict_;
    
protected:
    UINT searchWindowSize;                                  
    UINT featureMode;                                       
    Float deadZoneThreshold;                               
    Derivative derivative;                                  
    DeadZone deadZone;                                      
    CircularBuffer< VectorFloat > dataBuffer;              
    
    static RegisterFeatureExtractionModule< ZeroCrossingCounter > registerModule;
    
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};
};

GRT_END_NAMESPACE

#endif //GRT_ZERO_CROSSING_COUNTER_HEADER