SOMQuantizer.h

Go to the documentation of this file.

#ifndef GRT_SOM_QUANTIZER_HEADER
#define GRT_SOM_QUANTIZER_HEADER

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

GRT_BEGIN_NAMESPACE

class GRT_API SOMQuantizer : public FeatureExtraction{
public:
    SOMQuantizer(const UINT numClusters=10);
    
    SOMQuantizer(const SOMQuantizer &rhs);
    
    virtual ~SOMQuantizer();
    
    SOMQuantizer& operator=(const SOMQuantizer &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;
    
    UINT getNumClusters() const;
    
    UINT getQuantizedValue() const;
    
    VectorFloat getQuantizationDistances() const;
    
    SelfOrganizingMap getSelfOrganizingMap() const;
    
    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::train_;
    using MLBase::predict;
    using MLBase::predict_;

    static std::string getId();
    
protected:
    UINT numClusters;
    SelfOrganizingMap som;
    VectorFloat quantizationDistances;
    
private:
    static RegisterFeatureExtractionModule< SOMQuantizer > registerModule;
    static std::string id;
};

GRT_END_NAMESPACE

#endif //GRT_SOM_QUANTIZER_HEADER