xmm::ClassParameters< GMM > Class Template Reference

Parameters specific to each class of a Gaussian Mixture Model. More...

#include <xmmGmmParameters.hpp>

Inheritance diagram for xmm::ClassParameters< GMM >:

Collaboration diagram for xmm::ClassParameters< GMM >:

Public Member Functions
	ClassParameters ()
	Default Constructor. More...
	ClassParameters (ClassParameters< GMM > const &src)
	Copy Constructor. More...
	ClassParameters (Json::Value const &root)
	Constructor from Json Structure. More...
ClassParameters &	operator= (ClassParameters< GMM > const &src)
	Assignment. More...
Json I/O
Json::Value	toJson () const
	Write the object to a JSON Structure. More...
virtual void	fromJson (Json::Value const &root)
	Read the object from a JSON Structure. More...
Python File I/O
void	writeFile (char *fileName) const
	write method for python wrapping ('write' keyword forbidden, name has to be different) More...
void	readFile (char *fileName)
	read method for python wrapping ('read' keyword forbidden, name has to be different) More...
std::string	__str__ () const
	"print" method for python => returns the results of write method More...

Public Attributes
bool	changed = false
	specifies if parameters have changed (model is invalid) More...
Attribute< unsigned int >	gaussians
	Number of Gaussian Mixture Components. More...
Attribute< double >	relative_regularization
	Offset Added to the diagonal of covariance matrices for convergence (Relative to Data Variance) More...
Attribute< double >	absolute_regularization
	Offset Added to the diagonal of covariance matrices for convergence (minimum value) More...
Attribute< GaussianDistribution::CovarianceMode >	covariance_mode
	Covariance Mode. More...

Protected Member Functions
virtual void	onAttributeChange (AttributeBase *attr_pointer)
	notification function called when a member attribute is changed More...

Detailed Description

template<>
class xmm::ClassParameters< GMM >

Parameters specific to each class of a Gaussian Mixture Model.

Constructor & Destructor Documentation

xmm::ClassParameters< GMM >::ClassParameters

(

)

Default Constructor.

xmm::ClassParameters< GMM >::ClassParameters

(

ClassParameters< GMM > const &

src

)

Copy Constructor.

Parameters

src	Source Object

xmm::ClassParameters< GMM >::ClassParameters ( Json::Value const &  root )

explicit

Constructor from Json Structure.

Parameters

root	Json Value

Member Function Documentation

std::string xmm::Writable::__str__ ( ) const

inlineinherited

"print" method for python => returns the results of write method

Warning

only defined if SWIGPYTHON is defined

virtual void xmm::ClassParameters< GMM >::fromJson ( Json::Value const &  root )

virtual

Read the object from a JSON Structure.

Parameters

root	JSON value containing the object's information

Exceptions

JsonException

if the JSON value has a wrong format

Implements xmm::Writable.

Reimplemented in xmm::Configuration< GMM >.

virtual void xmm::ClassParameters< GMM >::onAttributeChange ( AttributeBase *  attr_pointer )

protectedvirtual

notification function called when a member attribute is changed

ClassParameters& xmm::ClassParameters< GMM >::operator=

(

ClassParameters< GMM > const &

src

)

Assignment.

Parameters

src	Source Object

void xmm::Writable::readFile ( char *  fileName )

inlineinherited

read method for python wrapping ('read' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

Json::Value xmm::ClassParameters< GMM >::toJson ( ) const

virtual

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implements xmm::Writable.

Reimplemented in xmm::Configuration< GMM >.

void xmm::Writable::writeFile ( char *  fileName ) const

inlineinherited

write method for python wrapping ('write' keyword forbidden, name has to be different)

Warning

only defined if SWIGPYTHON is defined

Member Data Documentation

Attribute<double> xmm::ClassParameters< GMM >::absolute_regularization

Offset Added to the diagonal of covariance matrices for convergence (minimum value)

bool xmm::ClassParameters< GMM >::changed = false

specifies if parameters have changed (model is invalid)

Attribute<GaussianDistribution::CovarianceMode> xmm::ClassParameters< GMM >::covariance_mode

Covariance Mode.

Attribute<unsigned int> xmm::ClassParameters< GMM >::gaussians

Number of Gaussian Mixture Components.

Attribute<double> xmm::ClassParameters< GMM >::relative_regularization

Offset Added to the diagonal of covariance matrices for convergence (Relative to Data Variance)

---

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

• xmmGmmParameters.hpp