vpdfl_axis_gaussian_sampler Class Reference

#include <vpdfl_axis_gaussian_sampler.h>

Inheritance diagram for vpdfl_axis_gaussian_sampler:

Inheritance graph
[legend]

List of all members.


Detailed Description

Samples from an axis aligned Gaussian PDF.

Definition at line 22 of file vpdfl_axis_gaussian_sampler.h.


Public Member Functions

 vpdfl_axis_gaussian_sampler ()
 Dflt ctor.
virtual ~vpdfl_axis_gaussian_sampler ()
 Destructor.
virtual void set_model (const vpdfl_pdf_base &)
 Set model for which this is an instance.
virtual void sample (vnl_vector< double > &x)
 Draw random sample from Gaussian distribution.
virtual void reseed (unsigned long)
 Reseeds the internal random number generator.
const vpdfl_axis_gaussianaxis_gaussian () const
 Return a reference to the pdf model.
virtual vcl_string is_a () const
 Name of the class.
virtual bool is_class (vcl_string const &s) const
 Does the name of the class match the argument?.
virtual vpdfl_sampler_baseclone () const
 Create a copy on the heap and return base class pointer.
const vpdfl_pdf_basemodel () const
 PDF of which this is an instance.
virtual void get_samples (vcl_vector< vnl_vector< double > > &x)
 Fill x with samples drawn from distribution.
virtual void regular_samples (vcl_vector< vnl_vector< double > > &x)
 Fill x with samples possibly chosen so as to represent the distribution.
virtual void regular_samples_and_prob (vcl_vector< vnl_vector< double > > &x, vnl_vector< double > &p)
 Fill x with samples possibly chosen so as to represent the distribution.
virtual void print_summary (vcl_ostream &os) const
 Print class to os.

Protected Attributes

vnl_random rng_
 The random number generator.
const vpdfl_pdf_basepdf_model_

Constructor & Destructor Documentation

vpdfl_axis_gaussian_sampler::vpdfl_axis_gaussian_sampler (  ) 

Dflt ctor.

Definition at line 20 of file vpdfl_axis_gaussian_sampler.cxx.

vpdfl_axis_gaussian_sampler::~vpdfl_axis_gaussian_sampler (  )  [virtual]

Destructor.

Definition at line 29 of file vpdfl_axis_gaussian_sampler.cxx.


Member Function Documentation

void vpdfl_axis_gaussian_sampler::set_model ( const vpdfl_pdf_base model  )  [virtual]

Set model for which this is an instance.

Error check that it is an axis gaussian.

Reimplemented from vpdfl_sampler_base.

Definition at line 70 of file vpdfl_axis_gaussian_sampler.cxx.

void vpdfl_axis_gaussian_sampler::sample ( vnl_vector< double > &  x  )  [virtual]

Draw random sample from Gaussian distribution.

Implements vpdfl_sampler_base.

Definition at line 80 of file vpdfl_axis_gaussian_sampler.cxx.

void vpdfl_axis_gaussian_sampler::reseed ( unsigned long  seed  )  [virtual]

Reseeds the internal random number generator.

To achieve quasi-random initialisation use;

 #include <vcl_ctime.h>
 ..
 sampler.reseed(vcl_time(0));

Implements vpdfl_sampler_base.

Definition at line 62 of file vpdfl_axis_gaussian_sampler.cxx.

const vpdfl_axis_gaussian & vpdfl_axis_gaussian_sampler::axis_gaussian (  )  const

Return a reference to the pdf model.

This is properly cast.

Definition at line 99 of file vpdfl_axis_gaussian_sampler.cxx.

vcl_string vpdfl_axis_gaussian_sampler::is_a (  )  const [virtual]

Name of the class.

Reimplemented from vpdfl_sampler_base.

Definition at line 38 of file vpdfl_axis_gaussian_sampler.cxx.

bool vpdfl_axis_gaussian_sampler::is_class ( vcl_string const &  s  )  const [virtual]

Does the name of the class match the argument?.

Reimplemented from vpdfl_sampler_base.

Definition at line 47 of file vpdfl_axis_gaussian_sampler.cxx.

vpdfl_sampler_base * vpdfl_axis_gaussian_sampler::clone (  )  const [virtual]

Create a copy on the heap and return base class pointer.

Implements vpdfl_sampler_base.

Definition at line 56 of file vpdfl_axis_gaussian_sampler.cxx.

const vpdfl_pdf_base & vpdfl_sampler_base::model (  )  const [inherited]

PDF of which this is an instance.

Definition at line 40 of file vpdfl_sampler_base.cxx.

void vpdfl_sampler_base::get_samples ( vcl_vector< vnl_vector< double > > &  x  )  [virtual, inherited]

Fill x with samples drawn from distribution.

Definition at line 48 of file vpdfl_sampler_base.cxx.

void vpdfl_sampler_base::regular_samples ( vcl_vector< vnl_vector< double > > &  x  )  [virtual, inherited]

Fill x with samples possibly chosen so as to represent the distribution.

Generate a set of pseudo-random samples, chosen so as to be suitable to represent the distribution. This is meant to be used for estimating continuous integrals with sampled approximations. Where there are multiple peaks (e.g. kernel or mixture models), it is preferred that the number of samples from each component is roughly proportional to the weight for the component. When small numbers are requested, this can be done explicitly. The default is simply to call sample() for each element of x

Reimplemented in vpdfl_gaussian_kernel_pdf_sampler.

Definition at line 57 of file vpdfl_sampler_base.cxx.

void vpdfl_sampler_base::regular_samples_and_prob ( vcl_vector< vnl_vector< double > > &  x,
vnl_vector< double > &  p 
) [virtual, inherited]

Fill x with samples possibly chosen so as to represent the distribution.

As regular_samples(x), but p[i] is set to p(x[i])

Definition at line 67 of file vpdfl_sampler_base.cxx.

void vpdfl_sampler_base::print_summary ( vcl_ostream &  os  )  const [virtual, inherited]

Print class to os.

Definition at line 104 of file vpdfl_sampler_base.cxx.


Member Data Documentation

The random number generator.

Definition at line 26 of file vpdfl_axis_gaussian_sampler.h.

const vpdfl_pdf_base* vpdfl_sampler_base::pdf_model_ [protected, inherited]

Definition at line 31 of file vpdfl_sampler_base.h.


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

Generated on Sun Nov 22 06:23:57 2009 for contrib/mul/vpdfl by  doxygen 1.5.5