w2img::Correlogram Class Reference

Inheritance diagram for w2img::Correlogram:

w2img::DataTableCorrelogram w2img::PixelValueCorrelogram List of all members.

Detailed Description

This class can be used to estimate (continually, or at just a snapshot in time) the correlogram.

The correlogram is describes the correlation between samples as a function of the distance between those samples.

Author:
Lakshman
Version:
Id
w2img_Correlogram.h,v 1.5 2009/06/02 20:17:57 lakshman Exp


Public Member Functions

bool write (const std::string &filename) const
 Write the correlogram values in a format fit to be easily plotted.
const Sampleoperator[] (size_t dist) const
 get the correlation between two samples separated by dist pixels in an euclidean framework.
size_t size () const
 Distance to which we have samples available.
virtual ~Correlogram ()
virtual size_t getAverageDistance () const =0
 What is the average distance between samples?

Protected Member Functions

Sampleoperator[] (size_t dist)
 Correlogram (size_t num_samples=0)

Protected Attributes

std::vector< Samplefunc

Classes

class  GaussianFit
 Fit a gaussian to a correlogram. More...
class  Sample
 Describes correlation of samples separated by a distance h Typical usage is to keep calling update() with new sample pairs and then call rho() whenever the correlation is needed. More...


Constructor & Destructor Documentation

virtual w2img::Correlogram::~Correlogram (  )  [inline, virtual]

w2img::Correlogram::Correlogram ( size_t  num_samples = 0  )  [protected]


Member Function Documentation

virtual size_t w2img::Correlogram::getAverageDistance (  )  const [pure virtual]

What is the average distance between samples?

Implemented in w2img::PixelValueCorrelogram, and w2img::DataTableCorrelogram.

Sample& w2img::Correlogram::operator[] ( size_t  dist  )  [inline, protected]

const Sample& w2img::Correlogram::operator[] ( size_t  dist  )  const [inline]

get the correlation between two samples separated by dist pixels in an euclidean framework.

dist has to be less than getMaxDistanceInPixels()

size_t w2img::Correlogram::size (  )  const [inline]

Distance to which we have samples available.

bool w2img::Correlogram::write ( const std::string &  filename  )  const

Write the correlogram values in a format fit to be easily plotted.

Returns:
true on success.


Member Data Documentation

std::vector< Sample > w2img::Correlogram::func [protected]


Generated on Fri May 4 13:40:23 2012 for WDSS-IIw2algs by  doxygen 1.4.7