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();
 
 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 reset(){ return true; }
 
 virtual bool clear();
 
 virtual bool saveModelToFile( std::fstream &file ) const{ return false; }
 
 virtual bool loadModelFromFile( std::fstream &file ){ return false; }
 
 std::string getFeatureExtractionType() const;
 
 UINT getNumInputDimensions() const;
 
 UINT getNumOutputDimensions() const;
 
 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 featureExtractionType: the name of the feature extraction module
 @return FeatureExtraction*: a pointer to the new instance of the feature extraction
 */
 static FeatureExtraction* createInstanceFromString( const std::string &featureExtractionType );
 
 FeatureExtraction* createNewInstance() const;
 
 using MLBase::saveModelToFile;
 using MLBase::loadModelFromFile;
 
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;
 
};
 
//These two functions/classes are used to register any new FeatureExtraction Module with the FeatureExtraction base class
template< typename T > FeatureExtraction *newFeatureExtractionModuleInstance() { return new T; }

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

GRT_END_NAMESPACE

#endif //GRT_FEATURE_EXTRACTION_HEADER