ThresholdCrossingDetector.h

Go to the documentation of this file.

/*
 GRT MIT License
 Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 and associated documentation files (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial
 portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef GRT_THRESHOLD_CROSSING_DETECTOR_HEADER
#define GRT_THRESHOLD_CROSSING_DETECTOR_HEADER

#include "../PreProcessingModules/MovingAverageFilter.h"
#include "../PreProcessingModules/Derivative.h"
#include "CircularBuffer.h"

GRT_BEGIN_NAMESPACE
    
class GRT_API ThresholdCrossingDetector{
public:
    ThresholdCrossingDetector(UINT analysisMode = RAW_DATA_ANALYSIS_MODE,UINT thresholdCrossingMode = UPPER_THRESHOLD_CROSSING,UINT detectionTimeoutMode = TIMEOUT_COUNTER,Float lowerThreshold = -1,Float upperThreshold = 1,Float hysteresisThreshold = 0,UINT searchWindowSize = 20,UINT searchTimeoutDuration = 1000,UINT offsetFilterSize = 10);
    
 ~ThresholdCrossingDetector();
    
    ThresholdCrossingDetector(const ThresholdCrossingDetector &rhs);
    
    ThresholdCrossingDetector& operator=(const ThresholdCrossingDetector &rhs);
    
    bool update( const Float x );
    
    bool reset();
    
    bool triggerSearchTimeout();
    
    bool getThresholdCrossingDetected() const;
    
    bool getEnableSearch() const;
    
    UINT getAnalysisMode() const;
    
    UINT getThresholdCrossingMode() const;
    
    UINT getSearchWindowSize() const;
    
    UINT getOffsetFilterSize() const;
    
    UINT getSearchWindowIndex() const;
    
    UINT getSearchTimeoutCounter();
    
    UINT getSearchTimeoutDuration() const;
    
    Float getAnalysisValue() const;
    
    Float getUpperThreshold() const;
    
    Float getLowerThreshold() const;
    
    Float getHysteresisThreshold() const;
    
    bool setEnableSearch(const bool enableSearch);
    
    bool setAnalysisMode(const UINT analysisMode);
    
    bool setThresholdCrossingMode(const UINT thresholdCrossingMode);
    
    bool setSearchWindowSize(const UINT searchWindowSize);
    
    bool setOffsetFilterSize(const UINT offsetFilterSize);
    
    bool setSearchTimeoutDuration(const UINT searchTimeoutDuration);
    
    bool setDetectionTimeoutMode(const UINT detectionTimeoutMode);
    
    bool setLowerThreshold(const Float lowerThreshold);
    
    bool setUpperThreshold(const Float upperThreshold);
    
    bool setHysteresisThreshold(const Float hysteresisThreshold);
    
protected:
    Float analysisValue;
    Float lowerThreshold;
    Float upperThreshold;
    Float hysteresisThreshold;
    bool enableSearch;
    bool thresholdCrossingDetected;
    unsigned int analysisMode;
    unsigned int thresholdCrossingMode;
    unsigned int detectionTimeoutMode;
    unsigned int searchTimeoutDuration;
    unsigned int searchWindowSize;
    unsigned int searchWindowIndex;
    unsigned int offsetFilterSize;
    unsigned int currentSearchState;
    Timer searchTimeoutCounter;
    MovingAverageFilter movingAverageFilter;
    Derivative derivative;
    
public:
    enum SearchStates{SEARCHING_FOR_FIRST_THRESHOLD_CROSSING=0,SEARCHING_FOR_SECOND_THRESHOLD_CROSSING,NO_SEARCH_GATE_TIME_OUT};

    enum ThresholdCrossingModes{UPPER_THRESHOLD_CROSSING=0,
                                LOWER_THRESHOLD_CROSSING,
                                UPPER_OR_LOWER_THRESHOLD_CROSSING,
                                UPPER_THEN_LOWER_THRESHOLD_CROSSING,
                                LOWER_THEN_UPPER_THRESHOLD_CROSSING};
    
    enum AnalysisModes{RAW_DATA_ANALYSIS_MODE=0,MOVING_OFFSET_ANALYSIS_MODE,DERIVATIVE_ANALYSIS_MODE};
    
    enum DetectionTimeoutMode{TIMEOUT_COUNTER=0,HYSTERESIS_THRESHOLD};
 
};

GRT_END_NAMESPACE

#endif //GRT_THRESHOLD_CROSSING_DETECTOR_HEADER