![]() |
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.
|
Public Member Functions | |
MedianFilter (UINT filterSize=5, UINT numDimensions=1) | |
MedianFilter (const MedianFilter &rhs) | |
virtual | ~MedianFilter () |
MedianFilter & | operator= (const MedianFilter &rhs) |
virtual bool | deepCopyFrom (const PreProcessing *preProcessing) |
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 filterSize, UINT numDimensions) |
double | filter (const double x) |
VectorDouble | filter (const VectorDouble &x) |
UINT | getFilterSize () const |
VectorDouble | getFilteredData () const |
vector< VectorDouble > | getDataBuffer () const |
![]() | |
PreProcessing (void) | |
virtual | ~PreProcessing (void) |
bool | copyBaseVariables (const PreProcessing *preProcessingModule) |
virtual bool | clear () |
string | getPreProcessingType () const |
UINT | getNumInputDimensions () const |
UINT | getNumOutputDimensions () const |
bool | getInitialized () const |
VectorDouble | getProcessedData () const |
PreProcessing * | createNewInstance () const |
![]() | |
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 | 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) |
MLBase * | getMLBasePointer () |
const MLBase * | getMLBasePointer () const |
vector< TrainingResult > | getTrainingResults () const |
![]() | |
GRTBase (void) | |
virtual | ~GRTBase (void) |
bool | copyGRTBaseVariables (const GRTBase *GRTBase) |
string | getClassType () const |
string | getLastWarningMessage () const |
string | getLastErrorMessage () const |
string | getLastInfoMessage () const |
GRTBase * | getGRTBasePointer () |
const GRTBase * | getGRTBasePointer () const |
![]() | |
virtual void | notify (const TrainingResult &data) |
![]() | |
virtual void | notify (const TestInstanceResult &data) |
Protected Attributes | |
UINT | filterSize |
The size of the filter. | |
UINT | inputSampleCounter |
A counter to keep track of the number of input samples. | |
CircularBuffer< VectorDouble > | dataBuffer |
A buffer to store the previous N values, N = filterSize. | |
![]() | |
string | preProcessingType |
bool | initialized |
VectorDouble | processedData |
![]() | |
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< TrainingResult > | trainingResults |
TrainingResultsObserverManager | trainingResultsObserverManager |
TestResultsObserverManager | testResultsObserverManager |
![]() | |
string | classType |
DebugLog | debugLog |
ErrorLog | errorLog |
InfoLog | infoLog |
TrainingLog | trainingLog |
TestingLog | testingLog |
WarningLog | warningLog |
Static Protected Attributes | |
static RegisterPreProcessingModule< MedianFilter > | registerModule |
Additional Inherited Members | |
![]() | |
typedef std::map< string, PreProcessing *(*)() > | StringPreProcessingMap |
![]() | |
enum | BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER } |
![]() | |
static PreProcessing * | createInstanceFromString (string const &preProcessingType) |
![]() | |
static string | getGRTVersion (bool returnRevision=true) |
static string | getGRTRevison () |
![]() | |
bool | init () |
bool | savePreProcessingSettingsToFile (fstream &file) const |
bool | loadPreProcessingSettingsFromFile (fstream &file) |
![]() | |
bool | saveBaseSettingsToFile (fstream &file) const |
bool | loadBaseSettingsFromFile (fstream &file) |
![]() | |
double | SQR (const double &x) const |
![]() | |
static StringPreProcessingMap * | getMap () |
Definition at line 38 of file MedianFilter.h.
GRT::MedianFilter::MedianFilter | ( | UINT | filterSize = 5 , |
UINT | numDimensions = 1 |
||
) |
Constructor, sets the size of the median filter and the dimensionality of the data it will filter.
UINT | filterSize: the size of the median filter, should be a value greater than zero. Default filterSize = 5 |
UINT | numDimensions: the dimensionality of the data to filter. Default numDimensions = 1 |
Definition at line 28 of file MedianFilter.cpp.
GRT::MedianFilter::MedianFilter | ( | const MedianFilter & | rhs | ) |
Copy Constructor, copies the MedianFilter from the rhs instance to this instance
const | MedianFilter &rhs: another instance of the MedianFilter class from which the data will be copied to this instance |
Definition at line 38 of file MedianFilter.cpp.
|
virtual |
Default Destructor
Definition at line 54 of file MedianFilter.cpp.
|
virtual |
Sets the PreProcessing deepCopyFrom function, overwriting the base PreProcessing function. This function is used to deep copy the values from the input pointer to this instance of the PreProcessing module. This function is called by the GestureRecognitionPipeline when the user adds a new PreProcessing module to the pipeline.
const | PreProcessing *preProcessing: a pointer to another instance of a MedianFilter, the values of that instance will be cloned to this instance |
Reimplemented from GRT::PreProcessing.
Definition at line 77 of file MedianFilter.cpp.
double GRT::MedianFilter::filter | ( | const double | x | ) |
Filters the input, this should only be called if the dimensionality of the filter was set to 1.
double | x: the value to filter, this should only be called if the dimensionality of the filter was set to 1 |
Definition at line 247 of file MedianFilter.cpp.
VectorDouble GRT::MedianFilter::filter | ( | const VectorDouble & | x | ) |
Filters the input, the dimensionality of the input vector should match that of the filter.
const | VectorDouble &x: the values to filter, the dimensionality of the input vector should match that of the filter |
Definition at line 255 of file MedianFilter.cpp.
vector< VectorDouble > GRT::MedianFilter::getDataBuffer | ( | ) | const |
Returns the current data in the dataBuffer. This will be a [N M] vector of VectorDoubles, where N is the number of dimensions in the filter and M is the size of the buffer. If the filter has not been initialized then an empty vector will be returned.
Definition at line 289 of file MedianFilter.cpp.
|
inline |
Returns the last value(s) that were filtered.
Definition at line 170 of file MedianFilter.h.
|
inline |
Gets the current filter size.
Definition at line 163 of file MedianFilter.h.
bool GRT::MedianFilter::init | ( | UINT | filterSize, |
UINT | numDimensions | ||
) |
Initializes the filter, setting the filter size and dimensionality of the data it will filter. Sets all the filter values to zero.
UINT | filterSize: the size of the moving average filter, should be a value greater than zero |
Definition at line 216 of file MedianFilter.cpp.
|
virtual |
This loads the MedianFilter settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.
string | filename: the name of the file to load the settings from |
Reimplemented from GRT::PreProcessing.
Definition at line 155 of file MedianFilter.cpp.
|
virtual |
This loads the MedianFilter settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.
fstream | &file: a reference to the file to load the settings from |
Reimplemented from GRT::PreProcessing.
Definition at line 171 of file MedianFilter.cpp.
MedianFilter & GRT::MedianFilter::operator= | ( | const MedianFilter & | rhs | ) |
Sets the equals operator, copies the data from the rhs instance to this instance
const | MedianFilter &rhs: another instance of the MedianFilter class from which the data will be copied to this instance |
Definition at line 58 of file MedianFilter.cpp.
|
virtual |
Sets the PreProcessing process function, overwriting the base PreProcessing 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 MedianFilter's filter function.
const | VectorDouble &inputVector: the inputVector that should be processed. Must have the same dimensionality as the PreProcessing module |
Reimplemented from GRT::PreProcessing.
Definition at line 95 of file MedianFilter.cpp.
|
virtual |
Sets the PreProcessing reset function, overwriting the base PreProcessing function. This function is called by the GestureRecognitionPipeline when the pipelines main reset() function is called. This function resets the filter values by re-initiliazing the filter.
Reimplemented from GRT::PreProcessing.
Definition at line 114 of file MedianFilter.cpp.
|
virtual |
This saves the current settings of the MedianFilter to a file. This overrides the saveModelToFile function in the PreProcessing base class.
string | filename: the name of the file to save the settings to |
Reimplemented from GRT::PreProcessing.
Definition at line 119 of file MedianFilter.cpp.
|
virtual |
This saves the current settings of the MedianFilter to a file. This overrides the saveModelToFile function in the PreProcessing base class.
fstream | &file: a reference to the file the settings will be saved to |
Reimplemented from GRT::PreProcessing.
Definition at line 139 of file MedianFilter.cpp.