The MixtureComposerFacade allows to interact with a composer for estimating a mixture model with less effort. More...

#include <STK_MixtureComposerFacade.h>

Public Member Functions
	MixtureComposerFacade (IMixtureComposer *p_composer=0)
	constructor.

	~MixtureComposerFacade ()
	destructor.

IMixtureComposer *const &	p_composer () const

DataHandler_ const &	handler () const

DataHandler_ const &	kerHandler () const

DiagGaussianMixtureManager< DataHandler_ > const &	diagGaussianManager () const

PoissonMixtureManager< DataHandler_ > const &	poissonManager () const

GammaMixtureManager< DataHandler_ > const &	gammaManager () const
	gamma mixture models manager

CategoricalMixtureManager< DataHandler_ > const &	categoricalManager () const
	categorical mixture models manager

KernelMixtureManager const &	kmmManager () const
	Kernel Mixture Manager.

bool	setParameters (std::string const &idData, ArrayXX const &param)
	set parameters of a component

void	setDiagGaussianParameters (std::string const &idData, ArrayXX const &param)
	set diagonal Gaussian parameters

void	setPoissonParameters (std::string const &idData, ArrayXX const &param)
	set Poisson parameters

void	setGammaParameters (std::string const &idData, ArrayXX const &param)
	set gamma parameters

void	setCategoricalParameters (std::string const &idData, ArrayXX const &param)
	set categorical parameters

void	setKmmParameters (std::string const &idData, ArrayXX const &param)
	set Kernel Mixture Model parameters

bool	getParameters (std::string const &idData, ArrayXX &param)
	get parameters

void	getDiagGaussianParameters (std::string const &idData, ArrayXX &param)
	get diagonal Gaussian parameters

void	getPoissonParameters (std::string const &idData, ArrayXX &param)
	get Poisson parameters

void	getGammaParameters (std::string const &idData, ArrayXX &param)
	get gamma parameters

void	getCategoricalParameters (std::string const &idData, ArrayXX &param)
	get categorical parameters

void	getKmmParameters (std::string const &idData, ArrayXX &param)
	get Kernel Mixture Model parameters

void	createMixtureComposer (int nbCluster)
	create a MixtureComposer @nbCluster number of cluster

void	createMixtureComposerFixedProp (int nbCluster)
	create a MixtureComposerFixedProp @nbCluster number of cluster

void	createMixtureSemiLearner (int nbCluster)
	create a MixtureSemiLearner @nbCluster number of cluster

void	createMixtureSemiLearnerFixedProp (int nbCluster)
	create a MixtureSemiLearnerFixedProp @nbCluster number of cluster

void	deleteComposer ()
	delete composer

void	createMixtures ()
	create all mixtures

template<class Array >
void	setMixtureParameters (Array const &tik)
	set the mixture parameters using an array of posterior probabilities.

template<class Array , class RowVector >
void	setMixtureParameters (Array const &tik, RowVector const &pk)
	set the mixture parameters giving the posterior probabilities and the proportions.

template<class RowVector >
void	setProportions (RowVector const &pk)
	Set proportions of each classes.

Public Attributes
IMixtureComposer *	p_composer_
	pointer on the main p_composer

DataHandler_	handler_
	data handler for model based mixture models

KernelHandler	kerHandler_
	handler for kernel mixture models

KernelMixtureManager	kmmManager_
	Kernel Mixture Manager.

Protected Attributes
DiagGaussianMixtureManager< DataHandler_ >	diagGaussianManager_
	diagonal Gaussian mixture models manager

PoissonMixtureManager< DataHandler_ >	poissonManager_
	Poisson mixture models manager.

GammaMixtureManager< DataHandler_ >	gammaManager_
	gamma mixture models manager

CategoricalMixtureManager< DataHandler_ >	categoricalManager_
	categorical mixture models manager

Detailed Description

template<class DataHandler_>
class STK::MixtureComposerFacade< DataHandler_ >

The MixtureComposerFacade allows to interact with a composer for estimating a mixture model with less effort.

This class stores also publicly an instance of a DataHandler and a KernelHandler.

Definition at line 57 of file STK_MixtureComposerFacade.h.

Constructor & Destructor Documentation

◆ MixtureComposerFacade()

template<class DataHandler_ >

STK::MixtureComposerFacade< DataHandler_ >::MixtureComposerFacade ( IMixtureComposer * p_composer = 0 )

inline

constructor.

Parameters

p_composer p_composer to use

Definition at line 72 of file STK_MixtureComposerFacade.h.

                         : p_composer_(p_composer)
                         , handler_()
                         , kerHandler_()
                         , kmmManager_(kerHandler_)
                         , diagGaussianManager_(handler_)
                         , poissonManager_(handler_)
                         , gammaManager_(handler_)
                         , categoricalManager_(handler_)
    {}

◆ ~MixtureComposerFacade()

template<class DataHandler_ >

STK::MixtureComposerFacade< DataHandler_ >::~MixtureComposerFacade ( )

inline

destructor.

Definition at line 83 of file STK_MixtureComposerFacade.h.

83{ if (p_composer_) delete p_composer_;}

References STK::MixtureComposerFacade< DataHandler_ >::p_composer_.

Member Function Documentation

◆ categoricalManager()

template<class DataHandler_ >

CategoricalMixtureManager< DataHandler_ > const & STK::MixtureComposerFacade< DataHandler_ >::categoricalManager ( ) const

inline

categorical mixture models manager

Definition at line 105 of file STK_MixtureComposerFacade.h.

106 { return categoricalManager_;}

References STK::MixtureComposerFacade< DataHandler_ >::categoricalManager_.

◆ createMixtureComposer()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::createMixtureComposer ( int nbCluster )

create a MixtureComposer @nbCluster number of cluster

Definition at line 190 of file STK_MixtureComposerFacade.h.

191{ p_composer_ = new MixtureComposer(handler().nbSample(), nbCluster) ;}

STK::MixtureComposerFacade::handler

DataHandler_ const & handler() const

Definition STK_MixtureComposerFacade.h:90

◆ createMixtureComposerFixedProp()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::createMixtureComposerFixedProp ( int nbCluster )

create a MixtureComposerFixedProp @nbCluster number of cluster

Definition at line 195 of file STK_MixtureComposerFacade.h.

196{ p_composer_ = new MixtureComposerFixedProp(handler().nbSample(), nbCluster) ;}

◆ createMixtures()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::createMixtures ( )

create all mixtures

Definition at line 215 of file STK_MixtureComposerFacade.h.

{
  p_composer_->createMixture(diagGaussianManager_);
  p_composer_->createMixture(poissonManager_);
  p_composer_->createMixture(gammaManager_);
  p_composer_->createMixture(categoricalManager_);
  p_composer_->createMixture(kmmManager_);
}

◆ createMixtureSemiLearner()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::createMixtureSemiLearner ( int nbCluster )

create a MixtureSemiLearner @nbCluster number of cluster

Definition at line 200 of file STK_MixtureComposerFacade.h.

201{ p_composer_ = new MixtureSemiLearner(handler().nbSample(), nbCluster) ;}

◆ createMixtureSemiLearnerFixedProp()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::createMixtureSemiLearnerFixedProp ( int nbCluster )

create a MixtureSemiLearnerFixedProp @nbCluster number of cluster

Definition at line 205 of file STK_MixtureComposerFacade.h.

206{ p_composer_ = new MixtureSemiLearnerFixedProp(handler().nbSample(), nbCluster) ;}

◆ deleteComposer()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::deleteComposer ( )

delete composer

Definition at line 210 of file STK_MixtureComposerFacade.h.

211{ if (p_composer_) delete p_composer_; p_composer_ = 0;}

◆ diagGaussianManager()

template<class DataHandler_ >

DiagGaussianMixtureManager< DataHandler_ > const & STK::MixtureComposerFacade< DataHandler_ >::diagGaussianManager ( ) const

inline

Returns: DiagGaussian mixtures manager

Definition at line 96 of file STK_MixtureComposerFacade.h.

97 { return diagGaussianManager_;}

References STK::MixtureComposerFacade< DataHandler_ >::diagGaussianManager_.

◆ gammaManager()

template<class DataHandler_ >

GammaMixtureManager< DataHandler_ > const & STK::MixtureComposerFacade< DataHandler_ >::gammaManager ( ) const

inline

gamma mixture models manager

Definition at line 102 of file STK_MixtureComposerFacade.h.

103 { return gammaManager_;}

References STK::MixtureComposerFacade< DataHandler_ >::gammaManager_.

◆ getCategoricalParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::getCategoricalParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get categorical parameters

Definition at line 334 of file STK_MixtureComposerFacade.h.

335{ p_composer_->getParameters(categoricalManager_,idData, param);}

STK::IMixtureStatModel::getParameters

void getParameters(IMixtureManager< Manager > const &manager, String const &idData, Parameters &param) const

Utility method allowing to get the parameters of a specific mixture.

Definition STK_IMixtureStatModel.h:464

◆ getDiagGaussianParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::getDiagGaussianParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get diagonal Gaussian parameters

Definition at line 322 of file STK_MixtureComposerFacade.h.

323{ p_composer_->getParameters(diagGaussianManager_,idData, param);}

◆ getGammaParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::getGammaParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get gamma parameters

Definition at line 330 of file STK_MixtureComposerFacade.h.

331{ p_composer_->getParameters(gammaManager_,idData, param);}

◆ getKmmParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::getKmmParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get Kernel Mixture Model parameters

Definition at line 338 of file STK_MixtureComposerFacade.h.

339{ p_composer_->getParameters(kmmManager_,idData, param);}

◆ getParameters()

template<class DataHandler_ >

bool STK::MixtureComposerFacade< DataHandler_ >::getParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get parameters

Definition at line 226 of file STK_MixtureComposerFacade.h.

{
  // get idModel from idData
  String idModel;
  if(!handler_.getIdModelName(idData, idModel)) { return false;} // should not happened
 
  // get mixture id
  Clust::Mixture mix = Clust::stringToMixture(idModel);
  if (mix == Clust::unknown_mixture_)
  {
    bool prop;
    mix = Clust::stringToMixture(idModel, prop);
  }
 
  // get mixture class (gamma, Gaussian, Poisson, etc.) and parameters for this class of mixture
  switch (Clust::mixtureToMixtureClass(mix))
  {
    case Clust::DiagGaussian_:
      getDiagGaussianParameters( idData, param);
      return true;
      break;
    case Clust::Poisson_:
      getPoissonParameters( idData, param);
      return true;
      break;
    case Clust::Gamma_:
      getGammaParameters( idData, param);
      return true;
      break;
    case Clust::Categorical_:
      getCategoricalParameters( idData, param);
      return true;
      break;
    case Clust::Kmm_:
      getKmmParameters( idData, param);
      return true;
      break;
    case Clust::unknown_mixture_class_:
      return false;
      break;
    default:
      return false;
      break;
  }
  return false; // avoid compiler warning
}

References STK::Clust::Categorical_, STK::Clust::DiagGaussian_, STK::Clust::Gamma_, STK::Clust::Kmm_, STK::Clust::mixtureToMixtureClass(), STK::Clust::Poisson_, STK::Clust::stringToMixture(), STK::Clust::unknown_mixture_, and STK::Clust::unknown_mixture_class_.

◆ getPoissonParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::getPoissonParameters	(	std::string const &	idData,
		ArrayXX &	param
	)

get Poisson parameters

Definition at line 326 of file STK_MixtureComposerFacade.h.

327{ p_composer_->getParameters(poissonManager_,idData, param);}

◆ handler()

template<class DataHandler_ >

DataHandler_ const & STK::MixtureComposerFacade< DataHandler_ >::handler ( ) const

inline

Returns: data handler

Definition at line 90 of file STK_MixtureComposerFacade.h.

91 { return handler_;}

References STK::MixtureComposerFacade< DataHandler_ >::handler_.

◆ kerHandler()

template<class DataHandler_ >

DataHandler_ const & STK::MixtureComposerFacade< DataHandler_ >::kerHandler ( ) const

inline

Returns: kernel handler

Definition at line 93 of file STK_MixtureComposerFacade.h.

94 { return kerHandler_;}

References STK::MixtureComposerFacade< DataHandler_ >::kerHandler_.

◆ kmmManager()

template<class DataHandler_ >

KernelMixtureManager const & STK::MixtureComposerFacade< DataHandler_ >::kmmManager ( ) const

inline

Kernel Mixture Manager.

Definition at line 108 of file STK_MixtureComposerFacade.h.

109 { return kmmManager_;}

References STK::MixtureComposerFacade< DataHandler_ >::kmmManager_.

◆ p_composer()

template<class DataHandler_ >

IMixtureComposer *const & STK::MixtureComposerFacade< DataHandler_ >::p_composer ( ) const

inline

Returns: pointer on the composer

Definition at line 87 of file STK_MixtureComposerFacade.h.

88 { return p_composer_;}

References STK::MixtureComposerFacade< DataHandler_ >::p_composer_.

◆ poissonManager()

template<class DataHandler_ >

PoissonMixtureManager< DataHandler_ > const & STK::MixtureComposerFacade< DataHandler_ >::poissonManager ( ) const

inline

Returns: Poisson mixture models manager

Definition at line 99 of file STK_MixtureComposerFacade.h.

100 { return poissonManager_;}

References STK::MixtureComposerFacade< DataHandler_ >::poissonManager_.

◆ setCategoricalParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::setCategoricalParameters	(	std::string const &	idData,
		ArrayXX const &	param
	)

set categorical parameters

Definition at line 357 of file STK_MixtureComposerFacade.h.

358{ p_composer_->setParameters(categoricalManager_,idData, param);}

STK::IMixtureStatModel::setParameters

void setParameters(IMixtureManager< Manager > const &manager, String const &idData, Parameters const &param)

Utility method allowing to set the parameters to a specific mixture.

Definition STK_IMixtureStatModel.h:407

◆ setDiagGaussianParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::setDiagGaussianParameters	(	std::string const &	idData,
		ArrayXX const &	param
	)

set diagonal Gaussian parameters

Definition at line 345 of file STK_MixtureComposerFacade.h.

346{ p_composer_->setParameters(diagGaussianManager_,idData, param);}

◆ setGammaParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::setGammaParameters	(	std::string const &	idData,
		ArrayXX const &	param
	)

set gamma parameters

Definition at line 353 of file STK_MixtureComposerFacade.h.

354{ p_composer_->setParameters(gammaManager_,idData, param);}

◆ setKmmParameters()

template<class DataHandler_ >

void STK::MixtureComposerFacade< DataHandler_ >::setKmmParameters	(	std::string const &	idData,
		ArrayXX const &	param
	)

set Kernel Mixture Model parameters

Definition at line 361 of file STK_MixtureComposerFacade.h.

362{ p_composer_->setParameters(kmmManager_,idData, param);}

◆ setMixtureParameters() [1/2]

template<class DataHandler_ >

template<class Array >

void STK::MixtureComposerFacade< DataHandler_ >::setMixtureParameters ( Array const & tik )

set the mixture parameters using an array of posterior probabilities.

Proportions, numbers in each class and class labels are computed using these posterior probabilities.

Parameters

tik	posterior class probabilities

Definition at line 366 of file STK_MixtureComposerFacade.h.

367{ p_composer_->setMixtureParameters(tik);}

STK::IMixtureStatModel::setMixtureParameters

void setMixtureParameters(Array const &tik)

set the mixture parameters using an array of posterior probabilities.

Definition STK_IMixtureStatModel.h:414

◆ setMixtureParameters() [2/2]

template<class DataHandler_ >

template<class Array , class RowVector >

void STK::MixtureComposerFacade< DataHandler_ >::setMixtureParameters	(	Array const &	tik,
		RowVector const &	pk
	)

set the mixture parameters giving the posterior probabilities and the proportions.

Numbers in each class and class labels are computed using the posterior probabilities.

Parameters

tik	posterior class probabilities
pk	prior class proportion

Definition at line 371 of file STK_MixtureComposerFacade.h.

372{ p_composer_->setMixtureParameters(tik, pk);}

◆ setParameters()

template<class DataHandler_ >

bool STK::MixtureComposerFacade< DataHandler_ >::setParameters	(	std::string const &	idData,
		ArrayXX const &	param
	)

set parameters of a component

Definition at line 275 of file STK_MixtureComposerFacade.h.

{
    // get idModel from idData
    String idModel;
    if(!handler_.getIdModelName(idData, idModel)) { return false;}
    // get mixture id
    Clust::Mixture mix = Clust::stringToMixture(idModel);
    if (mix == Clust::unknown_mixture_)
    {
      bool prop;
      mix = Clust::stringToMixture(idModel, prop);
    }
 
    // get mixture class (gamma, Gaussian, Poisson, etc.) and parameters for this class of mixture
    switch (Clust::mixtureToMixtureClass(mix))
    {
      case Clust::DiagGaussian_:
        setDiagGaussianParameters( idData, param);
        return true;
        break;
      case Clust::Poisson_:
        setPoissonParameters( idData, param);
        return true;
        break;
      case Clust::Gamma_:
        setGammaParameters( idData, param);
        return true;
        break;
      case Clust::Categorical_:
        setCategoricalParameters( idData, param);
        return true;
        break;
      case Clust::Kmm_:
        setKmmParameters( idData, param);
        return true;
        break;
      case Clust::unknown_mixture_class_:
        return false;
        break;
      default:
        return false;
        break;
    }
    return true; // avoid compiler warning
}