Inheritance diagram for GMM:

Public Member Functions
	GMM (UINT numMixtureModels=2, bool useScaling=false, bool useNullRejection=false, Float nullRejectionCoeff=1.0, UINT maxIter=100, Float minChange=1.0e-5)

	GMM (const GMM &rhs)

virtual	~GMM (void)

GMM &	operator= (const GMM &rhs)

virtual bool	deepCopyFrom (const Classifier *classifier)

virtual bool	train_ (ClassificationData &trainingData)

virtual bool	predict_ (VectorFloat &inputVector)

virtual bool	clear ()

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

virtual bool	load (std::fstream &file)

virtual bool	recomputeNullRejectionThresholds ()

UINT	getNumMixtureModels ()

Vector< MixtureModel >	getModels ()

bool	setNumMixtureModels (const UINT K)

	GRT_DEPRECATED_MSG ("Use the base class function, setMaxNumEpochs(const UINT maxNumEpochs) instead", bool setMaxIter(UINT maxIter))

Public Member Functions inherited from Classifier
	Classifier (const std::string &classifierId="")

virtual	~Classifier (void)

bool	copyBaseVariables (const Classifier *classifier)

virtual bool	reset ()

virtual bool	computeAccuracy (const ClassificationData &data, Float &accuracy)

std::string	getClassifierType () const

bool	getSupportsNullRejection () const

bool	getNullRejectionEnabled () const

Float	getNullRejectionCoeff () const

Float	getMaximumLikelihood () const

Float	getBestDistance () const

Float	getPhase () const

Float	getTrainingSetAccuracy () const

virtual UINT	getNumClasses () const

UINT	getClassLabelIndexValue (const 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 (const bool useNullRejection)

virtual bool	setNullRejectionCoeff (const Float nullRejectionCoeff)

virtual bool	setNullRejectionThresholds (const VectorFloat &newRejectionThresholds)

bool	getTimeseriesCompatible () const

Classifier *	create () const

	GRT_DEPRECATED_MSG ("createNewInstance is deprecated, use create instead.", Classifier *createNewInstance() const )

	GRT_DEPRECATED_MSG ("createInstanceFromString is deprecated, use create instead.", static Classifier *createInstanceFromString(const std::string &id))

Classifier *	deepCopy () const

const Classifier *	getClassifierPointer () const

const Classifier &	getBaseClassifier () const

Public Member Functions inherited from MLBase
	MLBase (const std::string &id="", const BaseType type=BASE_TYPE_NOT_SET)

virtual	~MLBase (void)

bool	copyMLBaseVariables (const MLBase *mlBase)

virtual bool	train (ClassificationData trainingData)

virtual bool	train (RegressionData trainingData)

virtual bool	train_ (RegressionData &trainingData)

virtual bool	train (RegressionData trainingData, RegressionData validationData)

virtual bool	train_ (RegressionData &trainingData, RegressionData &validationData)

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 (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)

	GRT_DEPRECATED_MSG ("saveModelToFile(std::string filename) is deprecated, use save(const std::string &filename) instead", virtual bool saveModelToFile(const std::string &filename) const )

	GRT_DEPRECATED_MSG ("saveModelToFile(std::fstream &file) is deprecated, use save(std::fstream &file) instead", virtual bool saveModelToFile(std::fstream &file) const )

	GRT_DEPRECATED_MSG ("loadModelFromFile(std::string filename) is deprecated, use load(const std::string &filename) instead", virtual bool loadModelFromFile(const std::string &filename))

	GRT_DEPRECATED_MSG ("loadModelFromFile(std::fstream &file) is deprecated, use load(std::fstream &file) instead", virtual bool loadModelFromFile(std::fstream &file))

virtual bool	getModel (std::ostream &stream) const

virtual std::string	getModelAsString () const

DataType	getInputType () const

DataType	getOutputType () const

BaseType	getType () const

UINT	getNumInputFeatures () const

UINT	getNumInputDimensions () const

UINT	getNumOutputDimensions () const

UINT	getMinNumEpochs () const

UINT	getMaxNumEpochs () const

UINT	getBatchSize () const

UINT	getNumRestarts () const

UINT	getValidationSetSize () const

UINT	getNumTrainingIterationsToConverge () const

Float	getMinChange () const

Float	getLearningRate () const

Float	getRMSTrainingError () const

	GRT_DEPRECATED_MSG ("getRootMeanSquaredTrainingError() is deprecated, use getRMSTrainingError() instead", Float getRootMeanSquaredTrainingError() const )

Float	getTotalSquaredTrainingError () const

Float	getRMSValidationError () const

Float	getValidationSetAccuracy () const

VectorFloat	getValidationSetPrecision () const

VectorFloat	getValidationSetRecall () const

bool	getUseValidationSet () const

bool	getRandomiseTrainingOrder () const

bool	getTrained () const

	GRT_DEPRECATED_MSG ("getModelTrained() is deprecated, use getTrained() instead", bool getModelTrained() const )

bool	getConverged () const

bool	getScalingEnabled () const

bool	getIsBaseTypeClassifier () const

bool	getIsBaseTypeRegressifier () const

bool	getIsBaseTypeClusterer () const

bool	getTrainingLoggingEnabled () const

bool	getTestingLoggingEnabled () const

bool	enableScaling (const bool useScaling)

bool	setMaxNumEpochs (const UINT maxNumEpochs)

bool	setBatchSize (const UINT batchSize)

bool	setMinNumEpochs (const UINT minNumEpochs)

bool	setNumRestarts (const UINT numRestarts)

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	setTestingLoggingEnabled (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 (const std::string &id="")

virtual	~GRTBase (void)

bool	copyGRTBaseVariables (const GRTBase *GRTBase)

	GRT_DEPRECATED_MSG ("getClassType is deprecated, use getId() instead!", std::string getClassType() const )

std::string	getId () 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)

bool	setDebugLoggingEnabled (const bool loggingEnabled)

GRTBase *	getGRTBasePointer ()

const GRTBase *	getGRTBasePointer () const

Float	scale (const Float &x, const Float &minSource, const Float &maxSource, const Float &minTarget, const Float &maxTarget, const bool constrain=false)

Float	SQR (const Float &x) 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)

Static Public Member Functions
static std::string	getId ()

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

static Vector< std::string >	getRegisteredClassifiers ()

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

static std::string	getGRTRevison ()

Protected Member Functions
Float	computeMixtureLikelihood (const VectorFloat &x, UINT k)

bool	loadLegacyModelFromFile (std::fstream &file)

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 Attributes
UINT	numMixtureModels

Vector< MixtureModel >	models

Protected Attributes inherited from Classifier
bool	supportsNullRejection

bool	useNullRejection

UINT	numClasses

UINT	predictedClassLabel

UINT	classifierMode

Float	nullRejectionCoeff

Float	maxLikelihood

Float	bestDistance

Float	phase

Float	trainingSetAccuracy

VectorFloat	classLikelihoods

VectorFloat	classDistances

VectorFloat	nullRejectionThresholds

Vector< UINT >	classLabels

Vector< MinMax >	ranges

Protected Attributes inherited from MLBase
bool	trained

bool	useScaling

bool	converged

DataType	inputType

DataType	outputType

BaseType	baseType

UINT	numInputDimensions

UINT	numOutputDimensions

UINT	numTrainingIterationsToConverge

UINT	minNumEpochs

UINT	maxNumEpochs

UINT	batchSize

UINT	validationSetSize

UINT	numRestarts

Float	learningRate

Float	minChange

Float	rmsTrainingError

Float	rmsValidationError

Float	totalSquaredTrainingError

Float	validationSetAccuracy

bool	useValidationSet

bool	randomiseTrainingOrder

VectorFloat	validationSetPrecision

VectorFloat	validationSetRecall

Random	random

Vector< TrainingResult >	trainingResults

TrainingResultsObserverManager	trainingResultsObserverManager

TestResultsObserverManager	testResultsObserverManager

TrainingLog	trainingLog

TestingLog	testingLog

Protected Attributes inherited from GRTBase
std::string	classId
	Stores the name of the class (e.g., MinDist)

DebugLog	debugLog

ErrorLog	errorLog

InfoLog	infoLog

WarningLog	warningLog

Additional Inherited Members
Public Types inherited from Classifier
enum	ClassifierModes { STANDARD_CLASSIFIER_MODE =0, TIMESERIES_CLASSIFIER_MODE }

typedef std::map< std::string, Classifier ()() >	StringClassifierMap

Public Types inherited from MLBase
enum	BaseType { BASE_TYPE_NOT_SET =0, CLASSIFIER, REGRESSIFIER, CLUSTERER, PRE_PROCSSING, POST_PROCESSING, FEATURE_EXTRACTION, CONTEXT }

Static Protected Member Functions inherited from Classifier
static StringClassifierMap *	getMap ()

Detailed Description

Examples:: ClassificationModulesExamples/GMMExample/GMMExample.cpp.

Definition at line 48 of file GMM.h.

Constructor & Destructor Documentation

GMM::GMM	(	UINT	numMixtureModels = `2`,
		bool	useScaling = `false`,
		bool	useNullRejection = `false`,
		Float	nullRejectionCoeff = `1.0`,
		UINT	maxIter = `100`,
		Float	minChange = `1.0e-5`
	)

Default Constructor. Sets the number of mixture models to use for each model.

Definition at line 33 of file GMM.cpp.

GMM::GMM ( const GMM & rhs )

Defines the copy constructor.

Parameters

rhs	the instance from which all the data will be copied into this instance

Definition at line 45 of file GMM.cpp.

GMM::~GMM ( void )

virtual

Default destructor.

Definition at line 51 of file GMM.cpp.

Member Function Documentation

bool GMM::clear ( )

virtual

This overrides the clear function in the Classifier base class. It will completely clear the ML module, removing any trained model and setting all the base variables to their default values.

Returns: returns true if the module was cleared succesfully, false otherwise

Reimplemented from Classifier.

Definition at line 566 of file GMM.cpp.

bool GMM::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 GRT::Classifier pointer (which should be pointing to an GMM instance) into this instance

Parameters

classifier a pointer to the GRT::Classifier Base Class, this should be pointing to another GMM instance

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

Reimplemented from Classifier.

Definition at line 65 of file GMM.cpp.

std::string GMM::getId ( )

static

Gets a string that represents the GMM class.

Returns: returns a string containing the ID of this class

Definition at line 28 of file GMM.cpp.

Vector< MixtureModel > GMM::getModels ( )

This function returns a copy of the MixtureModels estimated during the training phase. Each element in the vector represents a MixtureModel for one class.

Returns: returns a vector of GRT::MixtureModel, an empty vector will be returned if the GRT::GMM has not been trained

Definition at line 593 of file GMM.cpp.

UINT GMM::getNumMixtureModels ( )

This function returns the number of mixture models.

Returns: returns the number of mixture models in the GMM

Definition at line 589 of file GMM.cpp.

GMM::GRT_DEPRECATED_MSG	(	"Use the base class	function,
		setMaxNumEpochs(const UINT maxNumEpochs) instead"	,
		bool	setMaxIterUINT maxIter
	)

Deprecated:: use setMaxNumEpochs(const UINT maxNumEpochs) instead This function sets the maxIter parameter which controls when the maximum number of iterations parameter that controls when the GMM train function should stop. MaxIter must be greater than zero.

Parameters

maxIter the new maxIter value

Returns: returns true if the number of maxIter was successfully updated, false otherwise

bool GMM::load ( std::fstream & file )

virtual

This loads a trained GMM model from a file. This overrides the load function in the GRT::Classifier base class.

Parameters

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

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

Reimplemented from MLBase.

Examples:: ClassificationModulesExamples/GMMExample/GMMExample.cpp.

Definition at line 381 of file GMM.cpp.

bool GMM::loadLegacyModelFromFile ( std::fstream & file )

protected

Read the ranges if needed

Definition at line 610 of file GMM.cpp.

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

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

Parameters

&rhs	another instance of a GMM

Returns: returns a pointer to this instance of the GMM

Definition at line 53 of file GMM.cpp.

bool GMM::predict_ ( VectorFloat & inputVector )

virtual

This predicts the class of the inputVector. This overrides the predict function in the GRT::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 82 of file GMM.cpp.

bool GMM::recomputeNullRejectionThresholds ( )

virtual

This function recomputes the null rejection thresholds for each model. This overrides the recomputeNullRejectionThresholds function in the GRT::Classifier base class.

Returns: returns true if the nullRejectionThresholds were updated successfully, false otherwise

Reimplemented from Classifier.

Definition at line 577 of file GMM.cpp.

bool GMM::save ( std::fstream & file ) const

virtual

This saves the trained GMM model to a file. This overrides the save function in the GRT::Classifier base class.

Parameters

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

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

Reimplemented from MLBase.

Examples:: ClassificationModulesExamples/GMMExample/GMMExample.cpp.

Definition at line 313 of file GMM.cpp.

bool GMM::setNumMixtureModels ( const UINT K )

This function sets the number of mixture models used for class. You should call this function before you train the GMM model. The number of mixture models must be greater than 0.

Parameters

K	the number of mixture models

Returns: returns true if the number of mixture models was successfully updated, false otherwise

Examples:: ClassificationModulesExamples/GMMExample/GMMExample.cpp.

Definition at line 598 of file GMM.cpp.

bool GMM::train_ ( ClassificationData & trainingData )

virtual

This trains the GMM model, using the labelled classification data. This overrides the train function in the GRT::Classifier base class. The GMM is an unsupervised learning algorithm, it will therefore NOT use any class labels provided

Parameters

trainingData a reference to the training data

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

Reimplemented from MLBase.

Definition at line 146 of file GMM.cpp.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation