ProbDenFunc Class Reference

Base class for Probability Density Functions. More...

#include <probdenfunc.h>

Inheritance diagram for ProbDenFunc:

Public Member Functions
virtual	~ProbDenFunc ()
virtual float	averagePos (int dim) const =0
virtual bool	canScale () const
virtual ProbDenFunc *	clone () const =0
virtual void	copyFrom (const ProbDenFunc &)=0
const char *	dimName (int dim) const
virtual void	drawRandomPos (TypeSet< float > &) const =0
virtual void	fillPar (IOPar &) const =0
void	getIndexTableFor (const ProbDenFunc &pdf, TypeSet< int > &tbl) const
	tbl[0] tells what my index is for pdf's index '0'
virtual const char *	getTypeStr () const =0
const char *	getUOMSymbol (int dim) const
virtual bool	hasLimits () const =0
virtual bool	isCompatibleWith (const ProbDenFunc &) const
virtual bool	isEqual (const ProbDenFunc &) const
virtual float	normFac () const
virtual int	nrDims () const =0
virtual void	prepareRandDrawing () const
virtual bool	readBulk (od_istream &, bool binary)
virtual void	scale (float)
void	setDimName (int dim, const char *)
void	setUOMSymbol (int dim, const char *)
virtual float	stddevPos (int dim) const =0
virtual bool	usePar (const IOPar &)=0
virtual float	value (const TypeSet< float > &) const =0
virtual void	writeBulk (od_ostream &, bool binary) const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
const name_type &	name () const override
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

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, dim names and units

Private Attributes
BufferStringSet	dimnms_
BufferStringSet	uoms_

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Attributes inherited from NamedObject
BufferString	name_

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

~ProbDenFunc()

virtual ProbDenFunc::~ProbDenFunc ( )

virtual

ProbDenFunc() [1/2]

ProbDenFunc::ProbDenFunc ( )

protected

ProbDenFunc() [2/2]

ProbDenFunc::ProbDenFunc ( const ProbDenFunc & )

protected

Member Function Documentation

averagePos()

virtual float ProbDenFunc::averagePos ( int dim ) const

pure virtual

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

canScale()

virtual bool ProbDenFunc::canScale ( ) const

inlinevirtual

Reimplemented in Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

clone()

virtual ProbDenFunc * ProbDenFunc::clone ( ) const

pure virtual

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

copyFrom()

virtual void ProbDenFunc::copyFrom ( const ProbDenFunc & )

pure virtual

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

dimName()

const char * ProbDenFunc::dimName

(

int

dim

)

const

drawRandomPos()

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

pure virtual

Implemented in GaussianNDProbDenFunc, SampledNDProbDenFunc, ProbDenFunc1D, and ProbDenFunc2D.

fillPar()

virtual void ProbDenFunc::fillPar ( IOPar & ) const

pure virtual

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

getIndexTableFor()

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

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

getTypeStr()

virtual const char * ProbDenFunc::getTypeStr ( ) const

pure virtual

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

getUOMSymbol()

const char * ProbDenFunc::getUOMSymbol

(

int

dim

)

const

hasLimits()

virtual bool ProbDenFunc::hasLimits ( ) const

pure virtual

Implemented in GaussianNDProbDenFunc, ProbDenFunc1D, ProbDenFunc2D, and SampledNDProbDenFunc.

isCompatibleWith()

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

virtual

isEq()

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

protectedpure virtual

already checked for type, name, dim names and units

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

isEqual()

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

virtual

normFac()

virtual float ProbDenFunc::normFac ( ) const

inlinevirtual

Reimplemented in Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

nrDims()

virtual int ProbDenFunc::nrDims ( ) const

pure virtual

Implemented in GaussianNDProbDenFunc, ProbDenFunc1D, ProbDenFunc2D, and SampledNDProbDenFunc.

prepareRandDrawing()

virtual void ProbDenFunc::prepareRandDrawing ( ) const

inlinevirtual

Reimplemented in GaussianNDProbDenFunc, Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

readBulk()

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

inlinevirtual

Reimplemented in Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

scale()

virtual void ProbDenFunc::scale ( float )

inlinevirtual

Reimplemented in Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

setDimName()

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

setUOMSymbol()

void ProbDenFunc::setUOMSymbol	(	int	dim,
		const char *	)

sKeyNrDim()

static const char * ProbDenFunc::sKeyNrDim ( )

static

stddevPos()

virtual float ProbDenFunc::stddevPos ( int dim ) const

pure virtual

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

usePar()

virtual bool ProbDenFunc::usePar ( const IOPar & )

pure virtual

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

value()

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

pure virtual

Implemented in GaussianNDProbDenFunc, SampledNDProbDenFunc, ProbDenFunc1D, and ProbDenFunc2D.

writeBulk()

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

inlinevirtual

Reimplemented in Sampled1DProbDenFunc, Sampled2DProbDenFunc, and SampledNDProbDenFunc.

Member Data Documentation

dimnms_

BufferStringSet ProbDenFunc::dimnms_

private

uoms_

BufferStringSet ProbDenFunc::uoms_

private