laura is hosted by Hepforge, IPPP Durham
Laura++  v3r3
A maximum likelihood fitting package for performing Dalitz-plot analysis.

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

#include <Lau2DAbsHistDPPdf.hh>

Inheritance diagram for Lau2DAbsHistDPPdf:
Lau2DAbsDPPdf Lau2DHistDPPdf Lau2DSplineDPPdf

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 LauKinematicsgetKinematics () const
 Get the kinematics object. More...
 
const LauVetoesgetVetoes () 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...
 
Lau2DAbsHistDPPdfoperator= (const Lau2DAbsHistDPPdf &rhs)
 Copy assignment operator - not implemented. More...
 

Private Attributes

LauKinematicskinematics_
 DP kinematics. More...
 
const LauVetoesvetoes_
 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 33 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]kinematicsthe current DP kinematics
[in]vetoesthe vetoes within the DP
[in]useUpperHalfOnlyboolean 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]squareDPboolean flag to specify whether the supplied histogram is in square DP coordinates

Definition at line 29 of file Lau2DAbsHistDPPdf.cc.

Lau2DAbsHistDPPdf::~Lau2DAbsHistDPPdf ( )
virtual

Destructor.

Definition at line 45 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]histthe histogram

Definition at line 49 of file Lau2DAbsHistDPPdf.cc.

void Lau2DAbsHistDPPdf::doBinFluctuation ( TH2 *  hist)
protected

Fluctuate the histogram bin contents in accordance with their errors.

Parameters
[in,out]histthe histogram

Definition at line 61 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 82 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 53 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]xthe x co-ordinate
[in,out]ythe y co-ordinate

Definition at line 91 of file Lau2DAbsHistDPPdf.cc.

const LauVetoes* Lau2DAbsHistDPPdf::getVetoes ( ) const
inlineprotected

Get the vetoes object.

Returns
the vetoes

Definition at line 88 of file Lau2DAbsHistDPPdf.hh.

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

Perform the interpolation (unnormalised)

Parameters
[in]xthe x-axis value
[in]ythe 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]xthe x-axis abscissa value
[in]ythe 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]xthe x co-ordinate
[in]ythe y co-ordinate

Definition at line 104 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]xthe x co-ordinate
[in]ythe y co-ordinate
Returns
true if the co-ordinates are within the kinematic boundary, otherwise false

Definition at line 86 of file Lau2DAbsHistDPPdf.cc.

Member Data Documentation

LauKinematics* Lau2DAbsHistDPPdf::kinematics_
private

DP kinematics.

Definition at line 133 of file Lau2DAbsHistDPPdf.hh.

Double_t Lau2DAbsHistDPPdf::maxHeight_
private

The maximum height of 2D histogram.

Definition at line 139 of file Lau2DAbsHistDPPdf.hh.

Bool_t Lau2DAbsHistDPPdf::squareDP_
private

Boolean for using square DP variables.

Definition at line 144 of file Lau2DAbsHistDPPdf.hh.

Bool_t Lau2DAbsHistDPPdf::upperHalf_
private

Boolean for using the upper half of DP.

Definition at line 142 of file Lau2DAbsHistDPPdf.hh.

const LauVetoes* Lau2DAbsHistDPPdf::vetoes_
private

Vetos within DP.

Definition at line 136 of file Lau2DAbsHistDPPdf.hh.


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