FeatureExtraction.h

Go to the documentation of this file.

#ifndef GRT_FEATURE_EXTRACTION_HEADER
#define GRT_FEATURE_EXTRACTION_HEADER

#include "MLBase.h"

GRT_BEGIN_NAMESPACE

class GRT_API FeatureExtraction : public MLBase
{
public:
 FeatureExtraction( const std::string id = "" );
    
 virtual ~FeatureExtraction();
    
    virtual bool deepCopyFrom(const FeatureExtraction *rhs){ return false; };
    
    bool copyBaseVariables(const FeatureExtraction *featureExtractionModule);

    virtual bool computeFeatures(const VectorFloat &inputVector){ return false; }

    virtual bool computeFeatures(const MatrixFloat &inputMatrix){ return false; }
    
    virtual bool clear() override;
    
    bool getInitialized() const;
    
    bool getFeatureDataReady() const;
    
    const VectorFloat& getFeatureVector() const;

    const MatrixFloat& getFeatureMatrix() const;
    
    typedef std::map< std::string, FeatureExtraction*(*)() > StringFeatureExtractionMap;
    
    /*
     Creates a new feature extraction instance based on the input string (which should contain the name of a valid feature extraction such as FFT).
    
    @param id: the name of the feature extraction module
    @return a pointer to the new instance of the feature extraction
    */
    static FeatureExtraction* create( const std::string &id );
    
    FeatureExtraction* create() const;
    
    using MLBase::save;
    using MLBase::load;

    GRT_DEPRECATED_MSG( "createNewInstance is deprecated, use create() instead.", FeatureExtraction* createNewInstance() const );
    GRT_DEPRECATED_MSG( "createInstanceFromString(id) is deprecated, use create(id) instead.", static FeatureExtraction* createInstanceFromString( const std::string &id ) );
    GRT_DEPRECATED_MSG( "getFeatureExtractionType is deprecated, use getId() instead", std::string getFeatureExtractionType() const );
    
protected:
    bool init();
    
    bool saveFeatureExtractionSettingsToFile( std::fstream &file ) const;
    
    bool loadFeatureExtractionSettingsFromFile( std::fstream &file );

    std::string featureExtractionType;
    bool initialized;
    bool featureDataReady;
    VectorFloat featureVector;
    MatrixFloat featureMatrix;
    
    static StringFeatureExtractionMap *getMap() {
        if( !stringFeatureExtractionMap ){ stringFeatureExtractionMap = new StringFeatureExtractionMap; } 
        return stringFeatureExtractionMap; 
    }
    
private:
    static StringFeatureExtractionMap *stringFeatureExtractionMap;
    static UINT numFeatureExtractionInstances;
    
};
    
template< typename T >  FeatureExtraction *createNewFeatureExtractionModule() { return new T; } 

template< typename T > 
class RegisterFeatureExtractionModule : FeatureExtraction { 
public:
    RegisterFeatureExtractionModule( const std::string &newModuleId ) { 
        getMap()->insert( std::pair< std::string, FeatureExtraction*(*)()>(newModuleId, &createNewFeatureExtractionModule< T > ) );
    }
};

GRT_END_NAMESPACE

#endif //GRT_FEATURE_EXTRACTION_HEADER