#include <DeadZone.h>

Inheritance diagram for DeadZone:

Public Member Functions
	DeadZone (Float lowerLimit=-0.1, Float upperLimit=0.1, UINT numDimensions=1)

	DeadZone (const DeadZone &rhs)

virtual	~DeadZone ()

DeadZone &	operator= (const DeadZone &rhs)

virtual bool	deepCopyFrom (const PreProcessing *preProcessing)

virtual bool	process (const VectorFloat &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 (Float lowerLimit, Float upperLimit, UINT numDimensions)

Float	filter (const Float x)

VectorFloat	filter (const VectorFloat &x)

bool	setLowerLimit (Float lowerLimit)

bool	setUpperLimit (Float upperLimit)

Float	getLowerLimit ()

Float	getUpperLimit ()

Public Member Functions inherited from PreProcessing
	PreProcessing (void)

virtual	~PreProcessing (void)

bool	copyBaseVariables (const PreProcessing *preProcessingModule)

virtual bool	clear ()

std::string	getPreProcessingType () const

UINT	getNumInputDimensions () const

UINT	getNumOutputDimensions () const

bool	getInitialized () const

VectorFloat	getProcessedData () const

PreProcessing *	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	print () const

virtual bool	save (const std::string filename) const

virtual bool	load (const std::string filename)

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
Float	lowerLimit
	The lower limit of the dead-zone region.

Float	upperLimit
	The upper limit of the dead-zone region.

Protected Attributes inherited from PreProcessing
std::string	preProcessingType

bool	initialized

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 RegisterPreProcessingModule< DeadZone >	registerModule

Additional Inherited Members
Public Types inherited from PreProcessing
typedef std::map< std::string, PreProcessing ()() >	StringPreProcessingMap

Public Types inherited from MLBase
enum	BaseTypes { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER }

Static Public Member Functions inherited from PreProcessing
static PreProcessing *	createInstanceFromString (std::string const &preProcessingType)

Static Public Member Functions inherited from GRTBase
static std::string	getGRTVersion (bool returnRevision=true)

static std::string	getGRTRevison ()

Protected Member Functions inherited from PreProcessing
bool	init ()

bool	savePreProcessingSettingsToFile (std::fstream &file) const

bool	loadPreProcessingSettingsFromFile (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 PreProcessing
static StringPreProcessingMap *	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 39 of file DeadZone.h.

Constructor & Destructor Documentation

DeadZone::DeadZone	(	Float	lowerLimit = `-0.1`,
		Float	upperLimit = `0.1`,
		UINT	numDimensions = `1`
	)

Constructor, sets the lower and upper limits of the dead-zone region and the dimensionality of the input data.

Parameters

lowerLimit	sets the lower limit of the dead-zone region. Default lowerLimit = -0.1
upperLimit	sets the upper limit of the dead-zone region. Default upperLimit = 0.1
numDimensions	the dimensionality of the input data. Default numDimensions = 1

Definition at line 28 of file DeadZone.cpp.

DeadZone::DeadZone ( const DeadZone & rhs )

Copy Constructor, copies the DeadZone from the rhs instance to this instance

Parameters

rhs	another instance of the DeadZone class from which the data will be copied to this instance

Definition at line 37 of file DeadZone.cpp.

DeadZone::~DeadZone ( )

virtual

Default Destructor

Definition at line 48 of file DeadZone.cpp.

Member Function Documentation

bool DeadZone::deepCopyFrom ( const PreProcessing * preProcessing )

virtual

Sets the PreProcessing deepCopyFrom function, overwriting the base PreProcessing function. This function is used to clone 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.

Parameters

preProcessing a pointer to another instance of a DeadZone, the values of that instance will be cloned to this instance

Returns: true if the deep copy was successful, false otherwise

Reimplemented from PreProcessing.

Definition at line 61 of file DeadZone.cpp.

Float DeadZone::filter ( const Float x )

Filters the value x using the dead-zone values, this should only be called if the dimensionality of the instance was set to 1.

Parameters

const Float x: the value to be filtered, this should only be called if the dimensionality of the filter was set to 1

Returns: the filtered input value. Zero will be returned if the value was not computed

Definition at line 233 of file DeadZone.cpp.

VectorFloat DeadZone::filter ( const VectorFloat & x )

Filters x using the dead-zone values, the dimensionality of the input should match the number of inputs for the dead zone

Parameters

const VectorFloat &x: the values to be filtered, the dimensionality of the input should match the number of inputs for the derivative

Returns: the filtered input values. An empty vector will be returned if the values were not filtered

Definition at line 239 of file DeadZone.cpp.

Float DeadZone::getLowerLimit ( )

inline

Gets the lower limit of the dead-zone region.

Returns: returns the lower limit if the DeadZone has been initialized, zero otherwise

Definition at line 182 of file DeadZone.h.

Float DeadZone::getUpperLimit ( )

inline

Gets the upper limit of the dead-zone region.

Returns: returns the upper limit if the DeadZone has been initialized, zero otherwise

Definition at line 189 of file DeadZone.h.

bool DeadZone::init	(	Float	lowerLimit,
		Float	upperLimit,
		UINT	numDimensions
	)

Initializes the instance, sets the lower and upper limits of the dead-zone region and the dimensionality of the input data.

Parameters

Float	lowerLimit: sets the lower limit of the dead-zone region
UINT	upperLimit: sets the upper limit of the dead-zone region
UINT	numDimensions: the dimensionality of the input data

Returns: true if the instance was initiliazed, false otherwise

Definition at line 208 of file DeadZone.cpp.

bool DeadZone::loadModelFromFile ( std::string filename )

virtual

This loads the DeadZone settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.

Parameters

string filename: the name of the file to load the settings from

Returns: returns true if the settings were loaded successfully, false otherwise

Reimplemented from PreProcessing.

Definition at line 140 of file DeadZone.cpp.

bool DeadZone::loadModelFromFile ( std::fstream & file )

virtual

This loads the DeadZone settings from a file. This overrides the loadModelFromFile function in the PreProcessing base class.

Parameters

fstream &file: a reference to the file to load the settings from

Returns: returns true if the model was loaded successfully, false otherwise

Reimplemented from PreProcessing.

Definition at line 156 of file DeadZone.cpp.

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

Sets the equals operator, copies the data from the rhs instance to this instance

Parameters

rhs	another instance of the DeadZone class from which the data will be copied to this instance

Returns: a reference to this instance of DeadZone

Definition at line 52 of file DeadZone.cpp.

bool DeadZone::process ( const VectorFloat & inputVector )

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 DeadZone's filter function.

Parameters

inputVector the inputVector that should be processed. Must have the same dimensionality as the PreProcessing module

Returns: true if the data was processed, false otherwise

Reimplemented from PreProcessing.

Definition at line 81 of file DeadZone.cpp.

bool DeadZone::reset ( )

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 deadZone by re-initiliazing the instance.

Returns: true if the filter was reset, false otherwise

Reimplemented from PreProcessing.

Definition at line 99 of file DeadZone.cpp.

bool DeadZone::saveModelToFile ( std::string filename ) const

virtual

This saves the current settings of the DeadZone to a file. This overrides the saveModelToFile function in the PreProcessing base class.

Parameters

string filename: the name of the file to save the settings to

Returns: returns true if the model was saved successfully, false otherwise

Reimplemented from PreProcessing.

Definition at line 103 of file DeadZone.cpp.

bool DeadZone::saveModelToFile ( std::fstream & file ) const

virtual

This saves the current settings of the DeadZone to a file. This overrides the saveModelToFile function in the PreProcessing base class.

Parameters

fstream &file: a reference to the file the settings will be saved to

Returns: returns true if the settings were saved successfully, false otherwise

Reimplemented from PreProcessing.

Definition at line 123 of file DeadZone.cpp.

bool DeadZone::setLowerLimit ( Float lowerLimit )

Sets the lower limit of the dead-zone region.

Parameters

Float lowerLimit: the new lower limit for the dead zone

Returns: returns true if the lowerLimit value was set, false otherwise

Definition at line 262 of file DeadZone.cpp.

bool DeadZone::setUpperLimit ( Float upperLimit )

Sets the upper limit of the dead-zone region.

Parameters

Float upperLimit: the new upper limit for the dead zone

Returns: returns true if the upperLimit value was set, false otherwise

Definition at line 267 of file DeadZone.cpp.

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

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation