contrib/mul/msm/msm_param_limiter.h File Reference

Base for objects with apply limits to parameters. More...

#include <vcl_string.h>
#include <vcl_memory.h>
#include <vcl_iosfwd.h>
#include <vsl/vsl_fwd.h>
#include <vnl/vnl_fwd.h>

Go to the source code of this file.

Classes
class	msm_param_limiter
	Base for objects with apply limits to parameters. More...
Functions
void	vsl_add_to_binary_loader (const msm_param_limiter &b)
	Allows derived class to be loaded by base-class pointer.
void	vsl_b_write (vsl_b_ostream &bfs, const msm_param_limiter &b)
	Binary file stream output operator for class reference.
void	vsl_b_read (vsl_b_istream &bfs, msm_param_limiter &b)
	Binary file stream input operator for class reference.
vcl_ostream &	operator<< (vcl_ostream &os, const msm_param_limiter &b)
	Stream output operator for class reference.
vcl_ostream &	operator<< (vcl_ostream &os, const msm_param_limiter *b)
	Stream output operator for class pointer.
void	vsl_print_summary (vcl_ostream &os, const msm_param_limiter &b)
	Stream output operator for class reference.
void	vsl_print_summary (vcl_ostream &os, const msm_param_limiter *b)
	Stream output operator for class reference.
double	msm_chi2_for_cum_prob (double p, int n, double tol=0.001)
	Returns X such that P(chi<X | dof==n)==p.

---

Detailed Description

Base for objects with apply limits to parameters.

Author:

Tim Cootes

Definition in file msm_param_limiter.h.

---

Function Documentation

double msm_chi2_for_cum_prob	(	double	p,
		int	n,
		double	tol = 0.001
	)

Returns X such that P(chi<X | dof==n)==p.

The value of Chi-Squared such that the probability that a random variable drawn from a chi-2 distribution is less than Chi_Squared is p.

Parameters:

p	Target probability
n	Number of dimensions
tol	Tolerance of result (default = 0.001)

Definition at line 105 of file msm_param_limiter.cxx.

vcl_ostream& operator<<	(	vcl_ostream &	os,
		const msm_param_limiter &	b
	)

Stream output operator for class reference.

Definition at line 68 of file msm_param_limiter.cxx.

vcl_ostream& operator<<	(	vcl_ostream &	os,
		const msm_param_limiter *	b
	)

Stream output operator for class pointer.

Definition at line 79 of file msm_param_limiter.cxx.

void vsl_add_to_binary_loader

(

const msm_param_limiter &

b

)

Allows derived class to be loaded by base-class pointer.

A loader object exists which is invoked by calls of the form "vsl_b_read(bfs,base_ptr);". This loads derived class objects from the disk, places them on the heap and returns a base class pointer. In order to work the loader object requires an instance of each derived class that might be found. This function gives the model class to the appropriate loader.

Definition at line 17 of file msm_param_limiter.cxx.

void vsl_b_read	(	vsl_b_istream &	bfs,
		msm_param_limiter &	b
	)

Binary file stream input operator for class reference.

Definition at line 61 of file msm_param_limiter.cxx.

void vsl_b_write	(	vsl_b_ostream &	bfs,
		const msm_param_limiter &	b
	)

Binary file stream output operator for class reference.

Definition at line 24 of file msm_param_limiter.cxx.

void vsl_print_summary	(	vcl_ostream &	os,
		const msm_param_limiter &	b
	)

Stream output operator for class reference.

Definition at line 89 of file msm_param_limiter.cxx.

void vsl_print_summary	(	vcl_ostream &	os,
		const msm_param_limiter *	b
	)

Stream output operator for class reference.

Definition at line 96 of file msm_param_limiter.cxx.