TimeSeriesClassificationData.h

Go to the documentation of this file.

#ifndef GRT_TIME_SERIES_CLASSIFICATION_DATA_HEADER
#define GRT_TIME_SERIES_CLASSIFICATION_DATA_HEADER

#include "VectorFloat.h"
#include "MatrixFloat.h"
#include "../Util/GRTCommon.h"
#include "TimeSeriesClassificationSample.h"
#include "UnlabelledData.h"

GRT_BEGIN_NAMESPACE

class GRT_API TimeSeriesClassificationData{
public:
 
 TimeSeriesClassificationData(UINT numDimensions = 0,std::string datasetName = "NOT_SET",std::string infoText = "");
 
 TimeSeriesClassificationData(const TimeSeriesClassificationData &rhs);
 
 virtual ~TimeSeriesClassificationData();

 TimeSeriesClassificationData& operator= (const TimeSeriesClassificationData &rhs);

 inline TimeSeriesClassificationSample& operator[] (const UINT &i){
 return data[i];
 }
 
 inline const TimeSeriesClassificationSample& operator[] (const UINT &i) const{
 return data[i];
 }

 void clear();
 
 bool setNumDimensions(const UINT numDimensions);
 
 bool setDatasetName(const std::string datasetName);
 
 bool setInfoText(const std::string infoText);
 
 bool setClassNameForCorrespondingClassLabel(const std::string className,const UINT classLabel);
 
 bool setAllowNullGestureClass(const bool allowNullGestureClass);
 
 bool addSample(const UINT classLabel,const MatrixFloat &trainingSample);
 
 bool removeLastSample();
 
 UINT eraseAllSamplesWithClassLabel(const UINT classLabel);
 
 bool relabelAllSamplesWithClassLabel(const UINT oldClassLabel,const UINT newClassLabel);
 
 bool setExternalRanges(const Vector< MinMax > &externalRanges,const bool useExternalRanges = false);
 
 bool enableExternalRangeScaling(const bool useExternalRanges);
 
 bool scale(const Float minTarget,const Float maxTarget);
 
 bool scale(const Vector<MinMax> &ranges,const Float minTarget,const Float maxTarget);
 
 bool save(const std::string &filename) const;
 
 bool load(const std::string &filename);
 
 bool saveDatasetToFile(const std::string filename) const;
 
 bool loadDatasetFromFile(const std::string filename);
 
 bool saveDatasetToCSVFile(const std::string &filename) const;
 
 bool loadDatasetFromCSVFile(const std::string &filename);
 
 bool printStats() const;
 
 std::string getStatsAsString() const;
 
 GRT_DEPRECATED_MSG( "partition(...) is deprecated, use split(...) instead", TimeSeriesClassificationData partition(const UINT partitionPercentage,const bool useStratifiedSampling = false) );

 TimeSeriesClassificationData split(const UINT partitionPercentage,const bool useStratifiedSampling = false);
 
 bool merge(const TimeSeriesClassificationData &labelledData);
 
 bool spiltDataIntoKFolds(const UINT K, const bool useStratifiedSampling = false);
 
 TimeSeriesClassificationData getTrainingFoldData(const UINT foldIndex) const;
 
 TimeSeriesClassificationData getTestFoldData(const UINT foldIndex) const;
 
 TimeSeriesClassificationData getClassData(const UINT classLabel) const;
 
 UnlabelledData reformatAsUnlabelledData() const;
 
 std::string getDatasetName() const { return datasetName; }
 
 std::string getInfoText() const { return infoText; }
 
 UINT inline getNumDimensions() const { return numDimensions; }
 
 UINT inline getNumSamples() const { return totalNumSamples; }
 
 UINT inline getNumClasses() const { return classTracker.getSize(); }
 
 UINT getMinimumClassLabel() const;
 
 UINT getMaximumClassLabel() const;
 
 UINT getClassLabelIndexValue(const UINT classLabel) const;
 
 std::string getClassNameForCorrespondingClassLabel(const UINT classLabel) const;
 
 Vector<MinMax> getRanges() const;
 
 Vector< ClassTracker > getClassTracker() const { return classTracker; }
 
 Vector< TimeSeriesClassificationSample > getClassificationData() const { return data; }
 
 MatrixFloat getDataAsMatrixFloat() const;
 
protected:
 
 std::string datasetName; 
 std::string infoText; 
 UINT numDimensions; 
 UINT totalNumSamples; 
 UINT kFoldValue; 
 bool crossValidationSetup; 
 bool useExternalRanges; 
 bool allowNullGestureClass; 
 Vector< MinMax > externalRanges; 
 Vector< ClassTracker > classTracker; 
 Vector< TimeSeriesClassificationSample > data; 
 Vector< Vector< UINT > > crossValidationIndexs; 
 
 DebugLog debugLog; 
 ErrorLog errorLog; 
 WarningLog warningLog; 
 
};

GRT_END_NAMESPACE

#endif //GRT_LABELLED_TIME_SERIES_CLASSIFICATION_DATA_HEADER