Inheritance diagram for ParticleClassifier:

Public Member Functions
	ParticleClassifier (const unsigned int numParticles=2000, const Float sensorNoise=20.0, const Float transitionSigma=0.005, const Float phaseSigma=0.1, const Float velocitySigma=0.01)

	ParticleClassifier (const ParticleClassifier &rhs)

virtual	~ParticleClassifier (void)

ParticleClassifier &	operator= (const ParticleClassifier &rhs)

virtual bool	deepCopyFrom (const Classifier *classifier)

virtual bool	train_ (TimeSeriesClassificationData &trainingData)

virtual bool	predict_ (VectorFloat &inputVector)

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

virtual bool	loadModelFromFile (std::fstream &file)

virtual bool	clear ()

virtual bool	reset ()

const Vector< ParticleClassifierGestureTemplate > &	getGestureTemplates () const

const ParticleClassifierParticleFilter &	getParticleFilter () const

VectorFloat	getStateEstimation () const

Float	getPhase () const

Float	getVelocity () const

bool	setNumParticles (const unsigned int numParticles)

bool	setSensorNoise (const unsigned int sensorNoise)

bool	setTransitionSigma (const unsigned int transitionSigma)

bool	setPhaseSigma (const unsigned int phaseSigma)

bool	setVelocitySigma (const unsigned int velocitySigma)

Public Member Functions inherited from Classifier
	Classifier (void)

virtual	~Classifier (void)

bool	copyBaseVariables (const Classifier *classifier)

std::string	getClassifierType () const

bool	getSupportsNullRejection () const

bool	getNullRejectionEnabled () const

Float	getNullRejectionCoeff () const

Float	getMaximumLikelihood () const

Float	getBestDistance () const

Float	getPhase () const

virtual UINT	getNumClasses () const

UINT	getClassLabelIndexValue (UINT classLabel) const

UINT	getPredictedClassLabel () const

VectorFloat	getClassLikelihoods () const

VectorFloat	getClassDistances () const

VectorFloat	getNullRejectionThresholds () const

Vector< UINT >	getClassLabels () const

Vector< MinMax >	getRanges () const

bool	enableNullRejection (bool useNullRejection)

virtual bool	setNullRejectionCoeff (Float nullRejectionCoeff)

virtual bool	setNullRejectionThresholds (VectorFloat newRejectionThresholds)

virtual bool	recomputeNullRejectionThresholds ()

bool	getTimeseriesCompatible () const

Classifier *	createNewInstance () const

Classifier *	deepCopy () const

const Classifier *	getClassifierPointer () const

const Classifier &	getBaseClassifier () 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 (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 (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	saveModelToFile (std::string filename) const

virtual bool	loadModelFromFile (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
unsigned int	numParticles

Float	sensorNoise

Float	transitionSigma

Float	phaseSigma

Float	velocitySigma

ParticleClassifierParticleFilter	particleFilter

Protected Attributes inherited from Classifier
std::string	classifierType

bool	supportsNullRejection

bool	useNullRejection

UINT	numClasses

UINT	predictedClassLabel

UINT	classifierMode

Float	nullRejectionCoeff

Float	maxLikelihood

Float	bestDistance

Float	phase

VectorFloat	classLikelihoods

VectorFloat	classDistances

VectorFloat	nullRejectionThresholds

Vector< UINT >	classLabels

Vector< MinMax >	ranges

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

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

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

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

static Vector< std::string >	getRegisteredClassifiers ()

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

static std::string	getGRTRevison ()

Protected Types inherited from Classifier
enum	ClassifierModes { STANDARD_CLASSIFIER_MODE =0, TIMESERIES_CLASSIFIER_MODE }

Protected Member Functions inherited from Classifier
bool	saveBaseSettingsToFile (std::fstream &file) const

bool	loadBaseSettingsFromFile (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 Classifier
static StringClassifierMap *	getMap ()

Detailed Description

Definition at line 29 of file ParticleClassifier.h.

Constructor & Destructor Documentation

ParticleClassifier::ParticleClassifier	(	const unsigned int	numParticles = `2000`,
		const Float	sensorNoise = `20.0`,
		const Float	transitionSigma = `0.005`,
		const Float	phaseSigma = `0.1`,
		const Float	velocitySigma = `0.01`
	)

Default Constructor

Definition at line 28 of file ParticleClassifier.cpp.

ParticleClassifier::ParticleClassifier ( const ParticleClassifier & rhs )

Default copy constructor

Defines how the data from the rhs ParticleClassifier should be copied to this ParticleClassifier

Parameters

rhs	another instance of a ParticleClassifier

Definition at line 46 of file ParticleClassifier.cpp.

ParticleClassifier::~ParticleClassifier ( void )

virtual

Default Destructor

Definition at line 50 of file ParticleClassifier.cpp.

Member Function Documentation

bool ParticleClassifier::clear ( )

virtual

This clears the ParticleClassifier classifier.

Returns: returns true if the ParticleClassifier model was successfully cleared, false otherwise.

Reimplemented from Classifier.

Definition at line 183 of file ParticleClassifier.cpp.

bool ParticleClassifier::deepCopyFrom ( const Classifier * classifier )

virtual

This is required for the Gesture Recognition Pipeline for when the pipeline.setClassifier(...) method is called. It clones the data from the Base Class Classifier pointer (which should be pointing to an ParticleClassifier instance) into this instance

Parameters

classifier a pointer to the Classifier Base Class, this should be pointing to another ParticleClassifier instance

Returns: returns true if the clone was successfull, false otherwise

Reimplemented from Classifier.

Definition at line 71 of file ParticleClassifier.cpp.

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

virtual

This loads a trained ParticleClassifier model from a file. This overrides the loadModelFromFile function in the Classifier base class.

Parameters

file	a reference to the file the ParticleClassifier model will be loaded from

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

Reimplemented from MLBase.

Definition at line 212 of file ParticleClassifier.cpp.

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

Defines how the data from the rhs ParticleClassifier should be copied to this ParticleClassifier

Parameters

rhs	another instance of a ParticleClassifier

Returns: returns a pointer to this instance of the ParticleClassifier

Definition at line 54 of file ParticleClassifier.cpp.

bool ParticleClassifier::predict_ ( VectorFloat & inputVector )

virtual

This predicts the class of the inputVector. This overrides the predict function in the Classifier base class.

Parameters

inputVector the input vector to classify

Returns: returns true if the prediction was performed, false otherwise

Reimplemented from MLBase.

Definition at line 119 of file ParticleClassifier.cpp.

bool ParticleClassifier::reset ( )

virtual

This resets the ParticleClassifier classifier.

Returns: returns true if the ParticleClassifier model was successfully reset, false otherwise.

Reimplemented from Classifier.

Definition at line 192 of file ParticleClassifier.cpp.

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

virtual

This saves the trained ParticleClassifier model to a file. This overrides the saveModelToFile function in the Classifier base class.

Parameters

file	a reference to the file the ParticleClassifier model will be saved to

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

Reimplemented from MLBase.

Definition at line 201 of file ParticleClassifier.cpp.

bool ParticleClassifier::train_ ( TimeSeriesClassificationData & trainingData )

virtual

This trains the ParticleClassifier model, using the labelled timeseries classification data. This overrides the train function in the Classifier base class.

Parameters

trainingData a reference to the training data

Returns: returns true if the DTW model was trained, false otherwise

Reimplemented from MLBase.

Definition at line 90 of file ParticleClassifier.cpp.

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation