Class for defining the abstract interface for PDF classes. More...

#include <LauAbsPdf.hh>

Inheritance diagram for LauAbsPdf:

Public Types
enum	IntMethod { GaussLegendre, Trapezoid }
	The possible numerical intergration methods. More...

typedef std::vector< Double_t >	LauAbscissas
	The type used for containing multiple abscissa values.

Public Member Functions
	LauAbsPdf (const TString &theVarName, const std::vector< LauAbsRValue * > &params, Double_t minAbscissa, Double_t maxAbscissa)
	Constructor for a 1D PDF. More...

	LauAbsPdf (const std::vector< TString > &theVarNames, const std::vector< LauAbsRValue * > &params, const LauFitData &minAbscissas, const LauFitData &maxAbscissas)
	Constructor for a multidimensional PDF. More...

virtual	~LauAbsPdf ()
	Destructor.

virtual const TString &	varName () const
	Retrieve the name of the abscissa. More...

virtual std::vector< TString >	varNames () const
	Retrieve the names of the abscissas. More...

virtual UInt_t	nParameters () const
	Retrieve the number of PDF parameters. More...

virtual UInt_t	nFixedParameters () const
	Retrieve the number of fixed PDF parameters. More...

virtual UInt_t	nInputVars () const
	Retrieve the number of abscissas. More...

virtual Bool_t	isDPDependent () const
	Specifies whether or not the PDF is DP dependent. More...

virtual Double_t	getMinAbscissa () const
	Retrieve the minimum value of the (primary) abscissa. More...

virtual Double_t	getMaxAbscissa () const
	Retrieve the maximum value of the (primary) abscissa. More...

virtual Double_t	getRange () const
	Retrieve the range of the (primary) abscissa. More...

virtual Double_t	getMinAbscissa (const TString &theVarName) const
	Retrieve the minimum value of the specified abscissa. More...

virtual Double_t	getMaxAbscissa (const TString &theVarName) const
	Retrieve the maximum value of the specified abscissa. More...

virtual Double_t	getRange (const TString &theVarName) const
	Retrieve the range of the specified abscissa. More...

virtual LauFitData	getMinAbscissas () const
	Retrieve the minimum values of all the abscissas. More...

virtual LauFitData	getMaxAbscissas () const
	Retrieve the maximum values of all the abscissas. More...

virtual LauFitData	getRanges () const
	Retrieve the ranges of all the abscissas. More...

virtual void	updatePulls ()
	Update the pulls for all parameters.

virtual void	cacheInfo (const LauFitDataTree &inputData)
	Cache information from data. More...

virtual void	calcLikelihoodInfo (const LauAbscissas &abscissas)=0
	Calculate the likelihood (and all associated information) given value(s) of the abscissa(s) More...

virtual void	calcLikelihoodInfo (UInt_t iEvt)
	Retrieve the likelihood (and all associated information) given the event number. More...

virtual Double_t	getUnNormLikelihood () const
	Retrieve the unnormalised likelihood value. More...

virtual Double_t	getNorm () const
	Retrieve the normalisation factor. More...

virtual Double_t	getLikelihood () const
	Retrieve the normalised likelihood value. More...

virtual Double_t	getLikelihood (const TString &theVarName) const
	For multidimentional PDFs, retrieve the normalised likelihood value of a named variable. More...

virtual Double_t	getMaxHeight () const
	Retrieve the maximum height. More...

virtual LauFitData	generate (const LauKinematics *kinematics)
	Generate an event from the PDF. More...

virtual void	setRandomFun (TRandom *randomFun)
	Set the random function used for toy MC generation. More...

virtual const std::vector< LauAbsRValue * > &	getParameters () const
	Retrieve the parameters of the PDF, e.g. so that they can be loaded into a fit. More...

virtual std::vector< LauAbsRValue * > &	getParameters ()
	Retrieve the parameters of the PDF, e.g. so that they can be loaded into a fit. More...

virtual void	calcNorm ()
	Calculate the normalisation factor of the PDF. More...

virtual void	calcPDFHeight (const LauKinematics *kinematics)=0
	Calculate the maximum height of the PDF. More...

virtual Bool_t	heightUpToDate () const
	Check if the maximum height of the PDF is up to date. More...

virtual void	heightUpToDate (Bool_t hutd)
	Set whether the height is up to date. More...

virtual Bool_t	cachePDF () const
	Check if the PDF is to be cached. More...

virtual Int_t	nNormPoints () const
	Retrieve the number of points to integrate over when normalising. More...

virtual void	nNormPoints (Int_t nPoints)
	Set the number of points to integrate over when normalising. More...

virtual IntMethod	integMethod () const
	Retrieve the integration method used to normalise the PDF. More...

virtual void	integMethod (IntMethod method)
	Set the integration method used to normalise the PDF. More...

Protected Member Functions
virtual void	cachePDF (Bool_t doCachePDF)
	Set whether the PDF is to be cached. More...

virtual Double_t	integrGaussLegendre ()
	Integrate the PDF using the Gauss-Legendre method. More...

virtual Double_t	integTrapezoid ()
	Integrate the PDF using the simple trapezoid method. More...

virtual void	setNorm (Double_t norm)
	Set the normalisation factor. More...

virtual void	setMaxHeight (Double_t maxHeight)
	Set the maximum height. More...

virtual void	setMinAbscissa (const TString &theVarName, Double_t minAbscissa)
	Set the minimum value of the specified abscissa. More...

virtual void	setMaxAbscissa (const TString &theVarName, Double_t maxAbscissa)
	Set the maximum value of the specified abscissa. More...

virtual void	setRange (const TString &theVarName, Double_t minAbscissa, Double_t maxAbscissa)
	Set the range of the specified abscissa. More...

virtual Bool_t	checkRange (const LauAbscissas &abscissas) const
	Check that all abscissas are within their allowed ranges. More...

virtual void	setUnNormPDFVal (Double_t unNormPDFVal)
	Set the unnormalised likelihood.

virtual LauAbsRValue *	findParameter (const TString &parName)
	Retrieve the specified parameter. More...

virtual const LauAbsRValue *	findParameter (const TString &parName) const
	Retrieve the specified parameter. More...

virtual TRandom *	getRandomFun () const
	Retrieve the random function used for MC generation. More...

virtual std::vector< LauAbscissas > &	getAbscissas ()
	Retrieve the abscissa(s) More...

virtual const std::vector< LauAbscissas > &	getAbscissas () const
	Retrieve the abscissa(s) More...

virtual std::vector< Double_t > &	getUnNormPDFValues ()
	Retrieve the cached unnormalised likelihood values. More...

virtual const std::vector< Double_t > &	getUnNormPDFValues () const
	Retrieve the cached unnormalised likelihood values. More...

virtual void	addParameters (std::vector< LauAbsRValue * > &params)
	Add parameters to the PDF. More...

virtual Bool_t	withinNormCalc () const
	Check whether the calcNorm method is running. More...

virtual void	withinNormCalc (Bool_t yorn)
	Set flag to track whether the calcNorm method is running. More...

virtual Bool_t	withinGeneration () const
	Check whether the generate method is running. More...

virtual void	withinGeneration (Bool_t yorn)
	Set flag to track whether the generate method is running. More...

virtual Bool_t	normWeightsDone () const
	Check whether the normalisation weights have been calculated. More...

virtual void	normWeightsDone (Bool_t yorn)
	Set whether the normalisation weights have been calculated. More...

virtual void	getNormWeights ()
	Calculate the weights and abscissas used for normalisation.

virtual const std::vector< LauAbscissas > &	normAbscissas () const
	Retrieve the abscissa points used for normalisation. More...

virtual const std::vector< Double_t > &	normWeights () const
	Retrieve the weights used for normalisation. More...

Private Member Functions
	LauAbsPdf (const LauAbsPdf &rhs)
	Copy constructor (not implemented)

LauAbsPdf &	operator= (const LauAbsPdf &rhs)
	Copy assignment operator (not implemented)

Private Attributes
std::map< UInt_t, TString >	varNames_
	The names of the PDF variables.

std::vector< LauAbsRValue * >	param_
	The parameters of the PDF (if any)

Double_t	norm_
	Normalisation factor of the PDF.

Double_t	maxHeight_
	Maximum height of the PDF.

Bool_t	heightUpToDate_
	Track whether the height is up to date.

LauAbscissas	minAbscissas_
	The minimum value(s) of the abscissa(s)

LauAbscissas	maxAbscissas_
	The maximum value(s) of the abscissa(s)

TRandom *	randomFun_
	The random function used for MC generation.

std::vector< LauAbscissas >	abscissas_
	Cached values of the abscissas.

std::vector< Double_t >	unNormPDFValues_
	Cached unnormalised likelihood values.

Bool_t	cachePDF_
	Whether the unnormalised PDF values are cached. More...

Double_t	unNormPDFVal_
	The unnormalised liklihood value.

Int_t	nNormPoints_
	number of points to integrate over when normalising

IntMethod	integMethod_
	The integration method used for normalising the PDF.

Bool_t	withinNormCalc_
	Flag to keep track of whether the calcNorm method is running.

Bool_t	withinGeneration_
	Flag to keep track of whether the generate method is running.

Bool_t	normWeightsDone_
	Whether the normalisation weights have been calculated.

std::vector< LauAbscissas >	normAbscissas_
	The normalisation abscissas.

std::vector< Double_t >	normWeights_
	The normalisation weights.

Detailed Description

Class for defining the abstract interface for PDF classes.

Class for defining the abstract interface for PDF classes. Much common code is implemented but the following three methods are not: evaluatePDF, calcNorm, calcPDFHeight

Definition at line 54 of file LauAbsPdf.hh.

Member Enumeration Documentation

◆ IntMethod

enum LauAbsPdf::IntMethod

The possible numerical intergration methods.

Enumerator
GaussLegendre	Gauss-Legendre integration
Trapezoid	Simple trapezoid integration

Definition at line 61 of file LauAbsPdf.hh.

Constructor & Destructor Documentation

◆ LauAbsPdf() [1/2]

LauAbsPdf::LauAbsPdf	(	const TString &	theVarName,
		const std::vector< LauAbsRValue * > &	params,
		Double_t	minAbscissa,
		Double_t	maxAbscissa
	)

Constructor for a 1D PDF.

Parameters

[in]	theVarName	the name of the abscissa variable
[in]	params	the parameters of the PDF
[in]	minAbscissa	the minimum value of the abscissa
[in]	maxAbscissa	the maximum value of the abscissa

Definition at line 43 of file LauAbsPdf.cc.

◆ LauAbsPdf() [2/2]

LauAbsPdf::LauAbsPdf	(	const std::vector< TString > &	theVarNames,
		const std::vector< LauAbsRValue * > &	params,
		const LauFitData &	minAbscissas,
		const LauFitData &	maxAbscissas
	)

Constructor for a multidimensional PDF.

Parameters

[in]	theVarNames	the names of the abscissa variables
[in]	params	the parameters of the PDF
[in]	minAbscissas	the minimum values of the abscissas
[in]	maxAbscissas	the maximum values of the abscissas

Definition at line 71 of file LauAbsPdf.cc.

Member Function Documentation

◆ addParameters()

void LauAbsPdf::addParameters ( std::vector< LauAbsRValue * > & params )

protectedvirtual

Add parameters to the PDF.

Parameters

[in] params the parameters to add

Definition at line 478 of file LauAbsPdf.cc.

◆ cacheInfo()

void LauAbsPdf::cacheInfo ( const LauFitDataTree & inputData )

virtual

Cache information from data.

Will cache, for every event, the abscissa values and, if all parameters are fixed, the PDF value.

Parameters

[in] inputData the data to be used to calculate everything

Reimplemented in LauDPDepSumPdf, LauDPDepMapPdf, Lau2DHistPdf, and LauSumPdf.

Definition at line 275 of file LauAbsPdf.cc.

◆ cachePDF() [1/2]

virtual Bool_t LauAbsPdf::cachePDF ( ) const

inlinevirtual

Check if the PDF is to be cached.

Returns: true if the PDF is to be cached

Definition at line 299 of file LauAbsPdf.hh.

◆ cachePDF() [2/2]

virtual void LauAbsPdf::cachePDF ( Bool_t doCachePDF )

inlineprotectedvirtual

Set whether the PDF is to be cached.

Parameters

[in] doCachePDF whether the PDF is to be cached

Definition at line 330 of file LauAbsPdf.hh.

◆ calcLikelihoodInfo() [1/2]

virtual void LauAbsPdf::calcLikelihoodInfo ( const LauAbscissas & abscissas )

pure virtual

Calculate the likelihood (and all associated information) given value(s) of the abscissa(s)

Parameters

[in] abscissas the value(s) of the abscissa(s)

Implemented in LauDPDepSumPdf, LauDPDepMapPdf, LauDPDepBifurGaussPdf, LauDPDepCruijffPdf, LauCruijffPdf, Lau2DHistPdf, LauDPDepGaussPdf, LauParametricStepFuncPdf, LauChebychevPdf, LauCrystalBallPdf, LauSumPdf, LauSigmoidPdf, Lau1DHistPdf, LauExponentialPdf, LauArgusPdf, LauBifurcatedGaussPdf, LauGaussPdf, LauNovosibirskPdf, and LauLinearPdf.

◆ calcLikelihoodInfo() [2/2]

void LauAbsPdf::calcLikelihoodInfo ( UInt_t iEvt )

virtual

Retrieve the likelihood (and all associated information) given the event number.

Parameters

[in] iEvt the event number

Reimplemented in LauDPDepSumPdf, LauDPDepMapPdf, Lau2DHistPdf, and LauSumPdf.

Definition at line 422 of file LauAbsPdf.cc.

◆ calcNorm()

void LauAbsPdf::calcNorm ( )

virtual

Calculate the normalisation factor of the PDF.

By default uses numerical integration. PDFs with analytical integrals should override this method.

Reimplemented in LauDPDepSumPdf, LauDPDepMapPdf, Lau2DHistPdf, LauDPDepBifurGaussPdf, LauDPDepCruijffPdf, LauDPDepGaussPdf, LauParametricStepFuncPdf, LauSumPdf, LauChebychevPdf, LauCrystalBallPdf, LauSigmoidPdf, Lau1DHistPdf, LauExponentialPdf, LauArgusPdf, LauBifurcatedGaussPdf, LauGaussPdf, and LauLinearPdf.

Definition at line 485 of file LauAbsPdf.cc.

◆ calcPDFHeight()

virtual void LauAbsPdf::calcPDFHeight ( const LauKinematics * kinematics )

pure virtual

Calculate the maximum height of the PDF.

Parameters

[in] kinematics used by some PDFs to determine the DP position, on which they have dependence

Implemented in LauDPDepSumPdf, LauDPDepMapPdf, Lau2DHistPdf, LauDPDepBifurGaussPdf, LauDPDepCruijffPdf, LauCruijffPdf, LauDPDepGaussPdf, LauParametricStepFuncPdf, LauSumPdf, LauChebychevPdf, LauCrystalBallPdf, LauSigmoidPdf, Lau1DHistPdf, LauExponentialPdf, LauArgusPdf, LauBifurcatedGaussPdf, LauGaussPdf, LauLinearPdf, and LauNovosibirskPdf.

◆ checkRange()

Bool_t LauAbsPdf::checkRange ( const LauAbscissas & abscissas ) const

protectedvirtual

Check that all abscissas are within their allowed ranges.

Parameters

[in] abscissas the value(s) of the abscissa(s)

Returns: true if all abscissas are within their allowed ranges

Definition at line 243 of file LauAbsPdf.cc.

◆ findParameter() [1/2]

LauAbsRValue * LauAbsPdf::findParameter ( const TString & parName )

protectedvirtual

Retrieve the specified parameter.

Parameters

[in] parName the parameter to retrieve

Definition at line 431 of file LauAbsPdf.cc.

◆ findParameter() [2/2]

const LauAbsRValue * LauAbsPdf::findParameter ( const TString & parName ) const

protectedvirtual

Retrieve the specified parameter.

Parameters

[in] parName the parameter to retrieve

Definition at line 447 of file LauAbsPdf.cc.

◆ generate()

LauFitData LauAbsPdf::generate ( const LauKinematics * kinematics )

virtual

Generate an event from the PDF.

Parameters

[in] kinematics used by some PDFs to determine the DP position, on which they have dependence

Reimplemented in Lau2DHistPdf.

Definition at line 338 of file LauAbsPdf.cc.

◆ getAbscissas() [1/2]

virtual std::vector<LauAbscissas>& LauAbsPdf::getAbscissas ( )

inlineprotectedvirtual

Retrieve the abscissa(s)

Returns: the abscissa(s)

Definition at line 418 of file LauAbsPdf.hh.

◆ getAbscissas() [2/2]

virtual const std::vector<LauAbscissas>& LauAbsPdf::getAbscissas ( ) const

inlineprotectedvirtual

Retrieve the abscissa(s)

Returns: the abscissa(s)

Definition at line 424 of file LauAbsPdf.hh.

◆ getLikelihood() [1/2]

Double_t LauAbsPdf::getLikelihood ( ) const

virtual

Retrieve the normalised likelihood value.

Returns: the normalised likelihood value

Definition at line 403 of file LauAbsPdf.cc.

◆ getLikelihood() [2/2]

Double_t LauAbsPdf::getLikelihood ( const TString & theVarName ) const

virtual

For multidimentional PDFs, retrieve the normalised likelihood value of a named variable.

Defaults to simply returning the complete likelihood. Should be overridden by multidimensional PDFs.

Returns: the normalised likelihood value of the named variable

Reimplemented in Lau2DHistPdf.

Definition at line 412 of file LauAbsPdf.cc.

◆ getMaxAbscissa() [1/2]

virtual Double_t LauAbsPdf::getMaxAbscissa ( ) const

inlinevirtual

Retrieve the maximum value of the (primary) abscissa.

Returns: the maximum value of the (primary) abscissa

Definition at line 141 of file LauAbsPdf.hh.

◆ getMaxAbscissa() [2/2]

Double_t LauAbsPdf::getMaxAbscissa ( const TString & theVarName ) const

virtual

Retrieve the maximum value of the specified abscissa.

Parameters

[in] theVarName the name of the abscissa

Returns: the maximum value of the specified abscissa

Definition at line 155 of file LauAbsPdf.cc.

◆ getMaxAbscissas()

LauFitData LauAbsPdf::getMaxAbscissas ( ) const

virtual

Retrieve the maximum values of all the abscissas.

Returns: the maximum values of the abscissas

Definition at line 183 of file LauAbsPdf.cc.

◆ getMaxHeight()

virtual Double_t LauAbsPdf::getMaxHeight ( ) const

inlinevirtual

Retrieve the maximum height.

Returns: the maximum height

Definition at line 244 of file LauAbsPdf.hh.

◆ getMinAbscissa() [1/2]

virtual Double_t LauAbsPdf::getMinAbscissa ( ) const

inlinevirtual

Retrieve the minimum value of the (primary) abscissa.

Returns: the minimum value of the (primary) abscissa

Definition at line 135 of file LauAbsPdf.hh.

◆ getMinAbscissa() [2/2]

Double_t LauAbsPdf::getMinAbscissa ( const TString & theVarName ) const

virtual

Retrieve the minimum value of the specified abscissa.

Parameters

[in] theVarName the name of the abscissa

Returns: the minimum value of the specified abscissa

Definition at line 139 of file LauAbsPdf.cc.

◆ getMinAbscissas()

LauFitData LauAbsPdf::getMinAbscissas ( ) const

virtual

Retrieve the minimum values of all the abscissas.

Returns: the minimum values of the abscissas

Definition at line 171 of file LauAbsPdf.cc.

◆ getNorm()

virtual Double_t LauAbsPdf::getNorm ( ) const

inlinevirtual

Retrieve the normalisation factor.

Returns: the normalisation factor

Definition at line 224 of file LauAbsPdf.hh.

◆ getParameters() [1/2]

virtual std::vector<LauAbsRValue*>& LauAbsPdf::getParameters ( )

inlinevirtual

Retrieve the parameters of the PDF, e.g. so that they can be loaded into a fit.

Returns: the parameters of the PDF

Definition at line 268 of file LauAbsPdf.hh.

◆ getParameters() [2/2]

virtual const std::vector<LauAbsRValue*>& LauAbsPdf::getParameters ( ) const

inlinevirtual

Retrieve the parameters of the PDF, e.g. so that they can be loaded into a fit.

Returns: the parameters of the PDF

Definition at line 262 of file LauAbsPdf.hh.

◆ getRandomFun()

virtual TRandom* LauAbsPdf::getRandomFun ( ) const

inlineprotectedvirtual

Retrieve the random function used for MC generation.

Returns: the random function used for MC generation

Definition at line 412 of file LauAbsPdf.hh.

◆ getRange() [1/2]

virtual Double_t LauAbsPdf::getRange ( ) const

inlinevirtual

Retrieve the range of the (primary) abscissa.

Returns: the range of the (primary) abscissa

Definition at line 147 of file LauAbsPdf.hh.

◆ getRange() [2/2]

virtual Double_t LauAbsPdf::getRange ( const TString & theVarName ) const

inlinevirtual

Retrieve the range of the specified abscissa.

Parameters

[in] theVarName the name of the abscissa

Returns: the range of the specified abscissa

Definition at line 168 of file LauAbsPdf.hh.

◆ getRanges()

LauFitData LauAbsPdf::getRanges ( ) const

virtual

Retrieve the ranges of all the abscissas.

Returns: the ranges of the abscissas

Definition at line 195 of file LauAbsPdf.cc.

◆ getUnNormLikelihood()

virtual Double_t LauAbsPdf::getUnNormLikelihood ( ) const

inlinevirtual

Retrieve the unnormalised likelihood value.

Returns: the unnormalised likelihood value

Definition at line 218 of file LauAbsPdf.hh.

◆ getUnNormPDFValues() [1/2]

virtual std::vector<Double_t>& LauAbsPdf::getUnNormPDFValues ( )

inlineprotectedvirtual

Retrieve the cached unnormalised likelihood values.

Returns: the cached unnormalised likelihood values

Definition at line 430 of file LauAbsPdf.hh.

◆ getUnNormPDFValues() [2/2]

virtual const std::vector<Double_t>& LauAbsPdf::getUnNormPDFValues ( ) const

inlineprotectedvirtual

Retrieve the cached unnormalised likelihood values.

Returns: the cached unnormalised likelihood values

Definition at line 436 of file LauAbsPdf.hh.

◆ heightUpToDate() [1/2]

virtual Bool_t LauAbsPdf::heightUpToDate ( ) const

inlinevirtual

Check if the maximum height of the PDF is up to date.

Returns: true if the maximum height is up to date

Definition at line 287 of file LauAbsPdf.hh.

◆ heightUpToDate() [2/2]

virtual void LauAbsPdf::heightUpToDate ( Bool_t hutd )

inlinevirtual

Set whether the height is up to date.

Parameters

[in] hutd whether the height is up to date

Definition at line 293 of file LauAbsPdf.hh.

◆ integMethod() [1/2]

virtual IntMethod LauAbsPdf::integMethod ( ) const

inlinevirtual

Retrieve the integration method used to normalise the PDF.

Returns: the integration method used to normalise the PDF

Definition at line 317 of file LauAbsPdf.hh.

◆ integMethod() [2/2]

virtual void LauAbsPdf::integMethod ( IntMethod method )

inlinevirtual

Set the integration method used to normalise the PDF.

Parameters

[in] method the integration method to be used

Definition at line 323 of file LauAbsPdf.hh.

◆ integrGaussLegendre()

Double_t LauAbsPdf::integrGaussLegendre ( )

protectedvirtual

Integrate the PDF using the Gauss-Legendre method.

Returns: the integral of the PDF

Reimplemented in LauDPDepCruijffPdf.

Definition at line 505 of file LauAbsPdf.cc.

◆ integTrapezoid()

Double_t LauAbsPdf::integTrapezoid ( )

protectedvirtual

Integrate the PDF using the simple trapezoid method.

Returns: the integral of the PDF

Reimplemented in LauDPDepCruijffPdf.

Definition at line 579 of file LauAbsPdf.cc.

◆ isDPDependent()

virtual Bool_t LauAbsPdf::isDPDependent ( ) const

inlinevirtual

Specifies whether or not the PDF is DP dependent.

DP-dependent PDFs should override this method.

Returns: true if the PDF is DP-dependent, false otherwise (the default)

Reimplemented in LauDPDepSumPdf, LauDPDepMapPdf, LauDPDepBifurGaussPdf, LauDPDepCruijffPdf, LauDPDepGaussPdf, and LauSumPdf.

Definition at line 129 of file LauAbsPdf.hh.

◆ nFixedParameters()

UInt_t LauAbsPdf::nFixedParameters ( ) const

virtual

Retrieve the number of fixed PDF parameters.

Returns: the number of fixed PDF parameters

Definition at line 133 of file LauAbsPdf.cc.

◆ nInputVars()

virtual UInt_t LauAbsPdf::nInputVars ( ) const

inlinevirtual

Retrieve the number of abscissas.

Returns: the number of abscissas

Reimplemented in LauSumPdf.

Definition at line 121 of file LauAbsPdf.hh.

◆ nNormPoints() [1/2]

virtual Int_t LauAbsPdf::nNormPoints ( ) const

inlinevirtual

Retrieve the number of points to integrate over when normalising.

Returns: the number of points to integrate over when normalising

Definition at line 305 of file LauAbsPdf.hh.

◆ nNormPoints() [2/2]

virtual void LauAbsPdf::nNormPoints ( Int_t nPoints )

inlinevirtual

Set the number of points to integrate over when normalising.

Parameters

[in] nPoints the number of points

Definition at line 311 of file LauAbsPdf.hh.

◆ normAbscissas()

virtual const std::vector<LauAbscissas>& LauAbsPdf::normAbscissas ( ) const

inlineprotectedvirtual

Retrieve the abscissa points used for normalisation.

Returns: the abscissa points used for normalisation

Definition at line 487 of file LauAbsPdf.hh.

◆ normWeights()

virtual const std::vector<Double_t>& LauAbsPdf::normWeights ( ) const

inlineprotectedvirtual

Retrieve the weights used for normalisation.

Returns: the weights used for normalisation

Definition at line 493 of file LauAbsPdf.hh.

◆ normWeightsDone() [1/2]

virtual Bool_t LauAbsPdf::normWeightsDone ( ) const

inlineprotectedvirtual

Check whether the normalisation weights have been calculated.

Returns: true if the normalisation weights have been calculated

Definition at line 472 of file LauAbsPdf.hh.

◆ normWeightsDone() [2/2]

virtual void LauAbsPdf::normWeightsDone ( Bool_t yorn )

inlineprotectedvirtual

Set whether the normalisation weights have been calculated.

Parameters

[in] yorn whether the normalisation weights have been calculated

Definition at line 478 of file LauAbsPdf.hh.

◆ nParameters()

virtual UInt_t LauAbsPdf::nParameters ( ) const

inlinevirtual

Retrieve the number of PDF parameters.

Returns: the number of PDF parameters

Definition at line 109 of file LauAbsPdf.hh.

◆ setMaxAbscissa()

void LauAbsPdf::setMaxAbscissa	(	const TString &	theVarName,
		Double_t	maxAbscissa
	)

protectedvirtual

Set the maximum value of the specified abscissa.

Parameters

[in]	theVarName	the name of the abscissa
[in]	maxAbscissa	value to set as maximum

Definition at line 227 of file LauAbsPdf.cc.

◆ setMaxHeight()

virtual void LauAbsPdf::setMaxHeight ( Double_t maxHeight )

inlineprotectedvirtual

Set the maximum height.

Parameters

[in] maxHeight the new maximum height

Definition at line 354 of file LauAbsPdf.hh.

◆ setMinAbscissa()

void LauAbsPdf::setMinAbscissa	(	const TString &	theVarName,
		Double_t	minAbscissa
	)

protectedvirtual

Set the minimum value of the specified abscissa.

Parameters

[in]	theVarName	the name of the abscissa
[in]	minAbscissa	value to set as minimum

Definition at line 211 of file LauAbsPdf.cc.

◆ setNorm()

virtual void LauAbsPdf::setNorm ( Double_t norm )

inlineprotectedvirtual

Set the normalisation factor.

Parameters

[in] norm the normalisation factor

Definition at line 348 of file LauAbsPdf.hh.

◆ setRandomFun()

virtual void LauAbsPdf::setRandomFun ( TRandom * randomFun )

inlinevirtual

Set the random function used for toy MC generation.

Parameters

[in] randomFun the random function to be used

Definition at line 256 of file LauAbsPdf.hh.

◆ setRange()

virtual void LauAbsPdf::setRange	(	const TString &	theVarName,
		Double_t	minAbscissa,
		Double_t	maxAbscissa
	)

inlineprotectedvirtual

Set the range of the specified abscissa.

Parameters

[in]	theVarName	the name of the abscissa
[in]	minAbscissa	value to set as minimum
[in]	maxAbscissa	value to set as maximum

Definition at line 380 of file LauAbsPdf.hh.

◆ varName()

virtual const TString& LauAbsPdf::varName ( ) const

inlinevirtual

Retrieve the name of the abscissa.

Returns: the abscissa's name

Definition at line 97 of file LauAbsPdf.hh.

◆ varNames()

std::vector< TString > LauAbsPdf::varNames ( ) const

virtual

Retrieve the names of the abscissas.

Returns: the abscissas' names

Definition at line 122 of file LauAbsPdf.cc.

◆ withinGeneration() [1/2]

virtual Bool_t LauAbsPdf::withinGeneration ( ) const

inlineprotectedvirtual

Check whether the generate method is running.

Returns: true if the generate method is running

Definition at line 460 of file LauAbsPdf.hh.

◆ withinGeneration() [2/2]

virtual void LauAbsPdf::withinGeneration ( Bool_t yorn )

inlineprotectedvirtual

Set flag to track whether the generate method is running.

Parameters

[in] yorn whether the generate method is running

Definition at line 466 of file LauAbsPdf.hh.

◆ withinNormCalc() [1/2]

virtual Bool_t LauAbsPdf::withinNormCalc ( ) const

inlineprotectedvirtual

Check whether the calcNorm method is running.

Returns: true if the calcNorm method is running

Definition at line 448 of file LauAbsPdf.hh.

◆ withinNormCalc() [2/2]

virtual void LauAbsPdf::withinNormCalc ( Bool_t yorn )

inlineprotectedvirtual

Set flag to track whether the calcNorm method is running.

Parameters

[in] yorn whether the calcNorm method is running

Definition at line 454 of file LauAbsPdf.hh.

Member Data Documentation

◆ cachePDF_

Bool_t LauAbsPdf::cachePDF_

private

Whether the unnormalised PDF values are cached.

They are only cached if all parameters are fixed.

Definition at line 534 of file LauAbsPdf.hh.

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

/home/epp/phsdba/Development/Laura++/master-dev/laura/inc/LauAbsPdf.hh
/home/epp/phsdba/Development/Laura++/master-dev/laura/src/LauAbsPdf.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ IntMethod

Constructor & Destructor Documentation

◆ LauAbsPdf() [1/2]

◆ LauAbsPdf() [2/2]

Member Function Documentation

◆ addParameters()

◆ cacheInfo()

◆ cachePDF() [1/2]

◆ cachePDF() [2/2]

◆ calcLikelihoodInfo() [1/2]

◆ calcLikelihoodInfo() [2/2]

◆ calcNorm()

◆ calcPDFHeight()

◆ checkRange()

◆ findParameter() [1/2]

◆ findParameter() [2/2]

◆ generate()

◆ getAbscissas() [1/2]

◆ getAbscissas() [2/2]

◆ getLikelihood() [1/2]

◆ getLikelihood() [2/2]

◆ getMaxAbscissa() [1/2]

◆ getMaxAbscissa() [2/2]

◆ getMaxAbscissas()

◆ getMaxHeight()

◆ getMinAbscissa() [1/2]

◆ getMinAbscissa() [2/2]

◆ getMinAbscissas()

◆ getNorm()

◆ getParameters() [1/2]

◆ getParameters() [2/2]

◆ getRandomFun()

◆ getRange() [1/2]

◆ getRange() [2/2]

◆ getRanges()

◆ getUnNormLikelihood()

◆ getUnNormPDFValues() [1/2]

◆ getUnNormPDFValues() [2/2]

◆ heightUpToDate() [1/2]

◆ heightUpToDate() [2/2]

◆ integMethod() [1/2]

◆ integMethod() [2/2]

◆ integrGaussLegendre()

◆ integTrapezoid()

◆ isDPDependent()

◆ nFixedParameters()

◆ nInputVars()

◆ nNormPoints() [1/2]

◆ nNormPoints() [2/2]

◆ normAbscissas()

◆ normWeights()

◆ normWeightsDone() [1/2]

◆ normWeightsDone() [2/2]

◆ nParameters()

◆ setMaxAbscissa()

◆ setMaxHeight()

◆ setMinAbscissa()

◆ setNorm()

◆ setRandomFun()

◆ setRange()

◆ varName()

◆ varNames()

◆ withinGeneration() [1/2]

◆ withinGeneration() [2/2]

◆ withinNormCalc() [1/2]

◆ withinNormCalc() [2/2]

Member Data Documentation

◆ cachePDF_