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

#include <GRTBase.h>

Inheritance diagram for GRTBase:
ClassificationData EvolutionaryAlgorithm< INDIVIDUAL > FastFourierTransform GestureRecognitionPipeline MLBase Node Tree BernoulliRBM Classifier Clusterer Context ContinuousHiddenMarkovModel DiscreteHiddenMarkovModel FeatureExtraction GridSearch< T > LinearLeastSquares MeanShift MovementDetector PostProcessing PreProcessing PrincipalComponentAnalysis Regressifier ClusterTreeNode DecisionTreeNode RegisterNode< T > RegisterNode< ClusterTreeNode > RegisterNode< DecisionTreeClusterNode > RegisterNode< DecisionTreeNode > RegisterNode< DecisionTreeThresholdNode > RegisterNode< DecisionTreeTripleFeatureNode > RegisterNode< RegressionTreeNode > RegressionTreeNode ClusterTree DecisionTree RegressionTree

Public Member Functions

 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
 

Static Public Member Functions

static std::string getGRTVersion (bool returnRevision=true)
 
static std::string getGRTRevison ()
 

Protected Member Functions

Float SQR (const Float &x) const
 

Protected Attributes

std::string classType
 
DebugLog debugLog
 
ErrorLog errorLog
 
InfoLog infoLog
 
TrainingLog trainingLog
 
TestingLog testingLog
 
WarningLog warningLog
 

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 52 of file GRTBase.h.

Constructor & Destructor Documentation

GRT_BEGIN_NAMESPACE GRTBase::GRTBase ( void  )

Default GRTBase Constructor

Definition at line 25 of file GRTBase.cpp.

GRTBase::~GRTBase ( void  )
virtual

Default GRTBase Destructor

Definition at line 29 of file GRTBase.cpp.

Member Function Documentation

bool GRTBase::copyGRTBaseVariables ( const GRTBase *  GRTBase)

This copies the GRTBase variables from the GRTBase pointer to the instance that calls the function.

Parameters
constGRTBase *GRTBase: a pointer to a GRTBase from which the values will be copied to the instance that calls the function
Returns
returns true if the copy was successfull, false otherwise

Definition at line 32 of file GRTBase.cpp.

std::string GRTBase::getClassType ( ) const

This function returns the name of the current class as a std::string. For example, if you asked AdaBoost for the class type then this function would return "AdaBoost".

return returns a std::string representing the class type

Definition at line 72 of file GRTBase.cpp.

GRTBase * GRTBase::getGRTBasePointer ( )

This functions returns a pointer to the current instance.

Returns
returns a GRTBase pointer to the current instance.

Definition at line 76 of file GRTBase.cpp.

const GRTBase * GRTBase::getGRTBasePointer ( ) const

This functions returns a const pointer to the current instance.

Returns
returns a const GRTBase pointer to the current instance.

Definition at line 80 of file GRTBase.cpp.

std::string GRTBase::getGRTRevison ( )
static

This functions returns the current GRT revision as a std::string.

Returns
returns the current GRT revision as a std::string.

Definition at line 68 of file GRTBase.cpp.

std::string GRTBase::getGRTVersion ( bool  returnRevision = true)
static

This functions the GRT version number and revision as a std::string. If you do not want the revision number then set the returnRevision parameter to false.

Parameters
returnRevisionsets if the revision number should be added to the std::string that is returned. Default value is true.
Returns
returns the GRT version number and revision as a std::string.

Definition at line 62 of file GRTBase.cpp.

std::string GRTBase::getLastErrorMessage ( ) const

This function returns the last error message as a std::string. If no errors have occured, the std::string will be empty.

Returns
returns the last error message as a std::string.

Definition at line 54 of file GRTBase.cpp.

std::string GRTBase::getLastInfoMessage ( ) const

This function returns the last info message as a std::string. If no info have occured, the std::string will be empty.

Returns
returns the last info message as a std::string.

Definition at line 58 of file GRTBase.cpp.

std::string GRTBase::getLastWarningMessage ( ) const

This function returns the last warning message as a std::string. If no warnings have occured, the std::string will be empty.

Returns
returns the last warning message as a std::string.

Definition at line 50 of file GRTBase.cpp.

bool GRTBase::setErrorLoggingEnabled ( const bool  loggingEnabled)

Sets if error logging is enabled/disabled for this specific instance. If you want to enable/disable error logging globally, then you should use the ErrorLog::enableLogging( bool ) function.

Returns
returns true if the parameter was updated, false otherwise

Definition at line 94 of file GRTBase.cpp.

bool GRTBase::setInfoLoggingEnabled ( const bool  loggingEnabled)

Sets if info logging is enabled/disabled for this specific instance. If you want to enable/disable info logging globally, then you should use the InfoLog::enableLogging( bool ) function.

Returns
returns true if the parameter was updated, false otherwise

Definition at line 84 of file GRTBase.cpp.

bool GRTBase::setWarningLoggingEnabled ( const bool  loggingEnabled)

Sets if warning logging is enabled/disabled for this specific instance. If you want to enable/disable warning logging globally, then you should use the WarningLog::enableLogging( bool ) function.

Returns
returns true if the parameter was updated, false otherwise

Definition at line 89 of file GRTBase.cpp.

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