STK::ModelParameters< Clust::Gaussian_s_ > Struct Reference

Structure encapsulating the parameters of a STK::DiagGaussian_s model. More...

#include <STK_DiagGaussianParameters.h>

Public Member Functions
	ModelParameters (int nbCluster)
	default constructor
	ModelParameters (ModelParameters const &param)
	copy constructor.
	~ModelParameters ()
	destructor
ModelParameters &	operator= (ModelParameters const &param)
	copy operator.
Real const &	mean (int k, int j) const
Real const &	sigma (int k, int j) const
void	resize (Range const &range)
	resize and initialize the set of parameter.
void	updateStatistics ()
	update statistics of the parameters.
void	setStatistics ()
	Set the computed statistics.
void	releaseStatistics ()
	Release the computed statistics.
template<class Array >
void	setParameters (ExprBase< Array > const &params)
	Set the parameters of the mixture model.

Public Attributes
Array1D< CPointX >	mean_
	array of size nbCluster with the parameters mean of the variables
Real	sigma_
	standard deviation of the variables
Array1D< Stat::Online< CPointX, Real > >	stat_mean_
	Array of the mean statistics.
Stat::Online< Real, Real >	stat_sigma_
	Array of the standard deviation statistics.

Detailed Description

Structure encapsulating the parameters of a STK::DiagGaussian_s model.

Definition at line 247 of file STK_DiagGaussianParameters.h.

Constructor & Destructor Documentation

ModelParameters() [1/2]

STK::ModelParameters< Clust::Gaussian_s_ >::ModelParameters

(

int

nbCluster

)

default constructor

Parameters

nbCluster

the number of class of the mixture

Definition at line 247 of file STK_DiagGaussianParameters.cpp.

               : mean_(nbCluster), sigma_(1.)
               , stat_mean_(nbCluster), stat_sigma_()
{}

ModelParameters() [2/2]

STK::ModelParameters< Clust::Gaussian_s_ >::ModelParameters

(

ModelParameters< Clust::Gaussian_s_ > const &

param

)

copy constructor.

Parameters

param

the parameters to copy.

Definition at line 254 of file STK_DiagGaussianParameters.cpp.

               : mean_(param.mean_), sigma_(param.sigma_)
               , stat_mean_(param.stat_mean_), stat_sigma_(param.stat_sigma_)
{}

~ModelParameters()

STK::ModelParameters< Clust::Gaussian_s_ >::~ModelParameters

(

)

destructor

Definition at line 259 of file STK_DiagGaussianParameters.cpp.

{}

Member Function Documentation

mean()

Real const & STK::ModelParameters< Clust::Gaussian_s_ >::mean ( int  k, int  j  ) const

inline

Returns

the mean of the kth cluster and jth variable

Definition at line 274 of file STK_DiagGaussianParameters.h.

{ return mean_[k][j];}

operator=()

ModelParameters< Clust::Gaussian_s_ > & STK::ModelParameters< Clust::Gaussian_s_ >::operator=

(

ModelParameters< Clust::Gaussian_s_ > const &

param

)

copy operator.

Parameters

param

the parameters to copy.

Definition at line 263 of file STK_DiagGaussianParameters.cpp.

{
  mean_  = param.mean_;
  sigma_ = param.sigma_;
  stat_mean_  = param.stat_mean_;
  stat_sigma_ = param.stat_sigma_;
  return *this;
}

releaseStatistics()

void STK::ModelParameters< Clust::Gaussian_s_ >::releaseStatistics

(

)

Release the computed statistics.

Definition at line 303 of file STK_DiagGaussianParameters.cpp.

{
  for(int k=stat_mean_.begin(); k<stat_mean_.end(); ++k)
  { stat_mean_[k].release();}
  stat_sigma_.release();
}

resize()

void STK::ModelParameters< Clust::Gaussian_s_ >::resize

(

Range const &

range

)

resize and initialize the set of parameter.

Parameters

range

range of the variables in the data set

Definition at line 272 of file STK_DiagGaussianParameters.cpp.

{
  for (int k = mean_.begin(); k< mean_.end(); ++k)
  {
    mean_[k].resize(range) = 0;
    stat_mean_[k].resize(range);
  }
  sigma_ = 1.;
  stat_sigma_.release();
}

setParameters()

template<class Array >

void STK::ModelParameters< Clust::Gaussian_s_ >::setParameters ( ExprBase< Array > const &  params )

inline

Set the parameters of the mixture model.

It is assumed that array params stores for each class the mean and sd parameters on two consecutive rows. The number of column of params is the number of variables.

Definition at line 296 of file STK_DiagGaussianParameters.h.

  {
    sigma_ =0.;
    for(int k=mean_.begin(), kp= params.beginRows(); k<mean_.end(); ++k, kp+=2)
    {
      mean_[k] = params.row(kp);
      sigma_ += params.row(kp+1).mean();
    }
    sigma_ /= mean_.size();
  }

setStatistics()

void STK::ModelParameters< Clust::Gaussian_s_ >::setStatistics

(

)

Set the computed statistics.

Definition at line 292 of file STK_DiagGaussianParameters.cpp.

{
  for(int k=stat_mean_.begin(); k<stat_mean_.end(); ++k)
  {
    mean_[k]  = stat_mean_[k].mean();
    stat_mean_[k].release();
  }
  sigma_ = stat_sigma_.mean();
  stat_sigma_.release();
}

sigma()

Real const & STK::ModelParameters< Clust::Gaussian_s_ >::sigma ( int  k, int  j  ) const

inline

Returns

the standard deviation of the kth cluster and jth variable

Definition at line 276 of file STK_DiagGaussianParameters.h.

{ return sigma_;}

updateStatistics()

void STK::ModelParameters< Clust::Gaussian_s_ >::updateStatistics

(

)

update statistics of the parameters.

Definition at line 283 of file STK_DiagGaussianParameters.cpp.

{
  for(int k=stat_mean_.begin(); k<stat_mean_.end(); ++k)
  {
    stat_mean_[k].update(mean_[k]);
  }
  stat_sigma_.update(sigma_);
}

Member Data Documentation

mean_

Array1D<CPointX> STK::ModelParameters< Clust::Gaussian_s_ >::mean_

array of size nbCluster with the parameters mean of the variables

Definition at line 250 of file STK_DiagGaussianParameters.h.

sigma_

Real STK::ModelParameters< Clust::Gaussian_s_ >::sigma_

standard deviation of the variables

Definition at line 252 of file STK_DiagGaussianParameters.h.

stat_mean_

Array1D< Stat::Online<CPointX, Real> > STK::ModelParameters< Clust::Gaussian_s_ >::stat_mean_

Array of the mean statistics.

Definition at line 254 of file STK_DiagGaussianParameters.h.

stat_sigma_

Stat::Online<Real, Real> STK::ModelParameters< Clust::Gaussian_s_ >::stat_sigma_

Array of the standard deviation statistics.

Definition at line 256 of file STK_DiagGaussianParameters.h.

---

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

• STK_DiagGaussianParameters.h
• STK_DiagGaussianParameters.cpp