mv_gmm.h File Reference

Multivariate Gaussian mixture model classifier. More...

#include <config.h>
#include <stdlib.h>
#include <inttypes.h>
#include <jwsc/base/error.h>
#include <jwsc/vector/vector.h>
#include <jwsc/matrix/matrix.h>
#include <jwsc/matblock/matblock.h>

Go to the source code of this file.

Data Structures
struct	MV_gmm_model
	Multivariate Gaussian mixture model. More...
struct	MV_gmm_model_node
	Multivariate Gaussian mixture model tree node. More...
Typedefs
typedef struct MV_gmm_model_node	MV_gmm_model_node
	Multivariate Gaussian mixture model tree node.
typedef MV_gmm_model_node	MV_gmm_model_tree
	Multivariate Gaussian mixture model tree.
Functions
void	train_mv_gmm_model (MV_gmm_model **model_out, const Vector_u32 *labels, const Matrix_i32 *markers, const Vector_d *priors, uint32_t num_components)
	Trains a multivariate Gaussian mixture model.
Error *	predict_label_with_mv_gmm_model (uint32_t *label_out, double *confidence_out, const Vector_i32 *markers, const MV_gmm_model *model, uint32_t order)
	Predicts the label for a marker sample using a multivariate Gaussian mixture model.
Error *	predict_labels_with_mv_gmm_model (Vector_u32 **labels_out, Vector_d **confidence_out, const Matrix_i32 *markers, const MV_gmm_model *model)
	Predicts the labels for a set of marker samples using a multivariate Gaussian mixture model.
Error *	read_mv_gmm_model (MV_gmm_model **model_out, const char *fname)
	Reads a multivariate Gaussian mixture model.
Error *	write_mv_gmm_model (MV_gmm_model *model, const char *fname)
	Writes a multivariate Gaussian mixture model.
void	free_mv_gmm_model (MV_gmm_model *model)
	Frees a multivariate Gaussian mixture model.
Error *	train_mv_gmm_model_tree (MV_gmm_model_tree **tree_out, const Vector_u32 *labels, const Matrix_i32 *markers, const char *tree_xml_fname, const char *tree_dtd_fname)
	Trains a multivariate Gaussian mixture model tree .
Error *	predict_labels_with_mv_gmm_model_tree (Vector_u32 **labels_out, Vector_d **confidence_out, const Matrix_i32 *markers, const MV_gmm_model_tree *tree, uint32_t order)
	Predicts the labels for a set of marker samples using a multivariate Gaussian mixture model tree.
Error *	read_mv_gmm_model_tree (MV_gmm_model_tree **tree_out, const char *tree_xml_fname, const char *tree_dtd_fname, const char *model_dirname)
	Reads a multivariate Gaussian mixture model tree from.
Error *	write_mv_gmm_model_tree (const MV_gmm_model_tree *tree, const char *model_dirname)
	Writes a multivariate Gaussian mixture model tree.
void	free_mv_gmm_model_tree (MV_gmm_model_tree *tree)
	Frees a multivariate Gaussian mixture model tree.

---

Detailed Description

Multivariate Gaussian mixture model classifier.

Author:

Joseph Schlecht

License:

Creative Commons BY-NC-SA 3.0

Definition in file mv_gmm.h.

---

Typedef Documentation

typedef struct MV_gmm_model_node MV_gmm_model_node

Multivariate Gaussian mixture model tree node.

typedef MV_gmm_model_node MV_gmm_model_tree

Multivariate Gaussian mixture model tree.

Definition at line 193 of file mv_gmm.h.

---

Function Documentation

void train_mv_gmm_model	(	MV_gmm_model **	model_out,
		const Vector_u32 *	labels,
		const Matrix_i32 *	markers,
		const Vector_d *	label_priors,
		uint32_t	num_components
	)

Trains a multivariate Gaussian mixture model.

Parameters:

model_out	Result parameter. If *model_out is NULL, a model is allocated; otherwise its space is re-used.
labels	Labels for training, with ith element as corresponding to the ith sample in markers.
markers	Markers for training, with ith row as a sample corresponding to the ith label in labels.
label_priors	Priors for each of the labels.
num_components	Number of mixture components.

Definition at line 93 of file mv_gmm.c.

Error* predict_label_with_mv_gmm_model	(	uint32_t *	label_out,
		double *	confidence_out,
		const Vector_i32 *	markers,
		const MV_gmm_model *	model,
		uint32_t	order
	)

Predicts the label for a marker sample using a multivariate Gaussian mixture model.

Parameters:

label_out	Result parameter.
confidence_out	Result parameter.
markers	Marker data to predict.
model	Trained model to use for predicting.
order	Indicates which of the The kth best prediction values to return. Starts with 0 representing the overall best, 1 the next best and so on.

Returns:

On success, NULL is returned; otherwise an error is returned.

Definition at line 208 of file mv_gmm.c.

Error* predict_labels_with_mv_gmm_model	(	Vector_u32 **	labels_out,
		Vector_d **	confidence_out,
		const Matrix_i32 *	markers,
		const MV_gmm_model *	model
	)

Predicts the labels for a set of marker samples using a multivariate Gaussian mixture model.

Parameters:

labels_out	Result parameter. If *labels_out is NULL, it is allocated; otherwise its space is re-used.
confidence_out	Result parameter. If *confidence_out is NULL, it is allocated; otherwise its space is re-used.
markers	Marker data to predict. Each row is a sample for prediction, corresponding to an element in the result parameters.
model	Trained model to use for predicting.

Returns:

On success, NULL is returned; otherwise an error is returned, but the result parameters are not freed.

Definition at line 339 of file mv_gmm.c.

Error* read_mv_gmm_model	(	MV_gmm_model **	model_out,
		const char *	fname
	)

Reads a multivariate Gaussian mixture model.

Parameters:

model_out	Result parameter. If *model_out is NULL, a model is allocated; otherwise its space is re-used.
fname	File to read the model from.

Returns:

On success, NULL is returned; otherwise an error is returned but does not free result parameter.

Definition at line 396 of file mv_gmm.c.

Error* write_mv_gmm_model	(	MV_gmm_model *	model,
		const char *	fname
	)

Writes a multivariate Gaussian mixture model.

Parameters:

model	Model to write.
fname	File to write to.

Returns:

On success, NULL is returned; otherwise an error is returned.

Definition at line 477 of file mv_gmm.c.

void free_mv_gmm_model

(

MV_gmm_model *

model

)

Frees a multivariate Gaussian mixture model.

Parameters:

model

Model to free.

Definition at line 525 of file mv_gmm.c.

Error* train_mv_gmm_model_tree	(	MV_gmm_model_tree **	tree_out,
		const Vector_u32 *	labels,
		const Matrix_i32 *	markers,
		const char *	tree_xml_fname,
		const char *	tree_dtd_fname
	)

Trains a multivariate Gaussian mixture model tree .

Parameters:

tree_out	Result parameter.
labels	Sample group labels.
markers	Sample marker values.
tree_xml_fname	XML file containing the model tree information.
tree_dtd_fname	DTD file for validating the XML file, can be NULL.

Definition at line 878 of file mv_gmm.c.

Error* predict_labels_with_mv_gmm_model_tree	(	Vector_u32 **	labels_out,
		Vector_d **	confidence_out,
		const Matrix_i32 *	markers,
		const MV_gmm_model_tree *	tree,
		uint32_t	order
	)

Predicts the labels for a set of marker samples using a multivariate Gaussian mixture model tree.

Parameters:

labels_out	Result parameter. If *labels_out is NULL, it is allocated; otherwise its space is re-used.
confidence_out	Result parameter. If *confidence_out is NULL, it is allocated; otherwise its space is re-used.
markers	Marker data to predict. Each row is a sample for prediction, corresponding to an element in the result parameters.
tree	Trained model tree to use for predicting.
order	The kth order prediction value. Zero being the best prediction.

Returns:

On success, NULL is returned; otherwise an error is returned, but the result parameters are not freed.

Definition at line 986 of file mv_gmm.c.

Error* read_mv_gmm_model_tree	(	MV_gmm_model_tree **	tree_out,
		const char *	tree_xml_fname,
		const char *	tree_dtd_fname,
		const char *	model_dirname
	)

Reads a multivariate Gaussian mixture model tree from.

Parameters:

tree_out	Result parameter.
tree_xml_fname	XML file containing the model tree information.
tree_dtd_fname	DTD file for validating the XML file, can be NULL.
model_dirname	Directory prefixing each model file in the tree.

Definition at line 1076 of file mv_gmm.c.

Error* write_mv_gmm_model_tree	(	const MV_gmm_model_tree *	tree,
		const char *	model_dirname
	)

Writes a multivariate Gaussian mixture model tree.

Parameters:

tree	Model tree to write.
model_dirname	Directory to prefix to each model file in the tree.

Definition at line 1128 of file mv_gmm.c.

void free_mv_gmm_model_tree

(

MV_gmm_model_tree *

tree

)

Frees a multivariate Gaussian mixture model tree.

Parameters:

tree	Model tree to free.

Definition at line 1163 of file mv_gmm.c.