xmm::SharedParameters Class Reference

Shared Parameters for models with multiple classes. More...

#include <xmmModelSharedParameters.hpp>

Inheritance diagram for xmm::SharedParameters:

Collaboration diagram for xmm::SharedParameters:

Public Member Functions
	SharedParameters ()
	Default Constructor. More...
	SharedParameters (SharedParameters const &src)
	Copy Constructor. More...
	SharedParameters (Json::Value const &root)
	Constructor from Json Structure. More...
SharedParameters &	operator= (SharedParameters const &src)
	Assignment. More...
Json I/O
virtual 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
Attribute< bool >	bimodal
	defines if the phrase is bimodal (true) or unimodal (false) More...
Attribute< unsigned int >	dimension
	total dimension of the training data More...
Attribute< unsigned int >	dimension_input
	Dimension of the input modality. More...
Attribute< std::vector< std::string > >	column_names
	labels of the columns of input/output data (e.g. descriptor names) More...
Attribute< unsigned int >	em_algorithm_min_iterations
	Minimum number of iterations of the EM algorithm. More...
Attribute< unsigned int >	em_algorithm_max_iterations
	Maximum number of iterations of the EM algorithm. More...
Attribute< double >	em_algorithm_percent_chg
	log-likelihood difference threshold necessary to stop the EM algorithm. More...
Attribute< unsigned int >	likelihood_window
	Size of the window (in samples) used to compute the likelihoods. More...

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

Friends
template<typename SingleClassModel , typename ModelType >
class	Model
class	SingleClassProbabilisticModel
class	SingleClassGMM
class	SingleClassHMM
class	HierarchicalHMM
class	GMM

Detailed Description

Shared Parameters for models with multiple classes.

This structure is shared by pointer between the class-specific models to avoid data duplication and ensures that all class-specific models share the same common attributes.

Constructor & Destructor Documentation

xmm::SharedParameters::SharedParameters

(

)

Default Constructor.

xmm::SharedParameters::SharedParameters

(

SharedParameters const &

src

)

Copy Constructor.

Parameters

src	Source Object

xmm::SharedParameters::SharedParameters ( 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

void xmm::SharedParameters::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.

void xmm::SharedParameters::onAttributeChange ( AttributeBase *  attr_pointer )

protectedvirtual

notification function called when a member attribute is changed

xmm::SharedParameters & xmm::SharedParameters::operator=

(

SharedParameters 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::SharedParameters::toJson ( ) const

virtual

Write the object to a JSON Structure.

Returns

Json value containing the object's information

Implements xmm::Writable.

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

Friends And Related Function Documentation

friend class GMM

friend

friend class HierarchicalHMM

friend

template<typename SingleClassModel , typename ModelType >

friend class Model

friend

friend class SingleClassGMM

friend

friend class SingleClassHMM

friend

friend class SingleClassProbabilisticModel

friend

Member Data Documentation

Attribute<bool> xmm::SharedParameters::bimodal

defines if the phrase is bimodal (true) or unimodal (false)

Attribute<std::vector<std::string> > xmm::SharedParameters::column_names

labels of the columns of input/output data (e.g. descriptor names)

Attribute<unsigned int> xmm::SharedParameters::dimension

total dimension of the training data

Attribute<unsigned int> xmm::SharedParameters::dimension_input

Dimension of the input modality.

Attribute<unsigned int> xmm::SharedParameters::em_algorithm_max_iterations

Maximum number of iterations of the EM algorithm.

If this value is superior to minSteps, this criterion is used. Otherwise, only the em_algorithm_percent_chg criterion applies.

Attribute<unsigned int> xmm::SharedParameters::em_algorithm_min_iterations

Minimum number of iterations of the EM algorithm.

Attribute<double> xmm::SharedParameters::em_algorithm_percent_chg

log-likelihood difference threshold necessary to stop the EM algorithm.

When the percent-change in likelihood of the training data given the estimated parameters gets under this threshold, the EM algorithm is stopped.

Attribute<unsigned int> xmm::SharedParameters::likelihood_window

Size of the window (in samples) used to compute the likelihoods.

---

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

• xmmModelSharedParameters.hpp
• xmmModelSharedParameters.cpp