ProbDenFunc Class Reference

Base class for Probability Density Functions. More...

Inheritance diagram for ProbDenFunc:

Public Member Functions
virtual ProbDenFunc *	clone () const =0
virtual	~ProbDenFunc ()
virtual void	copyFrom (const ProbDenFunc &)=0
virtual bool	isEqual (const ProbDenFunc &) const
virtual const char *	getTypeStr () const =0
virtual int	nrDims () const =0
virtual const char *	dimName (int dim) const =0
virtual void	setDimName (int dim, const char *)=0
virtual float	averagePos (int dim) const =0
virtual float	value (const TypeSet< float > &) const =0
virtual bool	canScale () const
virtual void	scale (float)
virtual float	normFac () const
virtual void	fillPar (IOPar &) const =0
virtual bool	usePar (const IOPar &)=0
virtual void	writeBulk (od_ostream &, bool binary) const
virtual bool	readBulk (od_istream &, bool binary)
virtual bool	isCompatibleWith (const ProbDenFunc &) const
void	getIndexTableFor (const ProbDenFunc &pdf, TypeSet< int > &tbl) const
	tbl[0] tells what my index is for pdf's index '0' More...
virtual void	prepareRandDrawing () const
virtual void	drawRandomPos (TypeSet< float > &) const =0
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Static Public Member Functions
static const char *	sKeyNrDim ()

Protected Member Functions
	ProbDenFunc ()
	ProbDenFunc (const ProbDenFunc &)
virtual bool	isEq (const ProbDenFunc &) const =0
	already checked for type, name and dim names More...
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Additional Inherited Members
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Detailed Description

Base class for Probability Density Functions.

The values may not be normalized; if you need them to be: multiply with 'normFac()'. What you are getting can for example be the values from a histogram. All we require is that the value() implementation always returns positive values.

Constructor & Destructor Documentation

virtual ProbDenFunc::~ProbDenFunc ( )

inlinevirtual

ProbDenFunc::ProbDenFunc ( )

inlineprotected

ProbDenFunc::ProbDenFunc ( const ProbDenFunc &  )

protected

Member Function Documentation

virtual float ProbDenFunc::averagePos ( int  dim ) const

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, GaussianNDProbDenFunc, ProbDenFunc1D, and Gaussian2DProbDenFunc.

virtual bool ProbDenFunc::canScale ( ) const

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, and Sampled1DProbDenFunc.

virtual ProbDenFunc* ProbDenFunc::clone ( ) const

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, GaussianNDProbDenFunc, Sampled1DProbDenFunc, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

virtual void ProbDenFunc::copyFrom ( const ProbDenFunc &  )

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, Sampled1DProbDenFunc, ProbDenFunc1D, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

virtual const char* ProbDenFunc::dimName ( int  dim ) const

pure virtual

Implemented in SampledNDProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, and ProbDenFunc1D.

virtual void ProbDenFunc::drawRandomPos ( TypeSet< float > &  ) const

pure virtual

Implemented in SampledNDProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, and ProbDenFunc1D.

virtual void ProbDenFunc::fillPar ( IOPar &  ) const

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, Sampled1DProbDenFunc, GaussianNDProbDenFunc, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

void ProbDenFunc::getIndexTableFor	(	const ProbDenFunc &	pdf,
		TypeSet< int > &	tbl
	)		const

tbl[0] tells what my index is for pdf's index '0'

virtual const char* ProbDenFunc::getTypeStr ( ) const

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, GaussianNDProbDenFunc, Sampled1DProbDenFunc, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

virtual bool ProbDenFunc::isCompatibleWith ( const ProbDenFunc &  ) const

virtual

virtual bool ProbDenFunc::isEq ( const ProbDenFunc &  ) const

protectedpure virtual

already checked for type, name and dim names

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, GaussianNDProbDenFunc, Sampled1DProbDenFunc, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

virtual bool ProbDenFunc::isEqual ( const ProbDenFunc &  ) const

virtual

virtual float ProbDenFunc::normFac ( ) const

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, and Sampled1DProbDenFunc.

virtual int ProbDenFunc::nrDims ( ) const

pure virtual

Implemented in SampledNDProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, and ProbDenFunc1D.

virtual void ProbDenFunc::prepareRandDrawing ( ) const

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, GaussianNDProbDenFunc, and Sampled1DProbDenFunc.

virtual bool ProbDenFunc::readBulk ( od_istream &  , bool  binary  )

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, and Sampled1DProbDenFunc.

virtual void ProbDenFunc::scale ( float  )

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, and Sampled1DProbDenFunc.

virtual void ProbDenFunc::setDimName ( int  dim, const char *    )

pure virtual

Implemented in SampledNDProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, and ProbDenFunc1D.

static const char* ProbDenFunc::sKeyNrDim ( )

static

virtual bool ProbDenFunc::usePar ( const IOPar &  )

pure virtual

Implemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, Sampled1DProbDenFunc, GaussianNDProbDenFunc, Gaussian2DProbDenFunc, and Gaussian1DProbDenFunc.

virtual float ProbDenFunc::value ( const TypeSet< float > &  ) const

pure virtual

Implemented in SampledNDProbDenFunc, ProbDenFunc2D, GaussianNDProbDenFunc, and ProbDenFunc1D.

virtual void ProbDenFunc::writeBulk ( od_ostream &  , bool  binary  ) const

inlinevirtual

Reimplemented in SampledNDProbDenFunc, Sampled2DProbDenFunc, and Sampled1DProbDenFunc.