GestureRecognitionToolkit  Version: 0.2.0
The Gesture Recognition Toolkit (GRT) is a cross-platform, open-source, c++ machine learning library for real-time gesture recognition.
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ClassLabelChangeFilter Class Reference

#include <ClassLabelChangeFilter.h>

Inheritance diagram for ClassLabelChangeFilter:
PostProcessing MLBase GRTBase Observer< TrainingResult > Observer< TestInstanceResult >

Public Member Functions

 ClassLabelChangeFilter ()
 
 ClassLabelChangeFilter (const ClassLabelChangeFilter &rhs)
 
virtual ~ClassLabelChangeFilter ()
 
ClassLabelChangeFilter & operator= (const ClassLabelChangeFilter &rhs)
 
virtual bool deepCopyFrom (const PostProcessing *postProcessing)
 
virtual bool process (const VectorDouble &inputVector)
 
virtual bool reset ()
 
virtual bool saveModelToFile (std::string filename) const
 
virtual bool saveModelToFile (std::fstream &file) const
 
virtual bool loadModelFromFile (std::string filename)
 
virtual bool loadModelFromFile (std::fstream &file)
 
bool init ()
 
UINT filter (UINT predictedClassLabel)
 
UINT getFilteredClassLabel ()
 
bool getChange ()
 
- Public Member Functions inherited from PostProcessing
 PostProcessing (void)
 
virtual ~PostProcessing (void)
 
bool copyBaseVariables (const PostProcessing *postProcessingModule)
 
std::string getPostProcessingType () const
 
UINT getPostProcessingInputMode () const
 
UINT getPostProcessingOutputMode () const
 
UINT getNumInputDimensions () const
 
UINT getNumOutputDimensions () const
 
bool getInitialized () const
 
bool getIsPostProcessingInputModePredictedClassLabel () const
 
bool getIsPostProcessingInputModeClassLikelihoods () const
 
bool getIsPostProcessingOutputModePredictedClassLabel () const
 
bool getIsPostProcessingOutputModeClassLikelihoods () const
 
VectorFloat getProcessedData () const
 
PostProcessing * createNewInstance () const
 
- Public Member Functions inherited from MLBase
 MLBase (void)
 
virtual ~MLBase (void)
 
bool copyMLBaseVariables (const MLBase *mlBase)
 
virtual bool train (ClassificationData trainingData)
 
virtual bool train_ (ClassificationData &trainingData)
 
virtual bool train (RegressionData trainingData)
 
virtual bool train_ (RegressionData &trainingData)
 
virtual bool train (TimeSeriesClassificationData trainingData)
 
virtual bool train_ (TimeSeriesClassificationData &trainingData)
 
virtual bool train (ClassificationDataStream trainingData)
 
virtual bool train_ (ClassificationDataStream &trainingData)
 
virtual bool train (UnlabelledData trainingData)
 
virtual bool train_ (UnlabelledData &trainingData)
 
virtual bool train (MatrixFloat data)
 
virtual bool train_ (MatrixFloat &data)
 
virtual bool predict (VectorFloat inputVector)
 
virtual bool predict_ (VectorFloat &inputVector)
 
virtual bool predict (MatrixFloat inputMatrix)
 
virtual bool predict_ (MatrixFloat &inputMatrix)
 
virtual bool map (VectorFloat inputVector)
 
virtual bool map_ (VectorFloat &inputVector)
 
virtual bool clear ()
 
virtual bool print () const
 
virtual bool save (const std::string filename) const
 
virtual bool load (const std::string filename)
 
virtual bool save (std::fstream &file) const
 
virtual bool load (std::fstream &file)
 
 GRT_DEPRECATED_MSG ("saveModelToFile(std::string filename) is deprecated, use save(std::string filename) instead", virtual bool saveModelToFile(std::string filename) const )
 
 GRT_DEPRECATED_MSG ("saveModelToFile(std::fstream &file) is deprecated, use save(std::fstream &file) instead", virtual bool saveModelToFile(std::fstream &file) const )
 
 GRT_DEPRECATED_MSG ("loadModelFromFile(std::string filename) is deprecated, use load(std::string filename) instead", virtual bool loadModelFromFile(std::string filename))
 
 GRT_DEPRECATED_MSG ("loadModelFromFile(std::fstream &file) is deprecated, use load(std::fstream &file) instead", virtual bool loadModelFromFile(std::fstream &file))
 
virtual bool getModel (std::ostream &stream) const
 
Float scale (const Float &x, const Float &minSource, const Float &maxSource, const Float &minTarget, const Float &maxTarget, const bool constrain=false)
 
virtual std::string getModelAsString () const
 
DataType getInputType () const
 
DataType getOutputType () const
 
UINT getBaseType () const
 
UINT getNumInputFeatures () const
 
UINT getNumInputDimensions () const
 
UINT getNumOutputDimensions () const
 
UINT getMinNumEpochs () const
 
UINT getMaxNumEpochs () const
 
UINT getValidationSetSize () const
 
UINT getNumTrainingIterationsToConverge () const
 
Float getMinChange () const
 
Float getLearningRate () const
 
Float getRootMeanSquaredTrainingError () const
 
Float getTotalSquaredTrainingError () const
 
Float getValidationSetAccuracy () const
 
VectorFloat getValidationSetPrecision () const
 
VectorFloat getValidationSetRecall () const
 
bool getUseValidationSet () const
 
bool getRandomiseTrainingOrder () const
 
bool getTrained () const
 
bool getModelTrained () const
 
bool getScalingEnabled () const
 
bool getIsBaseTypeClassifier () const
 
bool getIsBaseTypeRegressifier () const
 
bool getIsBaseTypeClusterer () const
 
bool enableScaling (const bool useScaling)
 
bool setMaxNumEpochs (const UINT maxNumEpochs)
 
bool setMinNumEpochs (const UINT minNumEpochs)
 
bool setMinChange (const Float minChange)
 
bool setLearningRate (const Float learningRate)
 
bool setUseValidationSet (const bool useValidationSet)
 
bool setValidationSetSize (const UINT validationSetSize)
 
bool setRandomiseTrainingOrder (const bool randomiseTrainingOrder)
 
bool setTrainingLoggingEnabled (const bool loggingEnabled)
 
bool registerTrainingResultsObserver (Observer< TrainingResult > &observer)
 
bool registerTestResultsObserver (Observer< TestInstanceResult > &observer)
 
bool removeTrainingResultsObserver (const Observer< TrainingResult > &observer)
 
bool removeTestResultsObserver (const Observer< TestInstanceResult > &observer)
 
bool removeAllTrainingObservers ()
 
bool removeAllTestObservers ()
 
bool notifyTrainingResultsObservers (const TrainingResult &data)
 
bool notifyTestResultsObservers (const TestInstanceResult &data)
 
MLBase * getMLBasePointer ()
 
const MLBase * getMLBasePointer () const
 
Vector< TrainingResult > getTrainingResults () const
 
- Public Member Functions inherited from GRTBase
 GRTBase (void)
 
virtual ~GRTBase (void)
 
bool copyGRTBaseVariables (const GRTBase *GRTBase)
 
std::string getClassType () const
 
std::string getLastWarningMessage () const
 
std::string getLastErrorMessage () const
 
std::string getLastInfoMessage () const
 
bool setInfoLoggingEnabled (const bool loggingEnabled)
 
bool setWarningLoggingEnabled (const bool loggingEnabled)
 
bool setErrorLoggingEnabled (const bool loggingEnabled)
 
GRTBase * getGRTBasePointer ()
 
const GRTBase * getGRTBasePointer () const
 
- Public Member Functions inherited from Observer< TrainingResult >
virtual void notify (const TrainingResult &data)
 
- Public Member Functions inherited from Observer< TestInstanceResult >
virtual void notify (const TestInstanceResult &data)
 

Protected Attributes

UINT filteredClassLabel
 
bool labelChanged
 
- Protected Attributes inherited from PostProcessing
std::string postProcessingType
 
bool initialized
 
UINT postProcessingInputMode
 
UINT postProcessingOutputMode
 
VectorFloat processedData
 
- Protected Attributes inherited from MLBase
bool trained
 
bool useScaling
 
DataType inputType
 
DataType outputType
 
UINT baseType
 
UINT numInputDimensions
 
UINT numOutputDimensions
 
UINT numTrainingIterationsToConverge
 
UINT minNumEpochs
 
UINT maxNumEpochs
 
UINT validationSetSize
 
Float learningRate
 
Float minChange
 
Float rootMeanSquaredTrainingError
 
Float totalSquaredTrainingError
 
Float validationSetAccuracy
 
bool useValidationSet
 
bool randomiseTrainingOrder
 
VectorFloat validationSetPrecision
 
VectorFloat validationSetRecall
 
Random random
 
std::vector< TrainingResult > trainingResults
 
TrainingResultsObserverManager trainingResultsObserverManager
 
TestResultsObserverManager testResultsObserverManager
 
- Protected Attributes inherited from GRTBase
std::string classType
 
DebugLog debugLog
 
ErrorLog errorLog
 
InfoLog infoLog
 
TrainingLog trainingLog
 
TestingLog testingLog
 
WarningLog warningLog
 

Static Protected Attributes

static RegisterPostProcessingModule< ClassLabelChangeFilter > registerModule
 

Additional Inherited Members

- Public Types inherited from PostProcessing
enum  PostprocessingInputModes { INPUT_MODE_NOT_SET =0, INPUT_MODE_PREDICTED_CLASS_LABEL, INPUT_MODE_CLASS_LIKELIHOODS }
 
enum  PostprocessingOutputModes { OUTPUT_MODE_NOT_SET =0, OUTPUT_MODE_PREDICTED_CLASS_LABEL, OUTPUT_MODE_CLASS_LIKELIHOODS }
 
typedef std::map< std::string, PostProcessing *(*)() > StringPostProcessingMap
 
- Public Types inherited from MLBase
enum  BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }
 
- Static Public Member Functions inherited from PostProcessing
static PostProcessing * createInstanceFromString (std::string const &postProcessingType)
 
- Static Public Member Functions inherited from GRTBase
static std::string getGRTVersion (bool returnRevision=true)
 
static std::string getGRTRevison ()
 
- Protected Member Functions inherited from PostProcessing
bool init ()
 
bool savePostProcessingSettingsToFile (std::fstream &file) const
 
bool loadPostProcessingSettingsFromFile (std::fstream &file)
 
- Protected Member Functions inherited from MLBase
bool saveBaseSettingsToFile (std::fstream &file) const
 
bool loadBaseSettingsFromFile (std::fstream &file)
 
- Protected Member Functions inherited from GRTBase
Float SQR (const Float &x) const
 
- Static Protected Member Functions inherited from PostProcessing
static StringPostProcessingMap * getMap ()
 

Detailed Description

GRT MIT License Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition at line 40 of file ClassLabelChangeFilter.h.

Constructor & Destructor Documentation

ClassLabelChangeFilter::ClassLabelChangeFilter ( )

Default Constructor.

Definition at line 29 of file ClassLabelChangeFilter.cpp.

ClassLabelChangeFilter::ClassLabelChangeFilter ( const ClassLabelChangeFilter &  rhs)

Copy Constructor.

Copies the values from the rhs ClassLabelChangeFilter to this instance of the ClassLabelChangeFilter.

Parameters
rhsthe rhs from which the values will be copied to this this instance of the ClassLabelChangeFilter

Definition at line 41 of file ClassLabelChangeFilter.cpp.

ClassLabelChangeFilter::~ClassLabelChangeFilter ( )
virtual

Default Destructor

Definition at line 59 of file ClassLabelChangeFilter.cpp.

Member Function Documentation

bool ClassLabelChangeFilter::deepCopyFrom ( const PostProcessing *  postProcessing)
virtual

Sets the PostProcessing deepCopyFrom function, overwriting the base PostProcessing function. This function is used to deep copy the values from the input pointer to this instance of the PostProcessing module. This function is called by the GestureRecognitionPipeline when the user adds a new PostProcessing module to the pipeline.

Parameters
postProcessinga pointer to another instance of a ClassLabelChangeFilter, the values of that instance will be cloned to this instance
Returns
true if the deep copy was successful, false otherwise

Reimplemented from PostProcessing.

Definition at line 76 of file ClassLabelChangeFilter.cpp.

UINT ClassLabelChangeFilter::filter ( UINT  predictedClassLabel)

This is the main filter function which filters the input predictedClassLabel.

Parameters
predictedClassLabelthe predictedClassLabel which should be filtered return returns the filtered class label

Definition at line 131 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::getChange ( )

Get if the class label just changed.

Returns
returns true if the class label just changed, false otherwise

Definition at line 229 of file ClassLabelChangeFilter.cpp.

UINT ClassLabelChangeFilter::getFilteredClassLabel ( )
inline

Get the most recently filtered class label value.

Returns
returns the filtered class label

Definition at line 154 of file ClassLabelChangeFilter.h.

bool ClassLabelChangeFilter::init ( )

This function initializes the ClassLabelChangeFilter.

Returns
returns true if the ClassLabelChangeFilter was initialized, false otherwise

Definition at line 120 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::loadModelFromFile ( std::string  filename)
virtual

This loads the post processing settings from a file. This overrides the loadSettingsFromFile function in the PostProcessing base class.

Parameters
filenamethe name of the file to load the settings from
Returns
returns true if the settings were loaded successfully, false otherwise

Reimplemented from PostProcessing.

Definition at line 178 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::loadModelFromFile ( std::fstream &  file)
virtual

This loads the post processing settings from a file. This overrides the loadSettingsFromFile function in the PostProcessing base class.

Parameters
filenamethe name of the file to load the settings from
Returns
returns true if the settings were loaded successfully, false otherwise

Reimplemented from PostProcessing.

Definition at line 193 of file ClassLabelChangeFilter.cpp.

ClassLabelChangeFilter & ClassLabelChangeFilter::operator= ( const ClassLabelChangeFilter &  rhs)

Assigns the equals operator setting how the values from the rhs instance will be copied to this instance.

Parameters
rhsthe rhs instance from which the values will be copied to this this instance of the ClassLabelChangeFilter
Returns
returns a reference to this instance of the ClassLabelChangeFilter

Definition at line 63 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::process ( const VectorDouble &  inputVector)
virtual

Sets the PostProcessing process function, overwriting the base PostProcessing function. This function is called by the GestureRecognitionPipeline when any new input data needs to be processed (during the prediction phase for example). This function calls the ClassLabelChangeFilter's filter(...) function.

Parameters
inputVectorthe inputVector that should be processed. This should be a 1-dimensional vector containing a predicted class label
Returns
true if the data was processed, false otherwise

Reimplemented from PostProcessing.

Definition at line 95 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::reset ( )
virtual

Sets the PostProcessing reset function, overwriting the base PostProcessing function. This function is called by the GestureRecognitionPipeline when the pipelines main reset() function is called. This function resets the ClassLabelChangeFilter by re-initiliazing the instance.

Returns
true if the ClassLabelChangeFilter was reset, false otherwise

Reimplemented from PostProcessing.

Definition at line 112 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::saveModelToFile ( std::string  filename) const
virtual

This saves the post processing settings to a file. This overrides the saveSettingsToFile function in the PostProcessing base class.

Parameters
filenamethe name of the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from PostProcessing.

Definition at line 144 of file ClassLabelChangeFilter.cpp.

bool ClassLabelChangeFilter::saveModelToFile ( std::fstream &  file) const
virtual

This saves the post processing settings to a file. This overrides the saveSettingsToFile function in the PostProcessing base class.

Parameters
filenamethe name of the file to save the settings to
Returns
returns true if the settings were saved successfully, false otherwise

Reimplemented from PostProcessing.

Definition at line 164 of file ClassLabelChangeFilter.cpp.

The documentation for this class was generated from the following files: