SurpriseModelSG Class Reference

A single-Gaussian SurpriseModel. More...

#include <Surprise/SurpriseModel.H>

Inheritance diagram for SurpriseModelSG:

[legend]

Collaboration diagram for SurpriseModelSG:

[legend]

List of all members.

Public Member Functions
	SurpriseModelSG (const double updatefac=0.5, const double sampleval=0.0, const double samplevar=1.0)
	Constructor. See base class for details.
virtual	~SurpriseModelSG ()
	Virtual destructor ensures proper destruction of derived classes.
virtual void	reset ()
	Reset to initial state.
virtual void	init (const double updatefac=0.5, const double sampleval=0.0, const double samplevar=1.0)
	Change intial state parameters.
virtual void	load (const double sampleval, const double samplevar=1.0)
	Load given sample mean and variance.
virtual double	surprise (const SurpriseModelSG &other)
	Compute surprise between us and another model.
virtual void	preComputeHyperParams (const SurpriseModelSG &sample)
	Is empty in this model.
virtual void	combineFrom (const Image< SurpriseModelSG > &models, const Image< float > &weights)
	Initialize us as a weighted combination of the given map of models.
virtual void	combineFrom (const Image< SurpriseModelSG > &models, const Image< float > &weights, const Point2D< int > &pos, const int width, const int height, const int offset)
	Initialize us as a weighted combination of the given map of models.
virtual double	getMean () const
	get our mean
virtual double	getVar () const
	get our variance
virtual double	getUpdateFac () const
	get our UpdateFac
Protected Attributes
int	itsN
	our sample N
double	itsMean
	our current Gaussian mean
double	itsVar
	our current Gaussian variance

---

Detailed Description

A single-Gaussian SurpriseModel.

This is a very simple SurpriseModel consisting of a single Gaussian, which is updated in a sliding-average manner.

Definition at line 159 of file SurpriseModel.H.

---

Constructor & Destructor Documentation

SurpriseModelSG::SurpriseModelSG	(	const double	updatefac = 0.5,
		const double	sampleval = 0.0,
		const double	samplevar = 1.0
	)

Constructor. See base class for details.

Definition at line 167 of file SurpriseModel.C.

SurpriseModelSG::~SurpriseModelSG

(

)

[virtual]

Virtual destructor ensures proper destruction of derived classes.

Definition at line 177 of file SurpriseModel.C.

---

Member Function Documentation

void SurpriseModelSG::combineFrom	(	const Image< SurpriseModelSG > &	models,
		const Image< float > &	weights,
		const Point2D< int > &	pos,
		const int	width,
		const int	height,
		const int	offset
	)			[inline, virtual]

Initialize us as a weighted combination of the given map of models.

Definition at line 252 of file SurpriseModel.C.

void SurpriseModelSG::combineFrom	(	const Image< SurpriseModelSG > &	models,
		const Image< float > &	weights
	)			[inline, virtual]

Initialize us as a weighted combination of the given map of models.

Definition at line 243 of file SurpriseModel.C.

double SurpriseModelSG::getMean

(

)

const [inline, virtual]

get our mean

Implements SurpriseModel.

Definition at line 272 of file SurpriseModel.C.

References itsMean.

double SurpriseModelSG::getUpdateFac

(

)

const [inline, virtual]

get our UpdateFac

Implements SurpriseModel.

Definition at line 280 of file SurpriseModel.C.

References SurpriseModel::itsUpdateFac.

double SurpriseModelSG::getVar

(

)

const [inline, virtual]

get our variance

Implements SurpriseModel.

Definition at line 276 of file SurpriseModel.C.

References itsVar.

void SurpriseModelSG::init	(	const double	updatefac = 0.5,
		const double	sampleval = 0.0,
		const double	samplevar = 1.0
	)			[inline, virtual]

Change intial state parameters.

Reimplemented from SurpriseModel.

Definition at line 185 of file SurpriseModel.C.

References reset().

void SurpriseModelSG::load	(	const double	sampleval,
		const double	samplevar = 1.0
	)			[inline, virtual]

Load given sample mean and variance.

Implements SurpriseModel.

Definition at line 194 of file SurpriseModel.C.

References itsMean, and itsVar.

Referenced by reset().

void SurpriseModelSG::preComputeHyperParams

(

const SurpriseModelSG &

sample

)

[inline, virtual]

Is empty in this model.

Definition at line 227 of file SurpriseModel.C.

void SurpriseModelSG::reset

(

void

)

[inline, virtual]

Reset to initial state.

Implements SurpriseModel.

Definition at line 181 of file SurpriseModel.C.

References SurpriseModel::itsInitialVal, SurpriseModel::itsInitialVar, and load().

Referenced by init().

double SurpriseModelSG::surprise

(

const SurpriseModelSG &

other

)

[inline, virtual]

Compute surprise between us and another model.

Definition at line 199 of file SurpriseModel.C.

References itsMean, itsN, SurpriseModel::itsUpdateFac, itsVar, and log().

---

Member Data Documentation

double SurpriseModelSG::itsMean [protected]

our current Gaussian mean

Definition at line 206 of file SurpriseModel.H.

Referenced by getMean(), load(), and surprise().

int SurpriseModelSG::itsN [protected]

our sample N

Definition at line 205 of file SurpriseModel.H.

Referenced by surprise().

double SurpriseModelSG::itsVar [protected]

our current Gaussian variance

Definition at line 207 of file SurpriseModel.H.

Referenced by getVar(), load(), and surprise().

---

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

• src/Surprise/SurpriseModel.H
• src/Surprise/SurpriseModel.C