Direct Graphical Models  v.1.7.0
DirectGraphicalModels::CPDFHistogram Class Reference

Histogram-based PDF class (1D) More...

#include <PDFHistogram.h>

Inheritance diagram for DirectGraphicalModels::CPDFHistogram:
Collaboration diagram for DirectGraphicalModels::CPDFHistogram:

Public Member Functions

 CPDFHistogram (void)
 
virtual ~CPDFHistogram (void)
 
virtual void reset (void)
 Resets class variables. More...
 
virtual void addPoint (Scalar point)
 Adds a sample point for PDF estimation. More...
 
virtual double getDensity (Scalar point)
 Returns the probability density value for the argument point. More...
 
virtual Scalar min (void) const
 Returns the lower argument boundary of the PDF. More...
 
virtual Scalar max (void) const
 Returns the upper argument boundary of the PDF. More...
 
void smooth (int nIt=1)
 Performs the gaussian smoothing on the histogram. More...
 
- Public Member Functions inherited from DirectGraphicalModels::IPDF
 IPDF (void)
 
virtual ~IPDF (void)
 
bool isEstimated (void)
 Checks weather the PDF was estimated. More...
 
- Public Member Functions inherited from DirectGraphicalModels::CBaseRandomModel
 CBaseRandomModel (byte nStates)
 Constructor. More...
 
virtual ~CBaseRandomModel (void)
 
virtual void save (const std::string &path, const std::string &name=std::string(), short idx=-1) const
 Saves the training data. More...
 
virtual void load (const std::string &path, const std::string &name=std::string(), short idx=-1)
 Loads the training data. More...
 
byte getNumStates (void) const
 Returns number of states (classes) More...
 

Protected Member Functions

virtual void saveFile (FILE *pFile) const
 Saves the random model into the file. More...
 
virtual void loadFile (FILE *pFile)
 Loads the random model from the file. More...
 
- Protected Member Functions inherited from DirectGraphicalModels::CBaseRandomModel
std::string generateFileName (const std::string &path, const std::string &name, short idx) const
 Generates name of the data file for storing random model parameters. More...
 

Private Attributes

long m_data [256]
 

Additional Inherited Members

- Protected Attributes inherited from DirectGraphicalModels::IPDF
long m_nPoints
 The number of samples, added with the addPoint() function. More...
 
- Protected Attributes inherited from DirectGraphicalModels::CBaseRandomModel
byte m_nStates
 The number of states (classes) More...
 

Detailed Description

Histogram-based PDF class (1D)

This class makes use of distribution histograms in order to estimate the PDF. The length of the histogram is 255, thus arguments point of the addPoint() and getDensity() functions should be also in range [0; 255].

Author
Sergey G. Kosov, serge.nosp@m.y.ko.nosp@m.sov@p.nosp@m.roje.nosp@m.ct-10.nosp@m..de

Definition at line 16 of file PDFHistogram.h.

Constructor & Destructor Documentation

◆ CPDFHistogram()

DirectGraphicalModels::CPDFHistogram::CPDFHistogram ( void  )

Definition at line 6 of file PDFHistogram.cpp.

◆ ~CPDFHistogram()

DirectGraphicalModels::CPDFHistogram::~CPDFHistogram ( void  )
virtual

Definition at line 12 of file PDFHistogram.cpp.

Member Function Documentation

◆ addPoint()

void DirectGraphicalModels::CPDFHistogram::addPoint ( Scalar  point)
virtual

Adds a sample point for PDF estimation.

Parameters
pointThe sample point.

Implements DirectGraphicalModels::IPDF.

Definition at line 21 of file PDFHistogram.cpp.

◆ getDensity()

double DirectGraphicalModels::CPDFHistogram::getDensity ( Scalar  point)
virtual

Returns the probability density value for the argument point.

Parameters
pointThe sample point.
Returns
The corresponding probaility density value.

Implements DirectGraphicalModels::IPDF.

Definition at line 28 of file PDFHistogram.cpp.

◆ loadFile()

void DirectGraphicalModels::CPDFHistogram::loadFile ( FILE *  pFile)
protectedvirtual

Loads the random model from the file.

Allows to re-use the class.

Parameters
pFilePointer to the file, opened for reading.

Implements DirectGraphicalModels::CBaseRandomModel.

Definition at line 49 of file PDFHistogram.cpp.

◆ max()

virtual Scalar DirectGraphicalModels::CPDFHistogram::max ( void  ) const
inlinevirtual

Returns the upper argument boundary of the PDF.

Returns
The upper bound

Implements DirectGraphicalModels::IPDF.

Definition at line 27 of file PDFHistogram.h.

◆ min()

virtual Scalar DirectGraphicalModels::CPDFHistogram::min ( void  ) const
inlinevirtual

Returns the lower argument boundary of the PDF.

Returns
The lower bound

Implements DirectGraphicalModels::IPDF.

Definition at line 26 of file PDFHistogram.h.

◆ reset()

void DirectGraphicalModels::CPDFHistogram::reset ( void  )
virtual

Resets class variables.

Allows to re-use the class.

Implements DirectGraphicalModels::CBaseRandomModel.

Definition at line 15 of file PDFHistogram.cpp.

◆ saveFile()

void DirectGraphicalModels::CPDFHistogram::saveFile ( FILE *  pFile) const
protectedvirtual

Saves the random model into the file.

Allows to re-use the class.

Parameters
pFilePointer to the file, opened for writing.

Implements DirectGraphicalModels::CBaseRandomModel.

Definition at line 43 of file PDFHistogram.cpp.

◆ smooth()

void DirectGraphicalModels::CPDFHistogram::smooth ( int  nIt = 1)

Performs the gaussian smoothing on the histogram.

Performs nIt iterations of gaussian smothing of the histograms in order to overcome the "over-fitting" problem

Parameters
nItNumber of iterations

Definition at line 34 of file PDFHistogram.cpp.

Member Data Documentation

◆ m_data

long DirectGraphicalModels::CPDFHistogram::m_data[256]
private

Definition at line 43 of file PDFHistogram.h.


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