KMeansQuantizer.h

Go to the documentation of this file.

#ifndef GRT_KMEANS_QUANTIZER_HEADER
#define GRT_KMEANS_QUANTIZER_HEADER

//Include the main GRT header to get access to the FeatureExtraction base class
#include "../../CoreModules/FeatureExtraction.h"
#include "../../ClusteringModules/KMeans/KMeans.h"
#include "../../DataStructures/ClassificationDataStream.h"
#include "../../DataStructures/TimeSeriesClassificationData.h"
#include "../../DataStructures/UnlabelledData.h"

GRT_BEGIN_NAMESPACE

class GRT_API KMeansQuantizer : public FeatureExtraction{
public:
    KMeansQuantizer(const UINT numClusters=10);
    
    KMeansQuantizer(const KMeansQuantizer &rhs);
    
    virtual ~KMeansQuantizer();
    
    KMeansQuantizer& operator=(const KMeansQuantizer &rhs);
    
    virtual bool deepCopyFrom(const FeatureExtraction *featureExtraction);
    
    virtual bool computeFeatures(const VectorFloat &inputVector);
    
    virtual bool reset();
    
    virtual bool clear();
    
    virtual bool save( std::fstream &file ) const;
    
    virtual bool load( std::fstream &file );
    
    virtual bool train_(ClassificationData &trainingData);
    
    virtual bool train_(TimeSeriesClassificationData &trainingData);
    
    virtual bool train_(ClassificationDataStream &trainingData);
    
    virtual bool train_(UnlabelledData &trainingData);
    
    virtual bool train_(MatrixFloat &trainingData);
    
    UINT quantize(const Float inputValue);
    
    UINT quantize(const VectorFloat &inputVector);
    
    bool getQuantizerTrained() const { return trained; }
    
    UINT getNumClusters() const;
    
    UINT getQuantizedValue() const { return (trained ? (UINT)featureVector[0] : 0); }
    
    VectorFloat getQuantizationDistances() const{
        return quantizationDistances;
    }
    
    MatrixFloat getQuantizationModel() const{
        return clusters;
    }
    
    bool setNumClusters(const UINT numClusters);
    
    //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::predict_;

    static std::string getId();
    
protected:
    UINT numClusters;
    MatrixFloat clusters;
    VectorFloat quantizationDistances;
    
private:
    static RegisterFeatureExtractionModule< KMeansQuantizer > registerModule;
    static std::string id;
};

GRT_END_NAMESPACE

#endif //GRT_KMEANS_QUANTIZER_HEADER