Sampled1DProbDenFunc Class Reference

One dimensional PDF based on binned data. More...

Inheritance diagram for Sampled1DProbDenFunc:

Public Member Functions
	Sampled1DProbDenFunc (const Array1D< float > &)
	Sampled1DProbDenFunc (const char *vnm="")
	Sampled1DProbDenFunc (const float *, int)
	Sampled1DProbDenFunc (const Sampled1DProbDenFunc &)
	Sampled1DProbDenFunc (const TypeSet< float > &)
bool	canScale () const override
Sampled1DProbDenFunc *	clone () const override
void	copyFrom (const ProbDenFunc &) override
void	fillPar (IOPar &) const override
float	get (int idx) const
const char *	getTypeStr () const override
bool	isEq (const ProbDenFunc &oth) const override
	already checked for type, name, dim names and units More...
float	normFac () const override
Sampled1DProbDenFunc &	operator= (const Sampled1DProbDenFunc &)
void	prepareRandDrawing () const override
bool	readBulk (od_istream &, bool binary) override
SamplingData< float > &	sampling ()
const SamplingData< float > &	sampling () const
void	scale (float f) override
void	set (int idx, float val)
bool	usePar (const IOPar &) override
void	writeBulk (od_ostream &, bool binary) const override
Public Member Functions inherited from ProbDenFunc1D
float	averagePos (int) const override
void	drawRandomPos (float &v) const
void	drawRandomPos (TypeSet< float > &v) const override
bool	hasLimits () const override
int	nrDims () const override
float	stddevPos (int) const override
float	value (const TypeSet< float > &v) const override
float	value (float v) const
Public Member Functions inherited from ProbDenFunc
virtual	~ProbDenFunc ()
const char *	dimName (int dim) const
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	setDimName (int dim, const char *)
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 &)
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
Public Member Functions inherited from ArrayNDProbDenFunc
virtual	~ArrayNDProbDenFunc ()
void	fillPar (IOPar &) const
ArrayND< float > *	getArrClone () const
float	getAveragePos (int dim) const
ArrayND< float > &	getData ()
const ArrayND< float > &	getData () const
Interval< float >	getRange (int dim) const
ArrayNDProbDenFunc &	operator= (const ArrayNDProbDenFunc &)
bool	readBulkData (od_istream &, bool)
SamplingData< float > &	sampling (int dim)
const SamplingData< float > &	sampling (int dim) const
void	setRange (int dim, const StepInterval< float > &)
bool	setSize (const int *, int sz)
bool	setSize (const TypeSet< int > &)
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)

Private Member Functions
void	drwRandPos (float &) const override
const ArrayND< float > &	getArrND () const override
float	gtAvgPos () const override
float	gtStdDevPos () const override
float	gtVal (float) const override
bool	hasLims () const override

Private Attributes
Array1DImpl< float >	bins_

Additional Inherited Members
Public Types inherited from ObjectWithName
typedef OD::String	name_type
Protected Member Functions inherited from ProbDenFunc1D
	ProbDenFunc1D (const char *vnm="")
Protected Member Functions inherited from ProbDenFunc
	ProbDenFunc ()
	ProbDenFunc (const ProbDenFunc &)
Protected Member Functions inherited from ArrayNDProbDenFunc
	ArrayNDProbDenFunc (const ArrayNDProbDenFunc &)
	ArrayNDProbDenFunc (int nrdims)
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
int	nrDims_ () const
void	prepRndDrw () const
Protected Attributes inherited from NamedObject
BufferString	name_
Protected Attributes inherited from ArrayNDProbDenFunc
float *	cumbins_ = nullptr
Stats::RandomGenerator &	gen_

Detailed Description

One dimensional PDF based on binned data.

<>

Constructor & Destructor Documentation

Sampled1DProbDenFunc() [1/5]

Sampled1DProbDenFunc::Sampled1DProbDenFunc

(

const char *

vnm = ""

)

Sampled1DProbDenFunc() [2/5]

Sampled1DProbDenFunc::Sampled1DProbDenFunc

(

const Array1D< float > &

)

Sampled1DProbDenFunc() [3/5]

Sampled1DProbDenFunc::Sampled1DProbDenFunc

(

const TypeSet< float > &

)

Sampled1DProbDenFunc() [4/5]

Sampled1DProbDenFunc::Sampled1DProbDenFunc	(	const float *	,
		int
	)

Sampled1DProbDenFunc() [5/5]

Sampled1DProbDenFunc::Sampled1DProbDenFunc

(

const Sampled1DProbDenFunc &

)

Member Function Documentation

canScale()

bool Sampled1DProbDenFunc::canScale ( ) const

inlineoverridevirtual

Reimplemented from ProbDenFunc.

clone()

Sampled1DProbDenFunc* Sampled1DProbDenFunc::clone ( ) const

inlineoverridevirtual

Implements ProbDenFunc.

copyFrom()

void Sampled1DProbDenFunc::copyFrom ( const ProbDenFunc &  )

overridevirtual

Implements ProbDenFunc.

drwRandPos()

void Sampled1DProbDenFunc::drwRandPos ( float &  ) const

overrideprivatevirtual

Implements ProbDenFunc1D.

fillPar()

void Sampled1DProbDenFunc::fillPar ( IOPar &  ) const

overridevirtual

Implements ProbDenFunc.

get()

float Sampled1DProbDenFunc::get ( int  idx ) const

inline

getArrND()

const ArrayND<float>& Sampled1DProbDenFunc::getArrND ( ) const

inlineoverrideprivatevirtual

Implements ArrayNDProbDenFunc.

getTypeStr()

const char* Sampled1DProbDenFunc::getTypeStr ( ) const

inlineoverridevirtual

Implements ProbDenFunc.

gtAvgPos()

float Sampled1DProbDenFunc::gtAvgPos ( ) const

overrideprivatevirtual

Implements ProbDenFunc1D.

gtStdDevPos()

float Sampled1DProbDenFunc::gtStdDevPos ( ) const

inlineoverrideprivatevirtual

Implements ProbDenFunc1D.

gtVal()

float Sampled1DProbDenFunc::gtVal ( float  ) const

overrideprivatevirtual

Implements ProbDenFunc1D.

hasLims()

bool Sampled1DProbDenFunc::hasLims ( ) const

inlineoverrideprivatevirtual

Implements ProbDenFunc1D.

isEq()

bool Sampled1DProbDenFunc::isEq ( const ProbDenFunc &  ) const

inlineoverridevirtual

already checked for type, name, dim names and units

Implements ProbDenFunc.

normFac()

float Sampled1DProbDenFunc::normFac ( ) const

inlineoverridevirtual

Reimplemented from ProbDenFunc.

operator=()

Sampled1DProbDenFunc& Sampled1DProbDenFunc::operator=

(

const Sampled1DProbDenFunc &

)

prepareRandDrawing()

void Sampled1DProbDenFunc::prepareRandDrawing ( ) const

inlineoverridevirtual

Reimplemented from ProbDenFunc.

readBulk()

bool Sampled1DProbDenFunc::readBulk ( od_istream &  , bool  binary  )

overridevirtual

Reimplemented from ProbDenFunc.

sampling() [1/2]

SamplingData<float>& Sampled1DProbDenFunc::sampling

(

)

sampling() [2/2]

const SamplingData<float>& Sampled1DProbDenFunc::sampling

(

)

const

scale()

void Sampled1DProbDenFunc::scale ( float  f )

inlineoverridevirtual

Reimplemented from ProbDenFunc.

set()

void Sampled1DProbDenFunc::set ( int  idx, float  val  )

inline

typeStr()

static const char* Sampled1DProbDenFunc::typeStr ( )

inlinestatic

usePar()

bool Sampled1DProbDenFunc::usePar ( const IOPar &  )

overridevirtual

Implements ProbDenFunc.

writeBulk()

void Sampled1DProbDenFunc::writeBulk ( od_ostream &  , bool  binary  ) const

overridevirtual

Reimplemented from ProbDenFunc.

Member Data Documentation

bins_

Array1DImpl<float> Sampled1DProbDenFunc::bins_

private