Classifier.h

Go to the documentation of this file.

#ifndef GRT_CLASSIFIER_HEADER
#define GRT_CLASSIFIER_HEADER

#include "MLBase.h"

GRT_BEGIN_NAMESPACE
    
#define DEFAULT_NULL_LIKELIHOOD_VALUE 0
#define DEFAULT_NULL_DISTANCE_VALUE 0

class Classifier : public MLBase
{
public:
 Classifier(void);
    
 virtual ~Classifier(void);
    
    virtual bool deepCopyFrom(const Classifier *classifier){ return false; }
    
    bool copyBaseVariables(const Classifier *classifier);
    
    virtual bool reset();
    
    virtual bool clear();

    std::string getClassifierType() const;
    
    bool getSupportsNullRejection() const;
    
    bool getNullRejectionEnabled() const;
    
    Float getNullRejectionCoeff() const;
    
    Float getMaximumLikelihood() const;
    
    Float getBestDistance() const;
    
    Float getPhase() const;
    
    virtual UINT getNumClasses() const;
    
    UINT getClassLabelIndexValue(UINT classLabel) const;
    
    UINT getPredictedClassLabel() const;
    
    VectorFloat getClassLikelihoods() const;
    
    VectorFloat getClassDistances() const;
    
    VectorFloat getNullRejectionThresholds() const;
    
    Vector< UINT > getClassLabels() const;
    
    Vector<MinMax> getRanges() const;

    bool enableNullRejection(bool useNullRejection);
    
    virtual bool setNullRejectionCoeff(Float nullRejectionCoeff);

 virtual bool setNullRejectionThresholds(VectorFloat newRejectionThresholds);
    
    virtual bool recomputeNullRejectionThresholds(){ return false; }
    
    bool getTimeseriesCompatible() const{ return classifierMode==TIMESERIES_CLASSIFIER_MODE; }
    
    typedef std::map< std::string, Classifier*(*)() > StringClassifierMap;
    
    static Classifier* createInstanceFromString( std::string const &classifierType );
    
    Classifier* createNewInstance() const;
    
    Classifier* deepCopy() const;
    
    const Classifier* getClassifierPointer() const;
    
    const Classifier& getBaseClassifier() const;

 static Vector< std::string > getRegisteredClassifiers();
    
protected:
    bool saveBaseSettingsToFile( std::fstream &file ) const;
    
    bool loadBaseSettingsFromFile( std::fstream &file );

    std::string classifierType;
    bool supportsNullRejection;
    bool useNullRejection;
    UINT numClasses;
    UINT predictedClassLabel;
    UINT classifierMode;
    Float nullRejectionCoeff;
    Float maxLikelihood;
    Float bestDistance;
    Float phase;
    VectorFloat classLikelihoods;
    VectorFloat classDistances;
    VectorFloat nullRejectionThresholds;
    Vector< UINT > classLabels;
    Vector< MinMax > ranges;
    
    static StringClassifierMap *getMap() {
        if( !stringClassifierMap ){ stringClassifierMap = new StringClassifierMap; } 
        return stringClassifierMap; 
    }
        
    enum ClassifierModes{STANDARD_CLASSIFIER_MODE=0,TIMESERIES_CLASSIFIER_MODE};
    
private:
    static StringClassifierMap *stringClassifierMap;
    static UINT numClassifierInstances;
    
};
    
//These two functions/classes are used to register any new Classification Module with the Classifier base class
template< typename T >  Classifier* getNewClassificationModuleInstance() { return new T; }

template< typename T >
class RegisterClassifierModule : public Classifier {
public:
    RegisterClassifierModule( std::string const &newClassificationModuleName ) { 
        getMap()->insert( std::pair< std::string, Classifier*(*)() >(newClassificationModuleName, &getNewClassificationModuleInstance< T > ) );
    }
};

GRT_END_NAMESPACE

#endif //GRT_CLASSIFIER_HEADER