Logo ROOT  
Reference Guide
RooHistPdf.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id$
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_HIST_PDF
17#define ROO_HIST_PDF
18
19#include "RooAbsPdf.h"
20#include "RooRealProxy.h"
21#include "RooSetProxy.h"
22#include "RooAICRegistry.h"
23#include "RooDataHist.h"
24
25#include <list>
26
27class RooRealVar;
28class RooAbsReal;
29
30class RooHistPdf : public RooAbsPdf {
31public:
33 RooHistPdf(const char *name, const char *title, const RooArgSet& vars, const RooDataHist& dhist, Int_t intOrder=0);
34 RooHistPdf(const char *name, const char *title, const RooArgList& pdfObs, const RooArgList& histObs, const RooDataHist& dhist, Int_t intOrder=0);
35 RooHistPdf(const char *name, const char *title, const RooArgSet& vars,
36 std::unique_ptr<RooDataHist> dhist, int intOrder=0);
37 RooHistPdf(const char *name, const char *title, const RooArgList& pdfObs, const RooArgList& histObs,
38 std::unique_ptr<RooDataHist> dhist, int intOrder=0);
39 RooHistPdf(const RooHistPdf& other, const char* name=nullptr);
40 TObject* clone(const char* newname) const override { return new RooHistPdf(*this,newname); }
41 ~RooHistPdf() override ;
42
44 // Return RooDataHist that is represented
45 return *_dataHist ;
46 }
47 const RooDataHist& dataHist() const {
48 // Return RooDataHist that is represented
49 return *_dataHist ;
50 }
51
52 /// Replaces underlying RooDataHist with a clone, which is now owned, and returns the clone.
53 /// If the underlying RooDataHist is already owned, then that is returned instead of being cloned.
54 RooDataHist* cloneAndOwnDataHist(const char* newname="");
55
57 // Set histogram interpolation order
58 _intOrder = order ;
59 }
61 // Return histogram interpolation order
62 return _intOrder ;
63 }
64
65 Int_t getAnalyticalIntegral(RooArgSet& allVars, RooArgSet& analVars, const char* rangeName=nullptr) const override ;
66 double analyticalIntegral(Int_t code, const char* rangeName=nullptr) const override ;
67
68 void setCdfBoundaries(bool flag) {
69 // Set use of special boundary conditions for c.d.f.s
70 _cdfBoundaries = flag ;
71 }
72 bool getCdfBoundaries() const {
73 // If true, special boundary conditions for c.d.f.s are used
74 return _cdfBoundaries ;
75 }
76
77 void setUnitNorm(bool flag) {
78 // Declare contents to have unit normalization
79 _unitNorm = flag ;
80 }
81 bool haveUnitNorm() const {
82 // Return true if contents is declared to be unit normalized
83 return _unitNorm ;
84 }
85
86 bool selfNormalized() const override { return _unitNorm ; }
87
88 Int_t getMaxVal(const RooArgSet& vars) const override ;
89 double maxVal(Int_t code) const override ;
90
91 std::list<double>* plotSamplingHint(RooAbsRealLValue& obs, double xlo, double xhi) const override ;
92 std::list<double>* binBoundaries(RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/) const override ;
93 bool isBinnedDistribution(const RooArgSet&) const override { return _intOrder==0 ; }
94
95 void computeBatch(cudaStream_t*, double* output, size_t size, RooFit::Detail::DataMap const&) const override;
96
97protected:
98
99 bool areIdentical(const RooDataHist& dh1, const RooDataHist& dh2) ;
100
101 bool importWorkspaceHook(RooWorkspace& ws) override ;
102
103 double evaluate() const override;
104 double totalVolume() const ;
105 friend class RooAbsCachedPdf ;
106 double totVolume() const ;
107
108 RooArgSet _histObsList; ///< List of observables defining dimensions of histogram
109 RooSetProxy _pdfObsList; ///< List of observables mapped onto histogram observables
110 RooDataHist* _dataHist = nullptr; ///< Unowned pointer to underlying histogram
111 std::unique_ptr<RooDataHist> _ownedDataHist; ///<! Owned pointer to underlying histogram
112 mutable RooAICRegistry _codeReg ; ///<! Auxiliary class keeping tracking of analytical integration code
113 Int_t _intOrder = 0; ///< Interpolation order
114 bool _cdfBoundaries = false; ///< Use boundary conditions for CDFs.
115 mutable double _totVolume = 0.0; ///<! Total volume of space (product of ranges of observables)
116 bool _unitNorm = false; ///< Assume contents is unit normalized (for use as pdf cache)
117
118private:
119
120 friend class RooHistFunc;
121
122 static Int_t getAnalyticalIntegral(RooArgSet& allVars,
123 RooArgSet& analVars,
124 const char* rangeName,
125 RooArgSet const& histObsList,
126 RooSetProxy const& pdfObsList,
127 Int_t intOrder) ;
128
129 static double analyticalIntegral(Int_t code,
130 const char* rangeName,
131 RooArgSet const& histObsList,
132 RooSetProxy const& pdfObsList,
134 bool histFuncMode) ;
135
136 static std::list<double>* plotSamplingHint(RooDataHist const& dataHist,
137 RooArgSet const& pdfObsList,
138 RooArgSet const& histObsList,
139 int intOrder,
140 RooAbsRealLValue& obs,
141 double xlo,
142 double xhi);
143
144 ClassDefOverride(RooHistPdf,4) // Histogram based PDF
145};
146
147#endif
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
char name[80]
Definition: TGX11.cxx:110
RooAICRegistry is a utility class for operator p.d.f classes that keeps track of analytical integrati...
RooAbsCachedPdf is the abstract base class for p.d.f.s that need or want to cache their evaluate() ou...
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:60
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:22
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:56
The RooDataHist is a container class to hold N-dimensional binned data.
Definition: RooDataHist.h:39
RooHistFunc implements a real-valued function sampled from a multidimensional histogram.
Definition: RooHistFunc.h:31
RooHistPdf implements a probablity density function sampled from a multidimensional histogram.
Definition: RooHistPdf.h:30
Int_t getInterpolationOrder() const
Definition: RooHistPdf.h:60
void setUnitNorm(bool flag)
Definition: RooHistPdf.h:77
RooArgSet _histObsList
List of observables defining dimensions of histogram.
Definition: RooHistPdf.h:108
Int_t _intOrder
Interpolation order.
Definition: RooHistPdf.h:113
bool areIdentical(const RooDataHist &dh1, const RooDataHist &dh2)
Definition: RooHistPdf.cxx:527
RooDataHist * _dataHist
Unowned pointer to underlying histogram.
Definition: RooHistPdf.h:110
bool _cdfBoundaries
Use boundary conditions for CDFs.
Definition: RooHistPdf.h:114
std::list< double > * binBoundaries(RooAbsRealLValue &, double, double) const override
Return sampling hint for making curves of (projections) of this function as the recursive division st...
Definition: RooHistPdf.cxx:460
double totVolume() const
Return the total volume spanned by the observables of the RooHistPdf.
Definition: RooHistPdf.cxx:240
bool importWorkspaceHook(RooWorkspace &ws) override
Check if our datahist is already in the workspace.
Definition: RooHistPdf.cxx:544
RooSetProxy _pdfObsList
List of observables mapped onto histogram observables.
Definition: RooHistPdf.h:109
bool isBinnedDistribution(const RooArgSet &) const override
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
Definition: RooHistPdf.h:93
double maxVal(Int_t code) const override
Return maximum value for set of observables identified by code assigned in getMaxVal.
Definition: RooHistPdf.cxx:508
double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const override
Return integral identified by 'code'.
Definition: RooHistPdf.cxx:380
RooAICRegistry _codeReg
! Auxiliary class keeping tracking of analytical integration code
Definition: RooHistPdf.h:112
TObject * clone(const char *newname) const override
Definition: RooHistPdf.h:40
void setCdfBoundaries(bool flag)
Definition: RooHistPdf.h:68
std::list< double > * plotSamplingHint(RooAbsRealLValue &obs, double xlo, double xhi) const override
Return sampling hint for making curves of (projections) of this function as the recursive division st...
Definition: RooHistPdf.cxx:391
void computeBatch(cudaStream_t *, double *output, size_t size, RooFit::Detail::DataMap const &) const override
Base function for computing multiple values of a RooAbsReal.
Definition: RooHistPdf.cxx:197
RooDataHist & dataHist()
Definition: RooHistPdf.h:43
bool haveUnitNorm() const
Definition: RooHistPdf.h:81
Int_t getMaxVal(const RooArgSet &vars) const override
Only handle case of maximum in all variables.
Definition: RooHistPdf.cxx:496
double _totVolume
! Total volume of space (product of ranges of observables)
Definition: RooHistPdf.h:115
RooDataHist * cloneAndOwnDataHist(const char *newname="")
Replaces underlying RooDataHist with a clone, which is now owned, and returns the clone.
Definition: RooHistPdf.cxx:190
std::unique_ptr< RooDataHist > _ownedDataHist
! Owned pointer to underlying histogram
Definition: RooHistPdf.h:111
double totalVolume() const
bool getCdfBoundaries() const
Definition: RooHistPdf.h:72
bool selfNormalized() const override
Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.
Definition: RooHistPdf.h:86
Int_t getAnalyticalIntegral(RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const override
Determine integration scenario.
Definition: RooHistPdf.cxx:369
const RooDataHist & dataHist() const
Definition: RooHistPdf.h:47
~RooHistPdf() override
Destructor.
Definition: RooHistPdf.cxx:185
double evaluate() const override
Return the current value: The value of the bin enclosing the current coordinates of the observables,...
Definition: RooHistPdf.cxx:215
void setInterpolationOrder(Int_t order)
Definition: RooHistPdf.h:56
bool _unitNorm
Assume contents is unit normalized (for use as pdf cache)
Definition: RooHistPdf.h:116
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:40
The RooWorkspace is a persistable container for RooFit projects.
Definition: RooWorkspace.h:43
Mother of all ROOT objects.
Definition: TObject.h:41
static void output()