SampledNDProbDenFunc Class Reference

Multi-dimensional PDF based on binned data. More...

Inheritance diagram for SampledNDProbDenFunc:

Public Member Functions
	SampledNDProbDenFunc ()
	SampledNDProbDenFunc (const ArrayND< float > &)
	SampledNDProbDenFunc (const SampledNDProbDenFunc &)
	SampledNDProbDenFunc (int nrdims)
virtual float	averagePos (int dim) const
virtual bool	canScale () const
virtual SampledNDProbDenFunc *	clone () const
virtual void	copyFrom (const ProbDenFunc &)
virtual const char *	dimName (int) const
virtual void	drawRandomPos (TypeSet< float > &) const
virtual void	fillPar (IOPar &) const
virtual ArrayND< float > *	getArrClone () const
virtual const char *	getTypeStr () const
virtual bool	isEq (const ProbDenFunc &oth) const
	already checked for type, name, dim names and units More...
virtual float	normFac () const
virtual int	nrDims () const
SampledNDProbDenFunc &	operator= (const SampledNDProbDenFunc &)
virtual void	prepareRandDrawing () const
virtual bool	readBulk (od_istream &, bool binary)
virtual void	scale (float f)
virtual void	setDimName (int dim, const char *nm)
virtual bool	usePar (const IOPar &)
virtual float	value (const TypeSet< float > &) const
virtual void	writeBulk (od_ostream &, bool binary) const
Public Member Functions inherited from ProbDenFunc
virtual	~ProbDenFunc ()
void	copyUOMFrom (const ProbDenFunc &)
void	getIndexTableFor (const ProbDenFunc &pdf, TypeSet< int > &tbl) const
	tbl[0] tells what my index is for pdf's index '0' More...
const char *	getUOMSymbol (int dim) const
virtual bool	isCompatibleWith (const ProbDenFunc &) const
virtual bool	isEqual (const ProbDenFunc &) const
void	readUOMFromPar (const IOPar &)
void	setUOMSymbol (int dim, const char *)
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 &)
virtual const name_type &	name () const
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
Public Member Functions inherited from ArrayNDProbDenFunc
virtual	~ArrayNDProbDenFunc ()
void	fillPar (IOPar &) const
float	getAveragePos (int dim) const
virtual ArrayND< float > &	getData ()
virtual const ArrayND< float > &	getData () const
ArrayNDProbDenFunc &	operator= (const ArrayNDProbDenFunc &)
bool	readBulkData (od_istream &, bool)
virtual SamplingData< float > &	sampling (int dim)
virtual SamplingData< float >	sampling (int dim) const
int	size (int dim) const
od_uint64	totalSize () const
bool	usePar (const IOPar &)
void	writeBulkData (od_ostream &, bool) const

Static Public Member Functions
static const char *	typeStr ()
Static Public Member Functions inherited from ProbDenFunc
static const char *	sKeyNrDim ()
Static Public Member Functions inherited from ArrayNDProbDenFunc
static float	findAveragePos (const float *, int, float grandtotal)

Public Attributes
ArrayNDImpl< float >	bins_
BufferStringSet	dimnms_
TypeSet< SamplingData< float > >	sds_

Protected Member Functions
virtual const ArrayND< float > &	getArrND () const
virtual const SamplingData< float > &	getSampling (int d) const
Protected Member Functions inherited from ProbDenFunc
	ProbDenFunc ()
	ProbDenFunc (const ProbDenFunc &)
void	cleanup ()
void	copyNameFrom (const ProbDenFunc &)
void	init ()
Protected Member Functions inherited from ArrayNDProbDenFunc
	ArrayNDProbDenFunc ()
	ArrayNDProbDenFunc (const ArrayNDProbDenFunc &oth)
virtual void	doScale (float)
void	fillCumBins () const
od_uint64	getBinPos (float) const
virtual float	getNormFac () const
od_uint64	getRandBin () const
virtual bool	gtIsEq (const ProbDenFunc &) const
void	prepRndDrw () const

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Attributes inherited from NamedObject
BufferString	name_
Protected Attributes inherited from ArrayNDProbDenFunc
TypeSet< float >	avgpos_
float *	cumbins_

Detailed Description

Multi-dimensional PDF based on binned data.

If the 'dimnms_' are not filled, 'Dim0', 'Dim1' ... etc. will be returned.

<>

Constructor & Destructor Documentation

SampledNDProbDenFunc() [1/4]

SampledNDProbDenFunc::SampledNDProbDenFunc

(

int

nrdims

)

SampledNDProbDenFunc() [2/4]

SampledNDProbDenFunc::SampledNDProbDenFunc

(

const ArrayND< float > &

)

SampledNDProbDenFunc() [3/4]

SampledNDProbDenFunc::SampledNDProbDenFunc

(

const SampledNDProbDenFunc &

)

SampledNDProbDenFunc() [4/4]

SampledNDProbDenFunc::SampledNDProbDenFunc

(

)

Member Function Documentation

averagePos()

virtual float SampledNDProbDenFunc::averagePos ( int  dim ) const

inlinevirtual

Implements ProbDenFunc.

canScale()

virtual bool SampledNDProbDenFunc::canScale ( ) const

inlinevirtual

Reimplemented from ProbDenFunc.

clone()

virtual SampledNDProbDenFunc* SampledNDProbDenFunc::clone ( ) const

inlinevirtual

Implements ProbDenFunc.

copyFrom()

virtual void SampledNDProbDenFunc::copyFrom ( const ProbDenFunc &  )

virtual

Implements ProbDenFunc.

dimName()

virtual const char* SampledNDProbDenFunc::dimName ( int  ) const

virtual

Implements ProbDenFunc.

drawRandomPos()

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

virtual

Implements ProbDenFunc.

fillPar()

virtual void SampledNDProbDenFunc::fillPar ( IOPar &  ) const

virtual

Implements ProbDenFunc.

getArrClone()

virtual ArrayND<float>* SampledNDProbDenFunc::getArrClone ( ) const

inlinevirtual

Implements ArrayNDProbDenFunc.

getArrND()

virtual const ArrayND<float>& SampledNDProbDenFunc::getArrND ( ) const

inlineprotectedvirtual

Implements ArrayNDProbDenFunc.

getSampling()

virtual const SamplingData<float>& SampledNDProbDenFunc::getSampling ( int  d ) const

inlineprotectedvirtual

Implements ArrayNDProbDenFunc.

getTypeStr()

virtual const char* SampledNDProbDenFunc::getTypeStr ( ) const

inlinevirtual

Implements ProbDenFunc.

isEq()

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

inlinevirtual

already checked for type, name, dim names and units

Implements ProbDenFunc.

normFac()

virtual float SampledNDProbDenFunc::normFac ( ) const

inlinevirtual

Reimplemented from ProbDenFunc.

nrDims()

virtual int SampledNDProbDenFunc::nrDims ( ) const

inlinevirtual

Implements ProbDenFunc.

operator=()

SampledNDProbDenFunc& SampledNDProbDenFunc::operator=

(

const SampledNDProbDenFunc &

)

prepareRandDrawing()

virtual void SampledNDProbDenFunc::prepareRandDrawing ( ) const

inlinevirtual

Reimplemented from ProbDenFunc.

readBulk()

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

virtual

Reimplemented from ProbDenFunc.

scale()

virtual void SampledNDProbDenFunc::scale ( float  f )

inlinevirtual

Reimplemented from ProbDenFunc.

setDimName()

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

inlinevirtual

Implements ProbDenFunc.

typeStr()

static const char* SampledNDProbDenFunc::typeStr ( )

inlinestatic

usePar()

virtual bool SampledNDProbDenFunc::usePar ( const IOPar &  )

virtual

Implements ProbDenFunc.

value()

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

virtual

Implements ProbDenFunc.

writeBulk()

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

virtual

Reimplemented from ProbDenFunc.

Member Data Documentation

bins_

ArrayNDImpl<float> SampledNDProbDenFunc::bins_

dimnms_

BufferStringSet SampledNDProbDenFunc::dimnms_

sds_

TypeSet< SamplingData<float> > SampledNDProbDenFunc::sds_