Abstract base class for defining a variation across a 2D DP based on a histogram. More...

#include <Lau2DAbsHistDPPdf.hh>

Inheritance diagram for Lau2DAbsHistDPPdf:

Public Member Functions
	Lau2DAbsHistDPPdf (LauKinematics kinematics, const LauVetoes vetoes, Bool_t useUpperHalfOnly=kFALSE, Bool_t squareDP=kFALSE)
	Constructor. More...

virtual	~Lau2DAbsHistDPPdf ()
	Destructor. More...

Double_t	getMaxHeight () const
	Retrieve maximum height of the PDF. More...

virtual Double_t	getHistNorm () const =0
	Retrieve PDF normalisation. More...

virtual Double_t	interpolateXY (Double_t x, Double_t y) const =0
	Perform the interpolation (unnormalised) More...

virtual Double_t	interpolateXYNorm (Double_t x, Double_t y) const =0
	Perform the interpolation and divide by the normalisation. More...

Public Member Functions inherited from Lau2DAbsDPPdf
	Lau2DAbsDPPdf ()
	Constructor. More...

virtual	~Lau2DAbsDPPdf ()
	Destructor. More...

Protected Member Functions
const LauKinematics *	getKinematics () const
	Get the kinematics object. More...

const LauVetoes *	getVetoes () const
	Get the vetoes object. More...

void	calcMaxHeight (TH2 *hist)
	Calculate maximum height. More...

void	doBinFluctuation (TH2 *hist)
	Fluctuate the histogram bin contents in accordance with their errors. More...

Bool_t	withinDPBoundaries (Double_t x, Double_t y) const
	Check whether the given co-ordinates are within the kinematic boundary. More...

void	updateKinematics (Double_t x, Double_t y) const
	Update the current co-ordinates in the kinematic space. More...

void	getUpperHalf (Double_t &x, Double_t &y) const
	If only using the upper half of the (symmetric) DP then transform into the correct half. More...

Private Member Functions
	Lau2DAbsHistDPPdf (const Lau2DAbsHistDPPdf &rhs)
	Copy constructor - not implemented. More...

Lau2DAbsHistDPPdf &	operator= (const Lau2DAbsHistDPPdf &rhs)
	Copy assignment operator - not implemented. More...

Private Attributes
LauKinematics *	kinematics_
	DP kinematics. More...

const LauVetoes *	vetoes_
	Vetos within DP. More...

Double_t	maxHeight_
	The maximum height of 2D histogram. More...

Bool_t	upperHalf_
	Boolean for using the upper half of DP. More...

Bool_t	squareDP_
	Boolean for using square DP variables. More...

Detailed Description

Abstract base class for defining a variation across a 2D DP based on a histogram.

Abstract base class for defining a normalised variation across a 2D DP based on a histogram. The returned values are normalised to the total area. The histogram can be defined in the conventional DP (m13Sq vs m23Sq) or in the square DP and one half can be used to describe symmetric DPs.

Definition at line 47 of file Lau2DAbsHistDPPdf.hh.

Constructor & Destructor Documentation

Lau2DAbsHistDPPdf::Lau2DAbsHistDPPdf	(	LauKinematics *	kinematics,
		const LauVetoes *	vetoes,
		Bool_t	useUpperHalfOnly = `kFALSE`,
		Bool_t	squareDP = `kFALSE`
	)

Constructor.

Parameters

[in]	kinematics	the current DP kinematics
[in]	vetoes	the vetoes within the DP
[in]	useUpperHalfOnly	boolean flag to specify that the supplied histogram contains only the upper half of a symmetric DP (or lower half if using square DP coordinates)
[in]	squareDP	boolean flag to specify whether the supplied histogram is in square DP coordinates

Definition at line 43 of file Lau2DAbsHistDPPdf.cc.

Lau2DAbsHistDPPdf::~Lau2DAbsHistDPPdf ( )

virtual

Destructor.

Definition at line 59 of file Lau2DAbsHistDPPdf.cc.

Lau2DAbsHistDPPdf::Lau2DAbsHistDPPdf ( const Lau2DAbsHistDPPdf & rhs )

private

Copy constructor - not implemented.

Member Function Documentation

void Lau2DAbsHistDPPdf::calcMaxHeight ( TH2 * hist )

protected

Calculate maximum height.

Parameters

[in,out] hist the histogram

Definition at line 63 of file Lau2DAbsHistDPPdf.cc.

void Lau2DAbsHistDPPdf::doBinFluctuation ( TH2 * hist )

protected

Fluctuate the histogram bin contents in accordance with their errors.

Parameters

[in,out] hist the histogram

Definition at line 75 of file Lau2DAbsHistDPPdf.cc.

virtual Double_t Lau2DAbsHistDPPdf::getHistNorm ( ) const

pure virtual

Retrieve PDF normalisation.

Returns: the normalisation factor

Implements Lau2DAbsDPPdf.

Implemented in Lau2DHistDPPdf, and Lau2DSplineDPPdf.

const LauKinematics* Lau2DAbsHistDPPdf::getKinematics ( ) const

inlineprotected

Get the kinematics object.

Returns: the kinematics

Definition at line 96 of file Lau2DAbsHistDPPdf.hh.

Double_t Lau2DAbsHistDPPdf::getMaxHeight ( ) const

inlinevirtual

Retrieve maximum height of the PDF.

Returns: the maximum height

Implements Lau2DAbsDPPdf.

Definition at line 67 of file Lau2DAbsHistDPPdf.hh.

void Lau2DAbsHistDPPdf::getUpperHalf	(	Double_t &	x,
		Double_t &	y
	)		const

protected

If only using the upper half of the (symmetric) DP then transform into the correct half.

Parameters

[in,out]	x	the x co-ordinate
[in,out]	y	the y co-ordinate

Definition at line 105 of file Lau2DAbsHistDPPdf.cc.

const LauVetoes* Lau2DAbsHistDPPdf::getVetoes ( ) const

inlineprotected

Get the vetoes object.

Returns: the vetoes

Definition at line 102 of file Lau2DAbsHistDPPdf.hh.

virtual Double_t Lau2DAbsHistDPPdf::interpolateXY	(	Double_t	x,
		Double_t	y
	)		const

pure virtual

Perform the interpolation (unnormalised)

Parameters

[in]	x	the x-axis value
[in]	y	the y-aixs value

Returns: the unnormalised PDF value

Implements Lau2DAbsDPPdf.

Implemented in Lau2DHistDPPdf, and Lau2DSplineDPPdf.

virtual Double_t Lau2DAbsHistDPPdf::interpolateXYNorm	(	Double_t	x,
		Double_t	y
	)		const

pure virtual

Perform the interpolation and divide by the normalisation.

Parameters

[in]	x	the x-axis abscissa value
[in]	y	the y-axis abscissa value

Returns: the normalised PDF value

Implements Lau2DAbsDPPdf.

Implemented in Lau2DHistDPPdf, and Lau2DSplineDPPdf.

Lau2DAbsHistDPPdf& Lau2DAbsHistDPPdf::operator= ( const Lau2DAbsHistDPPdf & rhs )

private

Copy assignment operator - not implemented.

void Lau2DAbsHistDPPdf::updateKinematics	(	Double_t	x,
		Double_t	y
	)		const

protected

Update the current co-ordinates in the kinematic space.

Parameters

[in]	x	the x co-ordinate
[in]	y	the y co-ordinate

Definition at line 118 of file Lau2DAbsHistDPPdf.cc.

Bool_t Lau2DAbsHistDPPdf::withinDPBoundaries	(	Double_t	x,
		Double_t	y
	)		const

protected

Check whether the given co-ordinates are within the kinematic boundary.

Parameters

[in]	x	the x co-ordinate
[in]	y	the y co-ordinate

Returns: true if the co-ordinates are within the kinematic boundary, otherwise false

Definition at line 100 of file Lau2DAbsHistDPPdf.cc.

Member Data Documentation

LauKinematics* Lau2DAbsHistDPPdf::kinematics_

private

DP kinematics.

Definition at line 147 of file Lau2DAbsHistDPPdf.hh.

Double_t Lau2DAbsHistDPPdf::maxHeight_

private

The maximum height of 2D histogram.

Definition at line 153 of file Lau2DAbsHistDPPdf.hh.

Bool_t Lau2DAbsHistDPPdf::squareDP_

private

Boolean for using square DP variables.

Definition at line 158 of file Lau2DAbsHistDPPdf.hh.

Bool_t Lau2DAbsHistDPPdf::upperHalf_

private

Boolean for using the upper half of DP.

Definition at line 156 of file Lau2DAbsHistDPPdf.hh.

const LauVetoes* Lau2DAbsHistDPPdf::vetoes_

private

Vetos within DP.

Definition at line 150 of file Lau2DAbsHistDPPdf.hh.

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

inc/Lau2DAbsHistDPPdf.hh
src/Lau2DAbsHistDPPdf.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation