GestureRecognitionToolkit  Version: 1.0 Revision: 04-03-15
The Gesture Recognition Toolkit (GRT) is a cross-platform, open-source, c++ machine learning library for real-time gesture recognition.
GRT::ClassLabelFilter Class Reference
Inheritance diagram for GRT::ClassLabelFilter:
GRT::PostProcessing GRT::MLBase GRT::GRTBase GRT::Observer< TrainingResult > GRT::Observer< TestInstanceResult >

Public Member Functions

 ClassLabelFilter (UINT minimumCount=1, UINT bufferSize=1)
 
 ClassLabelFilter (const ClassLabelFilter &rhs)
 
virtual ~ClassLabelFilter ()
 
ClassLabelFilteroperator= (const ClassLabelFilter &rhs)
 
virtual bool deepCopyFrom (const PostProcessing *postProcessing)
 
virtual bool process (const VectorDouble &inputVector)
 
virtual bool reset ()
 
virtual bool saveModelToFile (string filename) const
 
virtual bool saveModelToFile (fstream &file) const
 
virtual bool loadModelFromFile (string filename)
 
virtual bool loadModelFromFile (fstream &file)
 
bool init (UINT minimumCount, UINT bufferSize)
 
UINT filter (UINT predictedClassLabel)
 
UINT getFilteredClassLabel ()
 
bool setMinimumCount (UINT minimumCount)
 
bool setBufferSize (UINT bufferSize)
 
- Public Member Functions inherited from GRT::PostProcessing
 PostProcessing (void)
 
virtual ~PostProcessing (void)
 
bool copyBaseVariables (const PostProcessing *postProcessingModule)
 
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
 
VectorDouble getProcessedData () const
 
PostProcessingcreateNewInstance () const
 
- Public Member Functions inherited from GRT::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 (TimeSeriesClassificationDataStream trainingData)
 
virtual bool train_ (TimeSeriesClassificationDataStream &trainingData)
 
virtual bool train (UnlabelledData trainingData)
 
virtual bool train_ (UnlabelledData &trainingData)
 
virtual bool train (MatrixDouble data)
 
virtual bool train_ (MatrixDouble &data)
 
virtual bool predict (VectorDouble inputVector)
 
virtual bool predict_ (VectorDouble &inputVector)
 
virtual bool predict (MatrixDouble inputMatrix)
 
virtual bool predict_ (MatrixDouble &inputMatrix)
 
virtual bool map (VectorDouble inputVector)
 
virtual bool map_ (VectorDouble &inputVector)
 
virtual bool clear ()
 
virtual bool print () const
 
virtual bool save (const string filename) const
 
virtual bool load (const string filename)
 
virtual bool getModel (ostream &stream) const
 
double scale (const double &x, const double &minSource, const double &maxSource, const double &minTarget, const double &maxTarget, const bool constrain=false)
 
virtual string getModelAsString () 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
 
double getMinChange () const
 
double getLearningRate () const
 
double getRootMeanSquaredTrainingError () const
 
double getTotalSquaredTrainingError () 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 (bool useScaling)
 
bool setMaxNumEpochs (const UINT maxNumEpochs)
 
bool setMinNumEpochs (const UINT minNumEpochs)
 
bool setMinChange (const double minChange)
 
bool setLearningRate (double learningRate)
 
bool setUseValidationSet (const bool useValidationSet)
 
bool setValidationSetSize (const UINT validationSetSize)
 
bool setRandomiseTrainingOrder (const bool randomiseTrainingOrder)
 
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)
 
MLBasegetMLBasePointer ()
 
const MLBasegetMLBasePointer () const
 
vector< TrainingResultgetTrainingResults () const
 
- Public Member Functions inherited from GRT::GRTBase
 GRTBase (void)
 
virtual ~GRTBase (void)
 
bool copyGRTBaseVariables (const GRTBase *GRTBase)
 
string getClassType () const
 
string getLastWarningMessage () const
 
string getLastErrorMessage () const
 
string getLastInfoMessage () const
 
GRTBasegetGRTBasePointer ()
 
const GRTBasegetGRTBasePointer () const
 
- Public Member Functions inherited from GRT::Observer< TrainingResult >
virtual void notify (const TrainingResult &data)
 
- Public Member Functions inherited from GRT::Observer< TestInstanceResult >
virtual void notify (const TestInstanceResult &data)
 

Protected Attributes

UINT filteredClassLabel
 The most recent filtered class label value.
 
UINT minimumCount
 The minimum count sets the minimum number of class label values that must be present in the class labels buffer for that class label value to be output by the Class Label Filter.
 
UINT bufferSize
 The size of the Class Label Filter buffer.
 
CircularBuffer< UINT > buffer
 The class label filter buffer.
 
- Protected Attributes inherited from GRT::PostProcessing
string postProcessingType
 
bool initialized
 
UINT postProcessingInputMode
 
UINT postProcessingOutputMode
 
VectorDouble processedData
 
- Protected Attributes inherited from GRT::MLBase
bool trained
 
bool useScaling
 
UINT baseType
 
UINT numInputDimensions
 
UINT numOutputDimensions
 
UINT numTrainingIterationsToConverge
 
UINT minNumEpochs
 
UINT maxNumEpochs
 
UINT validationSetSize
 
double learningRate
 
double minChange
 
double rootMeanSquaredTrainingError
 
double totalSquaredTrainingError
 
bool useValidationSet
 
bool randomiseTrainingOrder
 
Random random
 
vector< TrainingResulttrainingResults
 
TrainingResultsObserverManager trainingResultsObserverManager
 
TestResultsObserverManager testResultsObserverManager
 
- Protected Attributes inherited from GRT::GRTBase
string classType
 
DebugLog debugLog
 
ErrorLog errorLog
 
InfoLog infoLog
 
TrainingLog trainingLog
 
TestingLog testingLog
 
WarningLog warningLog
 

Static Protected Attributes

static RegisterPostProcessingModule< ClassLabelFilterregisterModule
 

Additional Inherited Members

- Public Types inherited from GRT::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< string, PostProcessing *(*)() > StringPostProcessingMap
 
- Public Types inherited from GRT::MLBase
enum  BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }
 
- Static Public Member Functions inherited from GRT::PostProcessing
static PostProcessingcreateInstanceFromString (string const &postProcessingType)
 
- Static Public Member Functions inherited from GRT::GRTBase
static string getGRTVersion (bool returnRevision=true)
 
static string getGRTRevison ()
 
- Protected Member Functions inherited from GRT::PostProcessing
bool init ()
 
bool savePostProcessingSettingsToFile (fstream &file) const
 
bool loadPostProcessingSettingsFromFile (fstream &file)
 
- Protected Member Functions inherited from GRT::MLBase
bool saveBaseSettingsToFile (fstream &file) const
 
bool loadBaseSettingsFromFile (fstream &file)
 
- Protected Member Functions inherited from GRT::GRTBase
double SQR (const double &x) const
 
- Static Protected Member Functions inherited from GRT::PostProcessing
static StringPostProcessingMapgetMap ()
 

Detailed Description

Definition at line 41 of file ClassLabelFilter.h.

Constructor & Destructor Documentation

GRT::ClassLabelFilter::ClassLabelFilter ( UINT  minimumCount = 1,
UINT  bufferSize = 1 
)

Default Constructor. Sets the minimumCount and bufferSize parameters. The minimum count sets the minimum number of class label values that must be present in the class labels buffer for that class label value to be output by the Class Label Filter. The size of the class labels buffer is set by the buffer size parameter. If there is more than one type of class label in the buffer then the class label with the maximum number of instances will be output. If the maximum number of instances for any class label in the buffer is less than the minimum count parameter then the Class Label Filter will output the default null rejection class label of 0.

Parameters
UINTminimumCount: sets the minimumCount value. Default value minimumCount=1
UINTbufferSize: sets the size of the class labels buffer. Default value bufferSize=1

Definition at line 28 of file ClassLabelFilter.cpp.

GRT::ClassLabelFilter::ClassLabelFilter ( const ClassLabelFilter rhs)

Copy Constructor.

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

Parameters
constClassLabelFilter &rhs: the rhs from which the values will be copied to this this instance of the ClassLabelFilter.

Definition at line 39 of file ClassLabelFilter.cpp.

GRT::ClassLabelFilter::~ClassLabelFilter ( )
virtual

Default Destructor

Definition at line 59 of file ClassLabelFilter.cpp.

Member Function Documentation

bool GRT::ClassLabelFilter::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
constPostProcessing *postProcessing: a pointer to another instance of a ClassLabelFilter, the values of that instance will be cloned to this instance
Returns
true if the deep copy was successful, false otherwise

Reimplemented from GRT::PostProcessing.

Definition at line 79 of file ClassLabelFilter.cpp.

UINT GRT::ClassLabelFilter::filter ( UINT  predictedClassLabel)

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

Parameters
UINTpredictedClassLabel: the predictedClassLabel which should be filtered return returns the filtered class label

Definition at line 155 of file ClassLabelFilter.cpp.

UINT GRT::ClassLabelFilter::getFilteredClassLabel ( )
inline

Get the most recently filtered class label value.

Returns
returns the filtered class label

Definition at line 165 of file ClassLabelFilter.h.

bool GRT::ClassLabelFilter::init ( UINT  minimumCount,
UINT  bufferSize 
)

This function initializes the ClassLabelFilter.

Parameters
UINTminimumCount: sets the minimumCount value
UINTbufferSize: sets the size of the class labels buffer
Returns
returns true if the ClassLabelFilter was initialized, false otherwise

Definition at line 128 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::loadModelFromFile ( string  filename)
virtual

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

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

Reimplemented from GRT::PostProcessing.

Definition at line 244 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::loadModelFromFile ( fstream &  file)
virtual

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

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

Reimplemented from GRT::PostProcessing.

Definition at line 260 of file ClassLabelFilter.cpp.

ClassLabelFilter & GRT::ClassLabelFilter::operator= ( const ClassLabelFilter rhs)

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

Parameters
constClassLabelFilter &rhs: the rhs instance from which the values will be copied to this this instance of the ClassLabelFilter
Returns
returns a reference to this instance of the ClassLabelFilter

Definition at line 63 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::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 ClassLabelFilter's filter(...) function.

Parameters
constVectorDouble &inputVector: the 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 GRT::PostProcessing.

Definition at line 100 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::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 ClassLabelFilter by re-initiliazing the instance.

Returns
true if the ClassLabelFilter was reset, false otherwise

Reimplemented from GRT::PostProcessing.

Definition at line 117 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::saveModelToFile ( string  filename) const
virtual

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

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

Reimplemented from GRT::PostProcessing.

Definition at line 208 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::saveModelToFile ( fstream &  file) const
virtual

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

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

Reimplemented from GRT::PostProcessing.

Definition at line 228 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::setBufferSize ( UINT  bufferSize)

Sets the bufferSize parameter.

The bufferSize parameter controls the size of the class labels buffer. If the Class Label Filter has been initialized then the module will be reset.

Parameters
UINTbufferSize: the new bufferSize parameter
Returns
returns true if the bufferSize parameter was updated, false otherwise

Definition at line 319 of file ClassLabelFilter.cpp.

bool GRT::ClassLabelFilter::setMinimumCount ( UINT  minimumCount)

Sets the minimumCount parameter.

The minimumCount parameter controls how many class labels need to be present in the class labels buffer for that class label to be output by the filter. If the Class Label Filter has been initialized then the module will be reset.

Parameters
UINTminimumCount: the new minimumCount parameter
Returns
returns true if the minimumCount parameter was updated, false otherwise

Definition at line 311 of file ClassLabelFilter.cpp.


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