ClassLabelTimeoutFilter.h

Go to the documentation of this file.

#ifndef GRT_CLASS_LABEL_TIMEOUT_FILTER_HEADER
#define GRT_CLASS_LABEL_TIMEOUT_FILTER_HEADER

#include "../Util/GRTCommon.h"
#include "../CoreModules/PostProcessing.h"

GRT_BEGIN_NAMESPACE

class GRT_API ClassLabelAndTimer{
 public:
 ClassLabelAndTimer(){
 classLabel = 0;
 }
 ClassLabelAndTimer(UINT classLabel,unsigned long timeoutDuration){
 this->classLabel = classLabel;
 timer.start(timeoutDuration);
 }
 
 //Setters
 bool set(UINT classLabel,unsigned long timeoutDuration){
 if( classLabel > 0 && timeoutDuration > 0 ){
 this->classLabel = classLabel;
 timer.start(timeoutDuration);
 return true;
 }
 return false;
 }
 
 //Getters
 UINT getClassLabel(){ return classLabel; }
 bool timerReached(){ return timer.timerReached(); }
 unsigned long getRemainingTime(){ return timer.getMilliSeconds(); }
 
 protected:
 UINT classLabel;
 Timer timer;
};

class GRT_API ClassLabelTimeoutFilter : public PostProcessing{
public:
 enum FilterModes{ALL_CLASS_LABELS=0,INDEPENDENT_CLASS_LABELS};

 ClassLabelTimeoutFilter(const unsigned long timeoutDuration = 1000,const UINT filterMode = ALL_CLASS_LABELS);
 
 ClassLabelTimeoutFilter(const ClassLabelTimeoutFilter &rhs);
 
 virtual ~ClassLabelTimeoutFilter();
 
 ClassLabelTimeoutFilter& operator=(const ClassLabelTimeoutFilter &rhs);
 
 virtual bool deepCopyFrom(const PostProcessing *postProcessing) override;
 
 virtual bool process(const VectorDouble &inputVector) override;
 
 virtual bool reset() override;
 
 virtual bool save( std::fstream &file ) const override;
 
 virtual bool load( std::fstream &file ) override;
 
 bool init(const unsigned long timeoutDuration,const UINT filterMode = ALL_CLASS_LABELS);
 
 UINT filter(const UINT predictedClassLabel);
 
 UINT getFilteredClassLabel() const { return filteredClassLabel; }
 
 bool isTimeoutActive();
 
 bool setTimeoutDuration(const unsigned long timeoutDuration);
 
 bool setFilterMode(const UINT filterMode);

 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;
 
protected:
 UINT filteredClassLabel;
 UINT filterMode;
 unsigned long timeoutDuration;
 Vector< ClassLabelAndTimer > classLabelTimers;
 
private:
 static const std::string id; 
 static RegisterPostProcessingModule< ClassLabelTimeoutFilter > registerModule;
};

GRT_END_NAMESPACE

#endif //GRT_CLASS_LABEL_TIMEOUT_FILTER_HEADER