Logo ROOT  
Reference Guide
Go to the documentation of this file.
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooAddPdf.h,v 1.46 2007/07/12 20:30:28 wouter Exp $
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_ADD_PDF
17#define ROO_ADD_PDF
19#include "RooAbsPdf.h"
20#include "RooListProxy.h"
21#include "RooSetProxy.h"
22#include "RooAICRegistry.h"
23#include "RooNormSetCache.h"
24#include "RooNameSet.h"
25#include "RooCacheManager.h"
26#include "RooObjCacheManager.h"
27#include "RooNameReg.h"
29class RooAddPdf : public RooAbsPdf {
32 RooAddPdf() ;
33 RooAddPdf(const char *name, const char *title=0);
34 RooAddPdf(const char *name, const char *title,
35 RooAbsPdf& pdf1, RooAbsPdf& pdf2, RooAbsReal& coef1) ;
36 RooAddPdf(const char *name, const char *title, const RooArgList& pdfList) ;
37 RooAddPdf(const char *name, const char *title, const RooArgList& pdfList, const RooArgList& coefList, Bool_t recursiveFraction=kFALSE) ;
39 RooAddPdf(const RooAddPdf& other, const char* name=0) ;
40 virtual TObject* clone(const char* newname) const { return new RooAddPdf(*this,newname) ; }
41 virtual ~RooAddPdf() ;
43 virtual Bool_t checkObservables(const RooArgSet* nset) const ;
45 virtual Bool_t forceAnalyticalInt(const RooAbsArg& /*dep*/) const {
46 // Force RooRealIntegral to offer all observables for internal integration
47 return kTRUE ;
48 }
49 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& numVars, const RooArgSet* normSet, const char* rangeName=0) const ;
50 Double_t analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName=0) const ;
51 virtual Bool_t selfNormalized() const {
52 // P.d.f is self normalized
53 return kTRUE ;
54 }
56 virtual ExtendMode extendMode() const {
57 // Return extended mode capabilities
59 }
60 virtual Double_t expectedEvents(const RooArgSet* nset) const ;
61 virtual Double_t expectedEvents(const RooArgSet& nset) const {
62 // Return expected number of events for extended likelihood calculation
63 // which is the sum of all coefficients
64 return expectedEvents(&nset) ;
65 }
67 const RooArgList& pdfList() const {
68 // Return list of component p.d.fs
69 return _pdfList ;
70 }
71 const RooArgList& coefList() const {
72 // Return list of coefficients of component p.d.f.s
73 return _coefList ;
74 }
76 void fixCoefNormalization(const RooArgSet& refCoefNorm) ;
77 void fixCoefRange(const char* rangeName) ;
79 const RooArgSet& getCoefNormalization() const { return _refCoefNorm ; }
82 virtual void resetErrorCounters(Int_t resetValue=10) ;
84 virtual std::list<Double_t>* plotSamplingHint(RooAbsRealLValue& obs, Double_t xlo, Double_t xhi) const ;
85 virtual std::list<Double_t>* binBoundaries(RooAbsRealLValue& /*obs*/, Double_t /*xlo*/, Double_t /*xhi*/) const ;
86 Bool_t isBinnedDistribution(const RooArgSet& obs) const ;
88 void printMetaArgs(std::ostream& os) const ;
90 virtual CacheMode canNodeBeCached() const { return RooAbsArg::NotAdvised ; } ;
91 virtual void setCacheAndTrackHints(RooArgSet&) ;
95 virtual void selectNormalization(const RooArgSet* depSet=0, Bool_t force=kFALSE) ;
96 virtual void selectNormalizationRange(const char* rangeName=0, Bool_t force=kFALSE) ;
98 mutable RooSetProxy _refCoefNorm ; // Reference observable set for coefficient interpretation
99 mutable TNamed* _refCoefRangeName ; // Reference range name for coefficient interpreation
101 Bool_t _projectCoefs ; // If true coefficients need to be projected for use in evaluate()
102 std::vector<double> _coefCache; //! Transient cache with transformed values of coefficients
106 public:
107 virtual ~CacheElem() {} ;
109 RooArgList _suppNormList ; // Supplemental normalization list
110 Bool_t _needSupNorm ; // Does the above list contain any non-unit entries?
112 RooArgList _projList ; // Projection integrals to be multiplied with coefficients
113 RooArgList _suppProjList ; // Projection integrals to be multiplied with coefficients for supplemental normalization terms
114 RooArgList _refRangeProjList ; // Range integrals to be multiplied with coefficients (reference range)
115 RooArgList _rangeProjList ; // Range integrals to be multiplied with coefficients (target range)
119 } ;
120 mutable RooObjCacheManager _projCacheMgr ; // Manager of cache with coefficient projections and transformations
121 CacheElem* getProjCache(const RooArgSet* nset, const RooArgSet* iset=0, const char* rangeName=0) const ;
122 void updateCoefficients(CacheElem& cache, const RooArgSet* nset) const ;
125 friend class RooAddGenContext ;
126 virtual RooAbsGenContext* genContext(const RooArgSet &vars, const RooDataSet *prototype=0,
127 const RooArgSet* auxProto=0, Bool_t verbose= kFALSE) const ;
130 Double_t evaluate() const;
131 virtual RooSpan<double> evaluateBatch(std::size_t begin, std::size_t batchSize) const;
134 mutable RooAICRegistry _codeReg ; //! Registry of component analytical integration codes
136 RooListProxy _pdfList ; // List of component PDFs
137 RooListProxy _coefList ; // List of coefficients
138 mutable RooArgList* _snormList{nullptr}; //! List of supplemental normalization factors
140 Bool_t _haveLastCoef ; // Flag indicating if last PDFs coefficient was supplied in the ctor
141 Bool_t _allExtendable ; // Flag indicating if all PDF components are extendable
142 Bool_t _recursive ; // Flag indicating is fractions are treated recursively
144 mutable Int_t _coefErrCount ; //! Coefficient error counter
147 std::pair<const RooArgSet*, CacheElem*> getNormAndCache() const;
149 ClassDef(RooAddPdf,3) // PDF representing a sum of PDFs
int Int_t
Definition: RtypesCore.h:41
const Bool_t kFALSE
Definition: RtypesCore.h:88
bool Bool_t
Definition: RtypesCore.h:59
double Double_t
Definition: RtypesCore.h:55
const Bool_t kTRUE
Definition: RtypesCore.h:87
#define ClassDef(name, id)
Definition: Rtypes.h:326
char name[80]
Definition: TGX11.cxx:109
RooAICRegistry is a utility class for operator p.d.f classes that keeps track of analytical integrati...
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:71
@ NotAdvised
Definition: RooAbsArg.h:370
RooAbsCacheElement is the abstract base class for objects to be stored in RooAbsCache cache manager o...
RooAbsGenContext is the abstract base class for generator contexts of RooAbsPdf objects.
@ MustBeExtended
Definition: RooAbsPdf.h:230
@ CanNotBeExtended
Definition: RooAbsPdf.h:230
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:59
RooAddGenContext is an efficient implementation of the generator context specific for RooAddPdf PDFs.
Transient cache with transformed values of coefficients.
Definition: RooAddPdf.h:105
virtual RooArgList containedArgs(Action)
List all RooAbsArg derived contents in this cache element.
Definition: RooAddPdf.cxx:1159
virtual ~CacheElem()
Definition: RooAddPdf.h:107
RooArgList _rangeProjList
Definition: RooAddPdf.h:115
RooArgList _refRangeProjList
Definition: RooAddPdf.h:114
RooArgList _projList
Definition: RooAddPdf.h:112
RooArgList _suppNormList
Definition: RooAddPdf.h:107
RooArgList _suppProjList
Definition: RooAddPdf.h:113
RooAddPdf is an efficient implementation of a sum of PDFs of the form.
Definition: RooAddPdf.h:29
RooListProxy _coefList
Definition: RooAddPdf.h:137
virtual CacheMode canNodeBeCached() const
Definition: RooAddPdf.h:90
virtual void resetErrorCounters(Int_t resetValue=10)
Reset error counter to given value, limiting the number of future error messages for this pdf to 'res...
Definition: RooAddPdf.cxx:873
RooArgList * _snormList
Definition: RooAddPdf.h:138
Bool_t _recursive
Definition: RooAddPdf.h:142
virtual void setCacheAndTrackHints(RooArgSet &)
Label OK'ed components of a RooAddPdf with cache-and-track.
Definition: RooAddPdf.cxx:1282
virtual Double_t expectedEvents(const RooArgSet *nset) const
Return the number of expected events, which is either the sum of all coefficients or the sum of the c...
Definition: RooAddPdf.cxx:1041
RooAICRegistry _codeReg
Definition: RooAddPdf.h:134
const char * getCoefRange() const
Definition: RooAddPdf.h:80
Bool_t isBinnedDistribution(const RooArgSet &obs) const
If all components that depend on obs are binned that so is the product.
Definition: RooAddPdf.cxx:1266
virtual TObject * clone(const char *newname) const
Definition: RooAddPdf.h:40
virtual RooSpan< double > evaluateBatch(std::size_t begin, std::size_t batchSize) const
Compute addition of PDFs in batches.
Definition: RooAddPdf.cxx:839
Int_t _coefErrCount
Definition: RooAddPdf.h:144
Bool_t _allExtendable
Definition: RooAddPdf.h:141
virtual void selectNormalizationRange(const char *rangeName=0, Bool_t force=kFALSE)
Interface function used by test statistics to freeze choice of range for interpretation of fraction c...
Definition: RooAddPdf.cxx:1133
Double_t evaluate() const
Calculate and return the current value.
Definition: RooAddPdf.cxx:807
void updateCoefficients(CacheElem &cache, const RooArgSet *nset) const
Update the coefficient values in the given cache element: calculate new remainder fraction,...
Definition: RooAddPdf.cxx:652
virtual ~RooAddPdf()
Definition: RooAddPdf.cxx:346
CacheElem * getProjCache(const RooArgSet *nset, const RooArgSet *iset=0, const char *rangeName=0) const
Retrieve cache element for the computation of the PDF normalisation.
Definition: RooAddPdf.cxx:409
const RooArgList & coefList() const
Definition: RooAddPdf.h:71
std::pair< const RooArgSet *, CacheElem * > getNormAndCache() const
Coefficient error counter.
Definition: RooAddPdf.cxx:787
RooObjCacheManager _projCacheMgr
Definition: RooAddPdf.h:120
void printMetaArgs(std::ostream &os) const
Customized printing of arguments of a RooAddPdf to more intuitively reflect the contents of the produ...
Definition: RooAddPdf.cxx:1300
Default constructor used for persistence.
Definition: RooAddPdf.cxx:98
virtual std::list< Double_t > * plotSamplingHint(RooAbsRealLValue &obs, Double_t xlo, Double_t xhi) const
Loop over components for plot sampling hints and merge them if there are multiple.
Definition: RooAddPdf.cxx:1175
virtual std::list< Double_t > * binBoundaries(RooAbsRealLValue &, Double_t, Double_t) const
Loop over components for plot sampling hints and merge them if there are multiple.
Definition: RooAddPdf.cxx:1220
void fixCoefNormalization(const RooArgSet &refCoefNorm)
By default the interpretation of the fraction coefficients is performed in the contextual choice of o...
Definition: RooAddPdf.cxx:363
virtual RooAbsGenContext * genContext(const RooArgSet &vars, const RooDataSet *prototype=0, const RooArgSet *auxProto=0, Bool_t verbose=kFALSE) const
Return specialized context to efficiently generate toy events from RooAddPdfs return RooAbsPdf::genCo...
Definition: RooAddPdf.cxx:1148
RooSetProxy _refCoefNorm
Definition: RooAddPdf.h:98
virtual Bool_t selfNormalized() const
Definition: RooAddPdf.h:51
Double_t analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=0) const
Return analytical integral defined by given scenario code.
Definition: RooAddPdf.cxx:984
virtual Bool_t forceAnalyticalInt(const RooAbsArg &) const
Definition: RooAddPdf.h:45
virtual void selectNormalization(const RooArgSet *depSet=0, Bool_t force=kFALSE)
Interface function used by test statistics to freeze choice of observables for interpretation of frac...
Definition: RooAddPdf.cxx:1110
void fixCoefRange(const char *rangeName)
By default, fraction coefficients are assumed to refer to the default fit range.
Definition: RooAddPdf.cxx:390
virtual ExtendMode extendMode() const
Definition: RooAddPdf.h:56
virtual Double_t expectedEvents(const RooArgSet &nset) const
Definition: RooAddPdf.h:61
RooListProxy _pdfList
Registry of component analytical integration codes.
Definition: RooAddPdf.h:136
TNamed * _refCoefRangeName
Definition: RooAddPdf.h:99
const RooArgList & pdfList() const
Definition: RooAddPdf.h:67
Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &numVars, const RooArgSet *normSet, const char *rangeName=0) const
Determine which part (if any) of given integral can be performed analytically.
Definition: RooAddPdf.cxx:916
Bool_t _projectCoefs
Definition: RooAddPdf.h:101
std::vector< double > _coefCache
Definition: RooAddPdf.h:102
const RooArgSet & getCoefNormalization() const
Definition: RooAddPdf.h:79
Bool_t _haveLastCoef
List of supplemental normalization factors.
Definition: RooAddPdf.h:140
virtual Bool_t checkObservables(const RooArgSet *nset) const
Check if PDF is valid for given normalization set.
Definition: RooAddPdf.cxx:886
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:21
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
RooDataSet is a container class to hold unbinned data.
Definition: RooDataSet.h:31
RooListProxy is the concrete proxy for RooArgList objects.
Definition: RooListProxy.h:25
static const char * str(const TNamed *ptr)
Return C++ string corresponding to given TNamed pointer.
Definition: RooNameReg.cxx:103
Class RooObjCacheManager is an implementation of class RooCacheManager<RooAbsCacheElement> and specia...
RooSetProxy is the concrete proxy for RooArgSet objects.
Definition: RooSetProxy.h:24
A simple container to hold a batch of data values.
Definition: RooSpan.h:32
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:37