Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsPdf.cxx
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * @(#)root/roofitcore:$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
17//////////////////////////////////////////////////////////////////////////////
18/** \class RooAbsPdf
19 \ingroup Roofitcore
20 \brief Abstract interface for all probability density functions.
21
22## RooAbsPdf, the base class of all PDFs
23
24RooAbsPdf is the base class for all probability density
25functions (PDFs). The class provides hybrid analytical/numerical
26normalization for its implementations, error tracing, and a Monte Carlo
27generator interface.
28
29### A Minimal PDF Implementation
30
31A minimal implementation of a PDF class derived from RooAbsPdf
32should override the `evaluate()` function. This function should
33return the PDF's value (which does not need to be normalised).
34
35
36#### Normalization/Integration
37
38Although the normalization of a PDF is an integral part of a
39probability density function, normalization is treated separately
40in RooAbsPdf. The reason is that a RooAbsPdf object is more than a
41PDF: it can be a building block for a more complex composite PDF
42if any of its variables are functions instead of variables. In
43such cases, the normalization of the composite PDF may not simply be
44integral over the dependents of the top-level PDF: these are
45functions with potentially non-trivial Jacobian terms themselves.
46\note Therefore, no explicit attempt should be made to normalize the
47function output in evaluate(). In particular, normalisation constants
48can be omitted to speed up the function evaluations, and included later
49in the integration of the PDF (see below), which is rarely called in
50comparison to the `evaluate()` function.
51
52In addition, RooAbsPdf objects do not have a static concept of what
53variables are parameters, and what variables are dependents (which
54need to be integrated over for a correct PDF normalization).
55Instead, the choice of normalization is always specified each time a
56normalized value is requested from the PDF via the getVal()
57method.
58
59RooAbsPdf manages the entire normalization logic of each PDF with
60the help of a RooRealIntegral object, which coordinates the integration
61of a given choice of normalization. By default, RooRealIntegral will
62perform an entirely numeric integration of all dependents. However,
63PDFs can advertise one or more (partial) analytical integrals of
64their function, and these will be used by RooRealIntegral, if it
65determines that this is safe (i.e., no hidden Jacobian terms,
66multiplication with other PDFs that have one or more dependents in
67common, etc).
68
69#### Implementing analytical integrals
70To implement analytical integrals, two functions must be implemented. First,
71
72```
73Int_t getAnalyticalIntegral(const RooArgSet& integSet, RooArgSet& anaIntSet)
74```
75should return the analytical integrals that are supported. `integSet`
76is the set of dependents for which integration is requested. The
77function should copy the subset of dependents it can analytically
78integrate to `anaIntSet`, and return a unique identification code for
79this integration configuration. If no integration can be
80performed, zero should be returned. Second,
81
82```
83double analyticalIntegral(Int_t code)
84```
85
86implements the actual analytical integral(s) advertised by
87`getAnalyticalIntegral()`. This function will only be called with
88codes returned by `getAnalyticalIntegral()`, except code zero.
89
90The integration range for each dependent to be integrated can
91be obtained from the dependent's proxy functions `min()` and
92`max()`. Never call these proxy functions for any proxy not known to
93be a dependent via the integration code. Doing so may be
94ill-defined, e.g., in case the proxy holds a function, and will
95trigger an assert. Integrated category dependents should always be
96summed over all of their states.
97
98
99
100### Direct generation of observables
101
102Distributions for any PDF can be generated with the accept/reject method,
103but for certain PDFs, more efficient methods may be implemented. To
104implement direct generation of one or more observables, two
105functions need to be implemented, similar to those for analytical
106integrals:
107
108```
109Int_t getGenerator(const RooArgSet& generateVars, RooArgSet& directVars)
110```
111and
112```
113void generateEvent(Int_t code)
114```
115
116The first function advertises observables, for which distributions can be generated,
117similar to the way analytical integrals are advertised. The second
118function implements the actual generator for the advertised observables.
119
120The generated dependent values should be stored in the proxy
121objects. For this, the assignment operator can be used (i.e. `xProxy
122= 3.0` ). Never call assign to any proxy not known to be a dependent
123via the generation code. Doing so may be ill-defined, e.g. in case
124the proxy holds a function, and will trigger an assert.
126
127### Batched function evaluations (Advanced usage)
128
129To speed up computations with large numbers of data events in unbinned fits,
130it is beneficial to override `doEval()`. Like this, large spans of
131computations can be done, without having to call `evaluate()` for each single data event.
132`doEval()` should execute the same computation as `evaluate()`, but it
133may choose an implementation that is capable of SIMD computations.
134If doEval is not implemented, the classic and slower `evaluate()` will be
135called for each data event.
136*/
137
138#include "RooAbsPdf.h"
139
140#include "FitHelpers.h"
142#include "RooMsgService.h"
143#include "RooArgSet.h"
144#include "RooArgProxy.h"
145#include "RooRealProxy.h"
146#include "RooRealVar.h"
147#include "RooGenContext.h"
148#include "RooBinnedGenContext.h"
149#include "RooPlot.h"
150#include "RooCurve.h"
151#include "RooCategory.h"
152#include "RooNameReg.h"
153#include "RooCmdConfig.h"
154#include "RooGlobalFunc.h"
155#include "RooRandom.h"
156#include "RooNumIntConfig.h"
157#include "RooProjectedPdf.h"
158#include "RooParamBinning.h"
159#include "RooNumCdf.h"
160#include "RooFitResult.h"
161#include "RooNumGenConfig.h"
162#include "RooCachedReal.h"
163#include "RooRealIntegral.h"
164#include "RooWorkspace.h"
165#include "RooNaNPacker.h"
166#include "RooFitImplHelpers.h"
167#include "RooHelpers.h"
168#include "RooFormulaVar.h"
169#include "RooDerivative.h"
170
171#include "ROOT/StringUtils.hxx"
172#include "TMath.h"
173#include "TPaveText.h"
174#include "TMatrixD.h"
175#include "TMatrixDSym.h"
176
177#include <algorithm>
178#include <iostream>
179#include <string>
180#include <cmath>
181#include <stdexcept>
182
183namespace {
184
185inline double getLog(double prob, RooAbsReal const *caller)
186{
187
188 if (prob < 0) {
189 caller->logEvalError("getLogVal() top-level p.d.f evaluates to a negative number");
191 }
192
193 if (std::isinf(prob)) {
194 oocoutW(caller, Eval) << "RooAbsPdf::getLogVal(" << caller->GetName()
195 << ") WARNING: top-level pdf has an infinite value" << std::endl;
196 }
197
198 if (prob == 0) {
199 caller->logEvalError("getLogVal() top-level p.d.f evaluates to zero");
200
201 return -std::numeric_limits<double>::infinity();
202 }
203
204 if (TMath::IsNaN(prob)) {
205 caller->logEvalError("getLogVal() top-level p.d.f evaluates to NaN");
206
207 return prob;
208 }
209
210 return std::log(prob);
211}
212
214{
215 TObject *old = lst.FindObject(obj.GetName());
216 if (old)
217 lst.Replace(old, &obj);
218 else
219 lst.Add(&obj);
220}
221
222} // namespace
223
224using std::endl, std::string, std::ostream, std::vector, std::pair, std::make_pair;
225
227
228
229
230
233
234////////////////////////////////////////////////////////////////////////////////
235/// Default constructor
236
237RooAbsPdf::RooAbsPdf() : _normMgr(this, 10) {}
238
239////////////////////////////////////////////////////////////////////////////////
240/// Constructor with name and title only
241
242RooAbsPdf::RooAbsPdf(const char *name, const char *title) :
243 RooAbsReal(name,title), _normMgr(this,10), _selectComp(true)
244{
246 setTraceCounter(0) ;
247}
248
249
250
251////////////////////////////////////////////////////////////////////////////////
252/// Constructor with name, title, and plot range
253
254RooAbsPdf::RooAbsPdf(const char *name, const char *title,
255 double plotMin, double plotMax) :
256 RooAbsReal(name,title,plotMin,plotMax), _normMgr(this,10), _selectComp(true)
257{
259 setTraceCounter(0) ;
260}
261
262
263
264////////////////////////////////////////////////////////////////////////////////
265/// Copy constructor
266
269 _normMgr(other._normMgr,this), _selectComp(other._selectComp), _normRange(other._normRange)
270{
272 setTraceCounter(other._traceCount) ;
273
274 if (other._specGeneratorConfig) {
275 _specGeneratorConfig = std::make_unique<RooNumGenConfig>(*other._specGeneratorConfig);
276 }
277}
278
279
280
281////////////////////////////////////////////////////////////////////////////////
282/// Destructor
283
287
288
289////////////////////////////////////////////////////////////////////////////////
290/// Return current value, normalized by integrating over
291/// the observables in `nset`. If `nset` is 0, the unnormalized value
292/// is returned. All elements of `nset` must be lvalues.
293///
294/// Unnormalized values are not cached.
295/// Doing so would be complicated as `_norm->getVal()` could
296/// spoil the cache and interfere with returning the cached
297/// return value. Since unnormalized calls are typically
298/// done in integration calls, there is no performance hit.
300double RooAbsPdf::getValV(const RooArgSet* nset) const
301{
302
303 // Special handling of case without normalization set (used in numeric integration of pdfs)
304 if (!nset) {
305 RooArgSet const* tmp = _normSet ;
306 _normSet = nullptr ;
307 double val = evaluate() ;
308 _normSet = tmp ;
309
310 return TMath::IsNaN(val) ? 0. : val;
311 }
312
313
314 // Process change in last data set used
315 bool nintChanged(false) ;
316 if (!isActiveNormSet(nset) || _norm==nullptr) {
318 }
319
320 // Return value of object. Calculated if dirty, otherwise cached value is returned.
322
323 // Evaluate numerator
324 const double rawVal = evaluate();
325
326 // Evaluate denominator
327 const double normVal = _norm->getVal();
328
330
332 }
333
334 return _value ;
335}
336
337
338////////////////////////////////////////////////////////////////////////////////
339/// Analytical integral with normalization (see RooAbsReal::analyticalIntegralWN() for further information).
340///
341/// This function applies the normalization specified by `normSet` to the integral returned
342/// by RooAbsReal::analyticalIntegral(). The passthrough scenario (code=0) is also changed
343/// to return a normalized answer.
344
345double RooAbsPdf::analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName) const
346{
347 cxcoutD(Eval) << "RooAbsPdf::analyticalIntegralWN(" << GetName() << ") code = " << code << " normset = " << (normSet?*normSet:RooArgSet()) << std::endl ;
348
349
350 if (code==0) return getVal(normSet) ;
351 if (normSet) {
353 } else {
354 return analyticalIntegral(code,rangeName) ;
355 }
356}
357
358
359
360////////////////////////////////////////////////////////////////////////////////
361/// Check that passed value is positive and not 'not-a-number'. If
362/// not, print an error, until the error counter reaches its set
363/// maximum.
364
366{
367 // check for a math error or negative value
368 bool error(false) ;
369 if (TMath::IsNaN(value)) {
370 logEvalError(Form("p.d.f value is Not-a-Number (%f), forcing value to zero",value)) ;
371 error=true ;
372 }
373 if (value<0) {
374 logEvalError(Form("p.d.f value is less than zero (%f), forcing value to zero",value)) ;
375 error=true ;
376 }
377
378 // do nothing if we are no longer tracing evaluations and there was no error
379 if(!error) return error ;
380
381 // otherwise, print out this evaluations input values and result
382 if(++_errorCount <= 10) {
383 cxcoutD(Tracing) << "*** Evaluation Error " << _errorCount << " ";
384 if(_errorCount == 10) cxcoutD(Tracing) << "(no more will be printed) ";
385 }
386 else {
387 return error ;
388 }
389
390 Print() ;
391 return error ;
392}
393
394
395////////////////////////////////////////////////////////////////////////////////
396/// Get normalisation term needed to normalise the raw values returned by
397/// getVal(). Note that `getVal(normalisationVariables)` will automatically
398/// apply the normalisation term returned here.
399/// \param nset Set of variables to normalise over.
400double RooAbsPdf::getNorm(const RooArgSet* nset) const
401{
402 if (!nset) return 1 ;
403
404 syncNormalization(nset,true) ;
405 if (_verboseEval>1) cxcoutD(Tracing) << ClassName() << "::getNorm(" << GetName() << "): norm(" << _norm << ") = " << _norm->getVal() << std::endl ;
406
407 double ret = _norm->getVal() ;
408 if (ret==0.) {
409 if(++_errorCount <= 10) {
410 coutW(Eval) << "RooAbsPdf::getNorm(" << GetName() << ":: WARNING normalization is zero, nset = " ; nset->Print("1") ;
411 if(_errorCount == 10) coutW(Eval) << "RooAbsPdf::getNorm(" << GetName() << ") INFO: no more messages will be printed " << std::endl ;
412 }
413 }
414
415 return ret ;
416}
417
418
419
420////////////////////////////////////////////////////////////////////////////////
421/// Return pointer to RooAbsReal object that implements calculation of integral over observables iset in range
422/// rangeName, optionally taking the integrand normalized over observables nset
423
424const RooAbsReal* RooAbsPdf::getNormObj(const RooArgSet* nset, const RooArgSet* iset, const TNamed* rangeName) const
425{
426 // Check normalization is already stored
427 CacheElem* cache = static_cast<CacheElem*>(_normMgr.getObj(nset,iset,nullptr,rangeName)) ;
428 if (cache) {
429 return cache->_norm.get();
430 }
431
432 // If not create it now
435
436 // Normalization is always over all pdf components. Overriding the global
437 // component selection temporarily makes all RooRealIntegrals created during
438 // that time always include all components.
440 RooAbsReal* norm = std::unique_ptr<RooAbsReal>{createIntegral(depList,*nset, *getIntegratorConfig(), RooNameReg::str(rangeName))}.release();
441
442 // Store it in the cache
444
445 // And return the newly created integral
446 return norm ;
447}
448
449
450
451////////////////////////////////////////////////////////////////////////////////
452/// Verify that the normalization integral cached with this PDF
453/// is valid for given set of normalization observables.
454///
455/// If not, the cached normalization integral (if any) is deleted
456/// and a new integral is constructed for use with 'nset'.
457/// Elements in 'nset' can be discrete and real, but must be lvalues.
458///
459/// For functions that declare to be self-normalized by overloading the
460/// selfNormalized() function, a unit normalization is always constructed.
461
463{
464 setActiveNormSet(nset);
465
466 // Check if data sets are identical
467 CacheElem *cache = static_cast<CacheElem *>(_normMgr.getObj(nset));
468 if (cache) {
469
470 bool nintChanged = (_norm != cache->_norm.get());
471 _norm = cache->_norm.get();
472
473 // In the past, this condition read `if (nintChanged && adjustProxies)`.
474 // However, the cache checks if the nset was already cached **by content**,
475 // and not by RooArgSet instance! So it can happen that the normalization
476 // set object is different, but the integral object is the same, in which
477 // case it would be wrong to not adjust the proxies. They always have to be
478 // adjusted when the nset changed, which is always the case when
479 // `syncNormalization()` is called.
480 if (adjustProxies) {
481 // Update dataset pointers of proxies
482 const_cast<RooAbsPdf *>(this)->setProxyNormSet(nset);
483 }
484
485 return nintChanged;
486 }
487
488 // Update dataset pointers of proxies
489 if (adjustProxies) {
490 const_cast<RooAbsPdf *>(this)->setProxyNormSet(nset);
491 }
492
494 getObservables(nset, depList);
495
496 if (_verboseEval > 0) {
497 if (!selfNormalized()) {
498 cxcoutD(Tracing) << ClassName() << "::syncNormalization(" << GetName()
499 << ") recreating normalization integral " << std::endl;
500 depList.printStream(ccoutD(Tracing), kName | kValue | kArgs, kSingleLine);
501 } else {
502 cxcoutD(Tracing) << ClassName() << "::syncNormalization(" << GetName()
503 << ") selfNormalized, creating unit norm" << std::endl;
504 }
505 }
506
507 // Destroy old normalization & create new
508 if (selfNormalized() || depList.empty()) {
509 auto ntitle = std::string(GetTitle()) + " Unit Normalization";
510 auto nname = std::string(GetName()) + "_UnitNorm";
511 _norm = new RooRealVar(nname.c_str(), ntitle.c_str(), 1);
512 } else {
513 const char *nr = (_normRangeOverride.Length() > 0 ? _normRangeOverride.Data()
514 : (_normRange.Length() > 0 ? _normRange.Data() : nullptr));
515
516 // std::cout << "RooAbsPdf::syncNormalization(" << GetName() << ") rangeName for normalization is " <<
517 // (nr?nr:"<null>") << std::endl ;
519 {
520 // Normalization is always over all pdf components. Overriding the global
521 // component selection temporarily makes all RooRealIntegrals created during
522 // that time always include all components.
524 normInt = std::unique_ptr<RooAbsReal>{createIntegral(depList, *getIntegratorConfig(), nr)}.release();
525 }
526 static_cast<RooRealIntegral *>(normInt)->setAllowComponentSelection(false);
527 normInt->getVal();
528 // std::cout << "resulting normInt = " << normInt->GetName() << std::endl ;
529
530 const char *cacheParamsStr = getStringAttribute("CACHEPARAMINT");
532
533 std::unique_ptr<RooArgSet> intParams{normInt->getVariables()};
534
536
537 if (!cacheParams.empty()) {
538 cxcoutD(Caching) << "RooAbsReal::createIntObj(" << GetName() << ") INFO: constructing "
539 << cacheParams.size() << "-dim value cache for integral over " << depList
540 << " as a function of " << cacheParams << " in range " << (nr ? nr : "<default>")
541 << std::endl;
542 std::string name = normInt->GetName() + ("_CACHE_[" + cacheParams.contentsString()) + "]";
544 cachedIntegral->setInterpolationOrder(2);
545 cachedIntegral->addOwnedComponents(*normInt);
546 cachedIntegral->setCacheSource(true);
547 if (normInt->operMode() == ADirty) {
548 cachedIntegral->setOperMode(ADirty);
549 }
551 }
552 }
553 _norm = normInt;
554 }
555
556 // Register new normalization with manager (takes ownership)
557 cache = new CacheElem(*_norm);
558 _normMgr.setObj(nset, cache);
559
560 // std::cout << "making new object " << _norm->GetName() << std::endl ;
561
562 return true;
563}
564
565
566
567////////////////////////////////////////////////////////////////////////////////
568/// Reset error counter to given value, limiting the number
569/// of future error messages for this pdf to 'resetValue'
570
576
577
578
579////////////////////////////////////////////////////////////////////////////////
580/// Reset trace counter to given value, limiting the
581/// number of future trace messages for this pdf to 'value'
582
584{
585 if (!allNodes) {
587 return ;
588 } else {
591 for(auto * pdf : dynamic_range_cast<RooAbsPdf*>(branchList)) {
592 if (pdf) pdf->setTraceCounter(value,false) ;
593 }
594 }
595
596}
597
598
599
600
601////////////////////////////////////////////////////////////////////////////////
602/// Return the log of the current value with given normalization
603/// An error message is printed if the argument of the log is negative.
604
605double RooAbsPdf::getLogVal(const RooArgSet* nset) const
606{
607 return getLog(getVal(nset), this);
608}
609////////////////////////////////////////////////////////////////////////////////
610/// This function returns the penalty term.
611/// Penalty terms modify the likelihood,during model parameter estimation.This penalty term is usually
612// a function of the model parameters
614{
615 return 0;
616}
617
618////////////////////////////////////////////////////////////////////////////////
619/// Check for infinity or NaN.
620/// \param[in] inputs Array to check
621/// \return True if either infinity or NaN were found.
622namespace {
623template<class T>
624bool checkInfNaNNeg(const T& inputs) {
625 // check for a math error or negative value
626 bool inf = false;
627 bool nan = false;
628 bool neg = false;
629
630 for (double val : inputs) { //CHECK_VECTORISE
631 inf |= !std::isfinite(val);
632 nan |= TMath::IsNaN(val); // Works also during fast math
633 neg |= val < 0;
634 }
635
636 return inf || nan || neg;
637}
638}
639
640
641////////////////////////////////////////////////////////////////////////////////
642/// Scan through outputs and fix+log all nans and negative values.
643/// \param[in,out] outputs Array to be scanned & fixed.
644/// \param[in] begin Begin of event range. Only needed to print the correct event number
645/// where the error occurred.
646void RooAbsPdf::logBatchComputationErrors(std::span<const double>& outputs, std::size_t begin) const {
647 for (unsigned int i=0; i<outputs.size(); ++i) {
648 const double value = outputs[i];
649 if (TMath::IsNaN(outputs[i])) {
650 logEvalError(Form("p.d.f value of (%s) is Not-a-Number (%f) for entry %zu",
651 GetName(), value, begin+i));
652 } else if (!std::isfinite(outputs[i])){
653 logEvalError(Form("p.d.f value of (%s) is (%f) for entry %zu",
654 GetName(), value, begin+i));
655 } else if (outputs[i] < 0.) {
656 logEvalError(Form("p.d.f value of (%s) is less than zero (%f) for entry %zu",
657 GetName(), value, begin+i));
658 }
659 }
660}
661
662
663void RooAbsPdf::getLogProbabilities(std::span<const double> pdfValues, double * output) const {
664 for (std::size_t i = 0; i < pdfValues.size(); ++i) {
665 output[i] = getLog(pdfValues[i], this);
666 }
667}
668
669////////////////////////////////////////////////////////////////////////////////
670/// Return the extended likelihood term (\f$ N_\mathrm{expect} - N_\mathrm{observed} \cdot \log(N_\mathrm{expect} \f$)
671/// of this PDF for the given number of observed events.
672///
673/// For successful operation, the PDF implementation must indicate that
674/// it is extendable by overloading `canBeExtended()`, and must
675/// implement the `expectedEvents()` function.
676///
677/// \param[in] sumEntries The number of observed events.
678/// \param[in] nset The normalization set when asking the pdf for the expected
679/// number of events.
680/// \param[in] sumEntriesW2 The number of observed events when weighting with
681/// squared weights. If non-zero, the weight-squared error
682/// correction is applied to the extended term.
683/// \param[in] doOffset Offset the extended term by a counterterm where the
684/// expected number of events equals the observed number of events.
685/// This constant shift results in a term closer to zero that is
686/// approximately chi-square distributed. It is useful to do this
687/// also when summing multiple NLL terms to avoid numeric precision
688/// loss that happens if you sum multiple terms of different orders
689/// of magnitude.
690///
691/// The weight-squared error correction works as follows:
692/// adjust poisson such that
693/// estimate of \f$N_\mathrm{expect}\f$ stays at the same value, but has a different variance, rescale
694/// both the observed and expected count of the Poisson with a factor \f$ \sum w_{i} / \sum w_{i}^2 \f$
695/// (the effective weight of the Poisson term),
696/// i.e., change \f$\mathrm{Poisson}(N_\mathrm{observed} = \sum w_{i} | N_\mathrm{expect} )\f$
697/// to \f$ \mathrm{Poisson}(\sum w_{i} \cdot \sum w_{i} / \sum w_{i}^2 | N_\mathrm{expect} \cdot \sum w_{i} / \sum w_{i}^2 ) \f$,
698/// weighted by the effective weight \f$ \sum w_{i}^2 / \sum w_{i} \f$ in the likelihood.
699/// Since here we compute the likelihood with the weight square, we need to multiply by the
700/// square of the effective weight:
701/// - \f$ W_\mathrm{expect} = N_\mathrm{expect} \cdot \sum w_{i} / \sum w_{i}^2 \f$ : effective expected entries
702/// - \f$ W_\mathrm{observed} = \sum w_{i} \cdot \sum w_{i} / \sum w_{i}^2 \f$ : effective observed entries
703///
704/// The extended term for the likelihood weighted by the square of the weight will be then:
705///
706/// \f$ \left(\sum w_{i}^2 / \sum w_{i}\right)^2 \cdot W_\mathrm{expect} - (\sum w_{i}^2 / \sum w_{i})^2 \cdot W_\mathrm{observed} \cdot \log{W_\mathrm{expect}} \f$
707///
708/// aund this is using the previous expressions for \f$ W_\mathrm{expect} \f$ and \f$ W_\mathrm{observed} \f$:
709///
710/// \f$ \sum w_{i}^2 / \sum w_{i} \cdot N_\mathrm{expect} - \sum w_{i}^2 \cdot \log{W_\mathrm{expect}} \f$
711///
712/// Since the weights are constants in the likelihood we can use \f$\log{N_\mathrm{expect}}\f$ instead of \f$\log{W_\mathrm{expect}}\f$.
713///
714/// See also RooAbsPdf::extendedTerm(RooAbsData const& data, bool weightSquared, bool doOffset),
715/// which takes a dataset to extract \f$N_\mathrm{observed}\f$ and the
716/// normalization set.
717double RooAbsPdf::extendedTerm(double sumEntries, RooArgSet const* nset, double sumEntriesW2, bool doOffset) const
718{
719 return extendedTerm(sumEntries, expectedEvents(nset), sumEntriesW2, doOffset);
720}
721
722double RooAbsPdf::extendedTerm(double sumEntries, double expected, double sumEntriesW2, bool doOffset) const
723{
724 // check if this PDF supports extended maximum likelihood fits
725 if(!canBeExtended()) {
726 coutE(InputArguments) << GetName() << ": this PDF does not support extended maximum likelihood"
727 << std::endl;
728 return 0.0;
729 }
730
731 if(expected < 0.0) {
732 coutE(InputArguments) << GetName() << ": calculated negative expected events: " << expected
733 << std::endl;
734 logEvalError("extendedTerm #expected events is <0 return a NaN");
735 return TMath::QuietNaN();
736 }
737
738
739 // Explicitly handle case Nobs=Nexp=0
740 if (std::abs(expected)<1e-10 && std::abs(sumEntries)<1e-10) {
741 return 0.0;
742 }
743
744 // Check for errors in Nexpected
745 if (TMath::IsNaN(expected)) {
746 logEvalError("extendedTerm #expected events is a NaN") ;
747 return TMath::QuietNaN() ;
748 }
749
750 double extra = doOffset
751 ? (expected - sumEntries) - sumEntries * (std::log(expected) - std::log(sumEntries))
752 : expected - sumEntries * std::log(expected);
753
754 if(sumEntriesW2 != 0.0) {
755 extra *= sumEntriesW2 / sumEntries;
756 }
757
758 return extra;
759}
760
761////////////////////////////////////////////////////////////////////////////////
762/// Return the extended likelihood term (\f$ N_\mathrm{expect} - N_\mathrm{observed} \cdot \log(N_\mathrm{expect} \f$)
763/// of this PDF for the given number of observed events.
764///
765/// This function is a wrapper around
766/// RooAbsPdf::extendedTerm(double, RooArgSet const *, double, bool) const,
767/// where the number of observed events and observables to be used as the
768/// normalization set for the pdf is extracted from a RooAbsData.
769///
770/// For successful operation, the PDF implementation must indicate that
771/// it is extendable by overloading `canBeExtended()`, and must
772/// implement the `expectedEvents()` function.
773///
774/// \param[in] data The RooAbsData to retrieve the set of observables and
775/// number of expected events.
776/// \param[in] weightSquared If set to `true`, the extended term will be scaled by
777/// the ratio of squared event weights over event weights:
778/// \f$ \sum w_{i}^2 / \sum w_{i} \f$.
779/// Intended to be used by fits with the `SumW2Error()` option that
780/// can be passed to RooAbsPdf::fitTo()
781/// (see the documentation of said function to learn more about the
782/// interpretation of fits with squared weights).
783/// \param[in] doOffset See RooAbsPdf::extendedTerm(double, RooArgSet const*, double, bool) const.
784
785double RooAbsPdf::extendedTerm(RooAbsData const& data, bool weightSquared, bool doOffset) const {
786 double sumW = data.sumEntries();
787 double sumW2 = 0.0;
788 if (weightSquared) {
789 sumW2 = data.sumEntriesW2();
790 }
791 return extendedTerm(sumW, data.get(), sumW2, doOffset);
792}
793
794
795/** @fn RooAbsPdf::createNLL()
796 *
797 * @brief Construct representation of -log(L) of PDF with given dataset.
798 *
799 * If dataset is unbinned, an unbinned likelihood is constructed.
800 * If the dataset is binned, a binned likelihood is constructed.
801 *
802 * @param data Reference to a RooAbsData object representing the dataset.
803 * @param cmdArgs Variadic template arguments representing optional command arguments.
804 * You can pass either an arbitrary number of RooCmdArg instances
805 * or a single RooLinkedList that points to the RooCmdArg objects.
806 * @return An owning pointer to the created RooAbsReal NLL object.
807 *
808 * @tparam CmdArgs_t Template types for optional command arguments.
809 * Can either be an arbitrary number of RooCmdArg or a single RooLinkedList.
810 *
811 * \note This front-end function should not be re-implemented in derived PDF types.
812 * If you mean to customize the NLL creation routine,
813 * you need to override the virtual RooAbsPdf::createNLLImpl() method.
814 *
815 * The following named arguments are supported:
816 *
817 * <table>
818 * <tr><th> Type of CmdArg <th> Effect on NLL
819 * <tr><td> `ConditionalObservables(Args_t &&... argsOrArgSet)` <td> Do not normalize PDF over listed observables.
820 * Arguments can either be multiple RooRealVar or a single RooArgSet containing them.
821 * <tr><td> `Extended(bool flag)` <td> Add extended likelihood term, off by default.
822 * <tr><td> `Range(const char* name)` <td> Fit only data inside range with given name. Multiple comma-separated range names can be specified.
823 * In this case, the unnormalized PDF \f$f(x)\f$ is normalized by the integral over all ranges \f$r_i\f$:
824 * \f[
825 * p(x) = \frac{f(x)}{\sum_i \int_{r_i} f(x) dx}.
826 * \f]
827 * <tr><td> `Range(double lo, double hi)` <td> Fit only data inside given range. A range named "fit" is created on the fly on all observables.
828 * <tr><td> `SumCoefRange(const char* name)` <td> Set the range in which to interpret the coefficients of RooAddPdf components
829 * <tr><td> `NumCPU(int num, int istrat)` <td> Parallelize NLL calculation on num CPUs. (Currently, this setting is ignored with the **cpu** Backend.)
830 * <table>
831 * <tr><th> Strategy <th> Effect
832 * <tr><td> 0 = RooFit::BulkPartition - *default* <td> Divide events in N equal chunks
833 * <tr><td> 1 = RooFit::Interleave <td> Process event i%N in process N. Recommended for binned data with
834 * a substantial number of zero-bins, which will be distributed across processes more equitably in this strategy
835 * <tr><td> 2 = RooFit::SimComponents <td> Process each component likelihood of a RooSimultaneous fully in a single process
836 * and distribute components over processes. This approach can be beneficial if normalization calculation time
837 * dominates the total computation time of a component (since the normalization calculation must be performed
838 * in each process in strategies 0 and 1. However beware that if the RooSimultaneous components do not share many
839 * parameters this strategy is inefficient: as most minuit-induced likelihood calculations involve changing
840 * a single parameter, only 1 of the N processes will be active most of the time if RooSimultaneous components
841 * do not share many parameters
842 * <tr><td> 3 = RooFit::Hybrid <td> Follow strategy 0 for all RooSimultaneous components, except those with less than
843 * 30 dataset entries, for which strategy 2 is followed.
844 * </table>
845 * <tr><td> `EvalBackend(std::string const&)` <td> Choose a likelihood evaluation backend:
846 * <table>
847 * <tr><th> Backend <th> Description
848 * <tr><td> **cpu** - *default* <td> New vectorized evaluation mode, using faster math functions and auto-vectorisation (currently on a single thread).
849 * Since ROOT 6.23, this is the default if `EvalBackend()` is not passed, succeeding the **legacy** backend.
850 * If all RooAbsArg objects in the model support vectorized evaluation,
851 * likelihood computations are 2 to 10 times faster than with the **legacy** backend (each on a single thread).
852 * - unless your dataset is so small that the vectorization is not worth it.
853 * The relative difference of the single log-likelihoods with respect to the legacy mode is usually better than \f$10^{-12}\f$,
854 * and for fit parameters it's usually better than \f$10^{-6}\f$. In past ROOT releases, this backend could be activated with the now deprecated `BatchMode()` option.
855 * <tr><td> **cuda** <td> Evaluate the likelihood on a GPU that supports CUDA.
856 * This backend re-uses code from the **cpu** backend, but compiled in CUDA kernels.
857 * Hence, the results are expected to be identical, modulo some numerical differences that can arise from the different order in which the GPU is summing the log probabilities.
858 * This backend can drastically speed up the fit if all RooAbsArg object in the model support it.
859 * <tr><td> **legacy** <td> The original likelihood evaluation method.
860 * Evaluates the PDF for each single data entry at a time before summing the negative log probabilities.
861 * It supports multi-threading, but you might need more than 20 threads to maybe see about 10% performance gain over the default cpu-backend (that runs currently only on a single thread).
862 * <tr><td> **codegen** <td> **Experimental** - Generates and compiles minimal C++ code for the NLL on-the-fly and wraps it in the returned RooAbsReal.
863 * Also generates and compiles the code for the gradient using Automatic Differentiation (AD) with [Clad](https://github.com/vgvassilev/clad).
864 * This analytic gradient is passed to the minimizer, which can result in significant speedups for many-parameter fits,
865 * even compared to the **cpu** backend. However, if one of the RooAbsArg objects in the model does not support the code generation,
866 * this backend can't be used.
867 * <tr><td> **codegen_no_grad** <td> **Experimental** - Same as **codegen**, but doesn't generate and compile the gradient code and use the regular numerical differentiation instead.
868 * This is expected to be slower, but useful for debugging problems with the analytic gradient.
869 * </table>
870 * <tr><td> `SplitRange(bool flag)` <td> Use separate fit ranges in a simultaneous fit. Actual range name for each subsample is assumed to
871 * be `rangeName_indexState`, where `indexState` is the state of the master index category of the simultaneous fit.
872 * Using `Range("range"), SplitRange()` as switches, different ranges could be set like this:
873 * ```
874 * myVariable.setRange("range_pi0", 135, 210);
875 * myVariable.setRange("range_gamma", 50, 210);
876 * ```
877 * <tr><td> `Constrain(const RooArgSet&pars)` <td> For p.d.f.s that contain internal parameter constraint terms (that is usually product PDFs, where one
878 * term of the product depends on parameters but not on the observable(s),), only apply constraints to the given subset of parameters.
879 * <tr><td> `ExternalConstraints(const RooArgSet& )` <td> Include given external constraints to likelihood by multiplying them with the original likelihood.
880 * <tr><td> `GlobalObservables(const RooArgSet&)` <td> Define the set of normalization observables to be used for the constraint terms.
881 * If none are specified the constrained parameters are used.
882 * <tr><td> `GlobalObservablesSource(const char* sourceName)` <td> Which source to prioritize for global observable values.
883 * Can be either:
884 * - `data`: to take the values from the dataset,
885 * falling back to the pdf value if a given global observable is not available.
886 * If no `GlobalObservables` or `GlobalObservablesTag` command argument is given, the set
887 * of global observables will be automatically defined to be the set stored in the data.
888 * - `model`: to take all values from the pdf and completely ignore the set of global observables stored in the data
889 * (not even using it to automatically define the set of global observables
890 * if the `GlobalObservables` or `GlobalObservablesTag` command arguments are not given).
891 * The default option is `data`.
892 * <tr><td> `GlobalObservablesTag(const char* tagName)` <td> Define the set of normalization observables to be used for the constraint terms by
893 * a string attribute associated with pdf observables that match the given tagName.
894 * <tr><td> `Verbose(bool flag)` <td> Controls RooFit informational messages in likelihood construction
895 * <tr><td> `CloneData(bool flag)` <td> Use clone of dataset in NLL (default is true).
896 * \warning Deprecated option that is ignored. It is up to the implementation of the NLL creation method if the data is cloned or not.
897 * <tr><td> `Offset(std::string const& mode)` <td> Likelihood offsetting mode. Can be either:
898 * <table>
899 * <tr><th> Mode <th> Description
900 * <tr><td> **none** - *default* <td> No offsetting.
901 * <tr><td> **initial** <td> Offset likelihood by initial value (so that starting value of FCN in minuit is zero).
902 * This can improve numeric stability in simultaneous fits with components with large likelihood values.
903 * <tr><td> **bin** <td> Offset likelihood bin-by-bin with a template histogram model based on the obersved data.
904 * This results in per-bin values that are all in the same order of magnitude, which reduces precision loss in the sum,
905 * which can drastically improve numeric stability.
906 * Furthermore, \f$2\cdot \text{NLL}\f$ defined like this is approximately chi-square distributed, allowing for goodness-of-fit tests.
907 * </table>
908 * <tr><td> `IntegrateBins(double precision)` <td> In binned fits, integrate the PDF over the bins instead of using the probability density at the bin centre.
909 * This can reduce the bias observed when fitting functions with high curvature to binned data.
910 * - precision > 0: Activate bin integration everywhere. Use precision between 0.01 and 1.E-6, depending on binning.
911 * Note that a low precision such as 0.01 might yield identical results to 1.E-4, since the integrator might reach 1.E-4 already in its first
912 * integration step. If lower precision is desired (more speed), a RooBinSamplingPdf has to be created manually, and its integrator
913 * has to be manipulated directly.
914 * - precision = 0: Activate bin integration only for continuous PDFs fit to a RooDataHist.
915 * - precision < 0: Deactivate.
916 * \see RooBinSamplingPdf
917 * <tr><td> `ModularL(bool flag)` <td> Enable or disable modular likelihoods, which will become the default in a future release.
918 * This does not change any user-facing code, but only enables a different likelihood class in the back-end. Note that this
919 * should be set to true for parallel minimization of likelihoods!
920 * Note that it is currently not recommended to use Modular likelihoods without any parallelization enabled in the minimization, since
921 * some features such as offsetting might not yet work in this case.
922 * </table>
923 */
924
925
926/** @brief Protected implementation of the NLL creation routine.
927 *
928 * This virtual function can be overridden in case you want to change the NLL creation logic for custom PDFs.
929 *
930 * \note Never call this function directly. Instead, call RooAbsPdf::createNLL().
931 */
932
933std::unique_ptr<RooAbsReal> RooAbsPdf::createNLLImpl(RooAbsData &data, const RooLinkedList &cmdList)
934{
935 return RooFit::FitHelpers::createNLL(*this, data, cmdList);
936}
937
938
939/** @fn RooAbsPdf::fitTo()
940 *
941 * @brief Fit PDF to given dataset.
942 *
943 * If dataset is unbinned, an unbinned maximum likelihood is performed.
944 * If the dataset is binned, a binned maximum likelihood is performed.
945 * By default the fit is executed through the MINUIT commands MIGRAD, HESSE in succession.
946 *
947 * @param data Reference to a RooAbsData object representing the dataset.
948 * @param cmdArgs Variadic template arguments representing optional command arguments.
949 * You can pass either an arbitrary number of RooCmdArg instances
950 * or a single RooLinkedList that points to the RooCmdArg objects.
951 * @return An owning pointer to the created RooAbsReal NLL object.
952 * @return RooFitResult with fit status and parameters if option Save() is used, `nullptr` otherwise. The user takes ownership of the fit result.
953 *
954 * @tparam CmdArgs_t Template types for optional command arguments.
955 * Can either be an arbitrary number of RooCmdArg or a single RooLinkedList.
956 *
957 * \note This front-end function should not be re-implemented in derived PDF types.
958 * If you mean to customize the likelihood fitting routine,
959 * you need to override the virtual RooAbsPdf::fitToImpl() method.
960 *
961 * The following named arguments are supported:
962 *
963 * <table>
964 * <tr><th> Type of CmdArg <th> Options to control construction of -log(L)
965 * <tr><td> <td> All command arguments that can also be passed to the NLL creation method.
966 * \see RooAbsPdf::createNLL()
967 *
968 * <tr><th><th> Options to control flow of fit procedure
969 * <tr><td> `Minimizer("<type>", "<algo>")` <td> Choose minimization package and optionally the algorithm to use. Default is MINUIT/MIGRAD through the RooMinimizer interface,
970 * but others can be specified (through RooMinimizer interface).
971 * <table>
972 * <tr><th> Type <th> Algorithm
973 * <tr><td> Minuit <td> migrad, simplex, minimize (=migrad+simplex), migradimproved (=migrad+improve)
974 * <tr><td> Minuit2 <td> migrad, simplex, minimize, scan
975 * <tr><td> GSLMultiMin <td> conjugatefr, conjugatepr, bfgs, bfgs2, steepestdescent
976 * <tr><td> GSLSimAn <td> -
977 * </table>
978 *
979 * <tr><td> `InitialHesse(bool flag)` <td> Flag controls if HESSE before MIGRAD as well, off by default
980 * <tr><td> `Hesse(bool flag)` <td> Flag controls if HESSE is run after MIGRAD, on by default
981 * <tr><td> `Minos(bool flag)` <td> Flag controls if MINOS is run after HESSE, off by default
982 * <tr><td> `Minos(const RooArgSet& set)` <td> Only run MINOS on given subset of arguments
983 * <tr><td> `Save(bool flag)` <td> Flag controls if RooFitResult object is produced and returned, off by default
984 * <tr><td> `Strategy(Int_t flag)` <td> Set Minuit strategy (0 to 2, default is 1)
985 * <tr><td> `MaxCalls(int n)` <td> Change maximum number of likelihood function calls from MINUIT (if `n <= 0`, the default of 500 * #%parameters is used)
986 * <tr><td> `EvalErrorWall(bool flag=true)` <td> When parameters are in disallowed regions (e.g. PDF is negative), return very high value to fitter
987 * to force it out of that region. This can, however, mean that the fitter gets lost in this region. If
988 * this happens, try switching it off.
989 * <tr><td> `RecoverFromUndefinedRegions(double strength)` <td> When PDF is invalid (e.g. parameter in undefined region), try to direct minimiser away from that region.
990 * `strength` controls the magnitude of the penalty term. Leaving out this argument defaults to 10. Switch off with `strength = 0.`.
991 *
992 * <tr><td> `SumW2Error(bool flag)` <td> Apply correction to errors and covariance matrix.
993 * This uses two covariance matrices, one with the weights, the other with squared weights,
994 * to obtain the correct errors for weighted likelihood fits. If this option is activated, the
995 * corrected covariance matrix is calculated as \f$ V_\mathrm{corr} = V C^{-1} V \f$, where \f$ V \f$ is the original
996 * covariance matrix and \f$ C \f$ is the inverse of the covariance matrix calculated using the
997 * squared weights. This allows to switch between two interpretations of errors:
998 * <table>
999 * <tr><th> SumW2Error <th> Interpretation
1000 * <tr><td> true <td> The errors reflect the uncertainty of the Monte Carlo simulation.
1001 * Use this if you want to know how much accuracy you can get from the available Monte Carlo statistics.
1002 *
1003 * **Example**: Simulation with 1000 events, the average weight is 0.1.
1004 * The errors are as big as if one fitted to 1000 events.
1005 * <tr><td> false <td> The errors reflect the errors of a dataset, which is as big as the sum of weights.
1006 * Use this if you want to know what statistical errors you would get if you had a dataset with as many
1007 * events as the (weighted) Monte Carlo simulation represents.
1008 *
1009 * **Example** (Data as above):
1010 * The errors are as big as if one fitted to 100 events.
1011 * </table>
1012 * \note If the `SumW2Error` correction is enabled, the covariance matrix quality stored in the RooFitResult
1013 * object will be the minimum of the original covariance matrix quality and the quality of the covariance
1014 * matrix calculated with the squared weights.
1015 * <tr><td> `AsymptoticError()` <td> Use the asymptotically correct approach to estimate errors in the presence of weights.
1016 * This is slower but more accurate than `SumW2Error`. See also https://arxiv.org/abs/1911.01303).
1017 This option even correctly implements the case of extended likelihood fits
1018 (see this [writeup on extended weighted fits](https://root.cern/files/extended_weighted_fits.pdf) that complements the paper linked before).
1019 * <tr><td> `PrefitDataFraction(double fraction)`
1020 * <td> Runs a prefit on a small dataset of size fraction*(actual data size). This can speed up fits
1021 * by finding good starting values for the parameters for the actual fit.
1022 * \warning Prefitting may give bad results when used in binned analysis.
1023 *
1024 * <tr><th><th> Options to control informational output
1025 * <tr><td> `Verbose(bool flag)` <td> Flag controls if verbose output is printed (NLL, parameter changes during fit).
1026 * <tr><td> `Timer(bool flag)` <td> Time CPU and wall clock consumption of fit steps, off by default.
1027 * <tr><td> `PrintLevel(Int_t level)` <td> Set Minuit print level (-1 to 3, default is 1). At -1 all RooFit informational messages are suppressed as well.
1028 * See RooMinimizer::PrintLevel for the meaning of the levels.
1029 * <tr><td> `Warnings(bool flag)` <td> Enable or disable MINUIT warnings (enabled by default)
1030 * <tr><td> `PrintEvalErrors(Int_t numErr)` <td> Control number of p.d.f evaluation errors printed per likelihood evaluation.
1031 * A negative value suppresses output completely, a zero value will only print the error count per p.d.f component,
1032 * a positive value will print details of each error up to `numErr` messages per p.d.f component.
1033 * <tr><td> `Parallelize(Int_t nWorkers)` <td> Control global parallelization settings. Arguments 1 and above enable the use of RooFit's parallel minimization
1034 * backend and uses the number given as the number of workers to use in the parallelization. -1 also enables
1035 * RooFit's parallel minimization backend, and sets the number of workers to the number of available processes.
1036 * 0 disables this feature.
1037 * In case parallelization is requested, this option implies `ModularL(true)` in the internal call to the NLL creation method.
1038 * <tr><td> `ParallelGradientOptions(bool enable=true, int orderStrategy=0, int chainFactor=1)` <td> **Experimental** - Control gradient parallelization settings. The first argument
1039 * only disables or enables gradient parallelization, this is on by default.
1040 * The second argument determines the internal partial derivative calculation
1041 * ordering strategy. The third argument determines the number of partial
1042 * derivatives that are executed per task package on each worker.
1043 * <tr><td> `ParallelDescentOptions(bool enable=false, int splitStrategy=0, int numSplits=4)` <td> **Experimental** - Control settings related to the parallelization of likelihoods
1044 * outside of the gradient calculation but in the minimization, most prominently
1045 * in the linesearch step. The first argument this disables or enables likelihood
1046 * parallelization. The second argument determines whether to split the task batches
1047 * per event or per likelihood component. And the third argument how many events or
1048 * respectively components to include in each batch.
1049 * <tr><td> `TimingAnalysis(bool flag)` <td> **Experimental** - Log timings. This feature logs timings with NewStyle likelihoods on multiple processes simultaneously
1050 * and outputs the timings at the end of a run to json log files, which can be analyzed with the
1051 * `RooFit::MultiProcess::HeatmapAnalyzer`. Only works with simultaneous likelihoods.
1052 * </table>
1053 */
1054
1055
1056/** @brief Protected implementation of the likelihood fitting routine.
1057 *
1058 * This virtual function can be overridden in case you want to change the likelihood fitting logic for custom PDFs.
1059 *
1060 * \note Never call this function directly. Instead, call RooAbsPdf::fitTo().
1061 */
1062
1063std::unique_ptr<RooFitResult> RooAbsPdf::fitToImpl(RooAbsData& data, const RooLinkedList& cmdList)
1064{
1065 return RooFit::FitHelpers::fitTo(*this, data, cmdList, false);
1066}
1067
1068
1069////////////////////////////////////////////////////////////////////////////////
1070/// Print value of p.d.f, also print normalization integral that was last used, if any
1071
1072void RooAbsPdf::printValue(ostream& os) const
1073{
1074 // silent warning messages coming when evaluating a RooAddPdf without a normalization set
1076
1077 getVal() ;
1078
1079 if (_norm) {
1080 os << getVal() << "/" << _norm->getVal() ;
1081 } else {
1082 os << getVal();
1083 }
1084}
1085
1086
1087
1088////////////////////////////////////////////////////////////////////////////////
1089/// Print multi line detailed information of this RooAbsPdf
1090
1091void RooAbsPdf::printMultiline(ostream& os, Int_t contents, bool verbose, TString indent) const
1092{
1093 RooAbsReal::printMultiline(os,contents,verbose,indent);
1094 os << indent << "--- RooAbsPdf ---" << std::endl;
1095 os << indent << "Cached value = " << _value << std::endl ;
1096 if (_norm) {
1097 os << indent << " Normalization integral: " << std::endl ;
1098 auto moreIndent = std::string(indent.Data()) + " " ;
1100 }
1101}
1102
1103
1104
1105////////////////////////////////////////////////////////////////////////////////
1106/// Return a binned generator context
1107
1109{
1110 return new RooBinnedGenContext(*this,vars,nullptr,nullptr,verbose) ;
1111}
1112
1113
1114////////////////////////////////////////////////////////////////////////////////
1115/// Interface function to create a generator context from a p.d.f. This default
1116/// implementation returns a 'standard' context that works for any p.d.f
1117
1119 const RooArgSet* auxProto, bool verbose) const
1120{
1121 return new RooGenContext(*this,vars,prototype,auxProto,verbose) ;
1122}
1123
1124
1125////////////////////////////////////////////////////////////////////////////////
1126
1128 bool verbose, bool autoBinned, const char* binnedTag) const
1129{
1130 if (prototype || (auxProto && !auxProto->empty())) {
1131 return genContext(vars,prototype,auxProto,verbose);
1132 }
1133
1134 RooAbsGenContext *context(nullptr) ;
1135 if ( (autoBinned && isBinnedDistribution(vars)) || ( binnedTag && strlen(binnedTag) && (getAttribute(binnedTag)||string(binnedTag)=="*"))) {
1136 context = binnedGenContext(vars,verbose) ;
1137 } else {
1138 context= genContext(vars,nullptr,nullptr,verbose);
1139 }
1140 return context ;
1141}
1142
1143
1144
1145////////////////////////////////////////////////////////////////////////////////
1146/// Generate a new dataset containing the specified variables with events sampled from our distribution.
1147/// Generate the specified number of events or expectedEvents() if not specified.
1148/// \param[in] whatVars Choose variables in which to generate events. Variables not listed here will remain
1149/// constant and not be used for event generation.
1150/// \param[in] arg1,arg2,arg3,arg4,arg5,arg6 Optional RooCmdArg() to change behaviour of generate().
1151/// \return RooDataSet *, owned by caller.
1152///
1153/// Any variables of this PDF that are not in whatVars will use their
1154/// current values and be treated as fixed parameters. Returns zero
1155/// in case of an error.
1156///
1157/// <table>
1158/// <tr><th> Type of CmdArg <th> Effect on generate
1159/// <tr><td> `Name(const char* name)` <td> Name of the output dataset
1160/// <tr><td> `Verbose(bool flag)` <td> Print informational messages during event generation
1161/// <tr><td> `NumEvents(int nevt)` <td> Generate specified number of events
1162/// <tr><td> `Extended()` <td> If no number of events to be generated is given,
1163/// use expected number of events from extended likelihood term.
1164/// This evidently only works for extended PDFs.
1165/// <tr><td> `GenBinned(const char* tag)` <td> Use binned generation for all component pdfs that have 'setAttribute(tag)' set
1166/// <tr><td> `AutoBinned(bool flag)` <td> Automatically deploy binned generation for binned distributions (e.g. RooHistPdf, sums and products of
1167/// RooHistPdfs etc)
1168/// \note Datasets that are generated in binned mode are returned as weighted unbinned datasets. This means that
1169/// for each bin, there will be one event in the dataset with a weight corresponding to the (possibly randomised) bin content.
1170///
1171///
1172/// <tr><td> `AllBinned()` <td> As above, but for all components.
1173/// \note The notion of components is only meaningful for simultaneous PDFs
1174/// as binned generation is always executed at the top-level node for a regular
1175/// PDF, so for those it only mattes that the top-level node is tagged.
1176///
1177/// <tr><td> ProtoData(const RooAbsData& data, bool randOrder)
1178/// <td> Use specified dataset as prototype dataset. If randOrder in ProtoData() is set to true,
1179/// the order of the events in the dataset will be read in a random order if the requested
1180/// number of events to be generated does not match the number of events in the prototype dataset.
1181/// \note If ProtoData() is used, the specified existing dataset as a prototype: the new dataset will contain
1182/// the same number of events as the prototype (unless otherwise specified), and any prototype variables not in
1183/// whatVars will be copied into the new dataset for each generated event and also used to set our PDF parameters.
1184/// The user can specify a number of events to generate that will override the default. The result is a
1185/// copy of the prototype dataset with only variables in whatVars randomized. Variables in whatVars that
1186/// are not in the prototype will be added as new columns to the generated dataset.
1187///
1188/// </table>
1189///
1190/// #### Accessing the underlying event generator
1191/// Depending on the fit model (if it is difficult to sample), it may be necessary to change generator settings.
1192/// For the default generator (RooFoamGenerator), the number of samples or cells could be increased by e.g. using
1193/// myPdf->specialGeneratorConfig()->getConfigSection("RooFoamGenerator").setRealValue("nSample",1e4);
1194///
1195/// The foam generator e.g. has the following config options:
1196/// - nCell[123N]D
1197/// - nSample
1198/// - chatLevel
1199/// \see rf902_numgenconfig.C
1200
1202 const RooCmdArg& arg3,const RooCmdArg& arg4, const RooCmdArg& arg5,const RooCmdArg& arg6)
1203{
1204 // Select the pdf-specific commands
1205 RooCmdConfig pc("RooAbsPdf::generate(" + std::string(GetName()) + ")");
1206 pc.defineObject("proto","PrototypeData",0,nullptr) ;
1207 pc.defineString("dsetName","Name",0,"") ;
1208 pc.defineInt("randProto","PrototypeData",0,0) ;
1209 pc.defineInt("resampleProto","PrototypeData",1,0) ;
1210 pc.defineInt("verbose","Verbose",0,0) ;
1211 pc.defineInt("extended","Extended",0,0) ;
1212 pc.defineInt("nEvents","NumEvents",0,0) ;
1213 pc.defineInt("autoBinned","AutoBinned",0,1) ;
1214 pc.defineInt("expectedData","ExpectedData",0,0) ;
1215 pc.defineDouble("nEventsD","NumEventsD",0,-1.) ;
1216 pc.defineString("binnedTag","GenBinned",0,"") ;
1217 pc.defineMutex("GenBinned","ProtoData") ;
1218 pc.defineMutex("Extended", "NumEvents");
1219
1220 // Process and check varargs
1222 if (!pc.ok(true)) {
1223 return nullptr;
1224 }
1225
1226 // Decode command line arguments
1227 RooDataSet* protoData = static_cast<RooDataSet*>(pc.getObject("proto",nullptr)) ;
1228 const char* dsetName = pc.getString("dsetName") ;
1229 bool verbose = pc.getInt("verbose") ;
1230 bool randProto = pc.getInt("randProto") ;
1231 bool resampleProto = pc.getInt("resampleProto") ;
1232 bool extended = pc.getInt("extended") ;
1233 bool autoBinned = pc.getInt("autoBinned") ;
1234 const char* binnedTag = pc.getString("binnedTag") ;
1235 Int_t nEventsI = pc.getInt("nEvents") ;
1236 double nEventsD = pc.getInt("nEventsD") ;
1237 //bool verbose = pc.getInt("verbose") ;
1238 bool expectedData = pc.getInt("expectedData") ;
1239
1240 double nEvents = (nEventsD>0) ? nEventsD : double(nEventsI);
1241
1242 // Force binned mode for expected data mode
1243 if (expectedData) {
1244 binnedTag="*" ;
1245 }
1246
1247 if (extended) {
1248 if (nEvents == 0) nEvents = expectedEvents(&whatVars);
1249 } else if (nEvents==0) {
1250 cxcoutI(Generation) << "No number of events specified , number of events generated is "
1251 << GetName() << "::expectedEvents() = " << expectedEvents(&whatVars)<< std::endl ;
1252 }
1253
1254 if (extended && protoData && !randProto) {
1255 cxcoutI(Generation) << "WARNING Using generator option Extended() (Poisson distribution of #events) together "
1256 << "with a prototype dataset implies incomplete sampling or oversampling of proto data. "
1257 << "Set randomize flag in ProtoData() option to randomize prototype dataset order and thus "
1258 << "to randomize the set of over/undersampled prototype events for each generation cycle." << std::endl ;
1259 }
1260
1261
1262 // Forward to appropriate implementation
1263 std::unique_ptr<RooDataSet> data;
1264 if (protoData) {
1265 data = std::unique_ptr<RooDataSet>{generate(whatVars,*protoData,Int_t(nEvents),verbose,randProto,resampleProto)};
1266 } else {
1267 data = std::unique_ptr<RooDataSet>{generate(whatVars,nEvents,verbose,autoBinned,binnedTag,expectedData, extended)};
1268 }
1269
1270 // Rename dataset to given name if supplied
1271 if (dsetName && strlen(dsetName)>0) {
1272 data->SetName(dsetName) ;
1273 }
1274
1275 return RooFit::makeOwningPtr(std::move(data));
1276}
1277
1278
1279
1280
1281
1282
1283////////////////////////////////////////////////////////////////////////////////
1284/// \note This method does not perform any generation. To generate according to generations specification call RooAbsPdf::generate(RooAbsPdf::GenSpec&) const
1285///
1286/// Details copied from RooAbsPdf::generate():
1287/// --------------------------------------------
1288/// \copydetails RooAbsPdf::generate(const RooArgSet&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&)
1289
1291 const RooCmdArg& arg1,const RooCmdArg& arg2,
1292 const RooCmdArg& arg3,const RooCmdArg& arg4,
1293 const RooCmdArg& arg5,const RooCmdArg& arg6)
1294{
1295
1296 // Select the pdf-specific commands
1297 RooCmdConfig pc("RooAbsPdf::generate(" + std::string(GetName()) + ")");
1298 pc.defineObject("proto","PrototypeData",0,nullptr) ;
1299 pc.defineString("dsetName","Name",0,"") ;
1300 pc.defineInt("randProto","PrototypeData",0,0) ;
1301 pc.defineInt("resampleProto","PrototypeData",1,0) ;
1302 pc.defineInt("verbose","Verbose",0,0) ;
1303 pc.defineInt("extended","Extended",0,0) ;
1304 pc.defineInt("nEvents","NumEvents",0,0) ;
1305 pc.defineInt("autoBinned","AutoBinned",0,1) ;
1306 pc.defineString("binnedTag","GenBinned",0,"") ;
1307 pc.defineMutex("GenBinned","ProtoData") ;
1308
1309
1310 // Process and check varargs
1312 if (!pc.ok(true)) {
1313 return nullptr ;
1314 }
1315
1316 // Decode command line arguments
1317 RooDataSet* protoData = static_cast<RooDataSet*>(pc.getObject("proto",nullptr)) ;
1318 const char* dsetName = pc.getString("dsetName") ;
1319 Int_t nEvents = pc.getInt("nEvents") ;
1320 bool verbose = pc.getInt("verbose") ;
1321 bool randProto = pc.getInt("randProto") ;
1322 bool resampleProto = pc.getInt("resampleProto") ;
1323 bool extended = pc.getInt("extended") ;
1324 bool autoBinned = pc.getInt("autoBinned") ;
1325 const char* binnedTag = pc.getString("binnedTag") ;
1326
1328
1329 return new GenSpec(cx,whatVars,protoData,nEvents,extended,randProto,resampleProto,dsetName) ;
1330}
1331
1332
1333////////////////////////////////////////////////////////////////////////////////
1334/// If many identical generation requests
1335/// are needed, e.g. in toy MC studies, it is more efficient to use the prepareMultiGen()/generate()
1336/// combination than calling the standard generate() multiple times as
1337/// initialization overhead is only incurred once.
1338
1340{
1341 //Int_t nEvt = spec._extended ? RooRandom::randomGenerator()->Poisson(spec._nGen) : spec._nGen ;
1342 //Int_t nEvt = spec._extended ? RooRandom::randomGenerator()->Poisson(spec._nGen==0?expectedEvents(spec._whatVars):spec._nGen) : spec._nGen ;
1343 //Int_t nEvt = spec._nGen == 0 ? RooRandom::randomGenerator()->Poisson(expectedEvents(spec._whatVars)) : spec._nGen;
1344
1345 double nEvt = spec._nGen == 0 ? expectedEvents(spec._whatVars) : spec._nGen;
1346
1347 std::unique_ptr<RooDataSet> ret{generate(*spec._genContext,spec._whatVars,spec._protoData, nEvt,false,spec._randProto,spec._resampleProto,
1348 spec._init,spec._extended)};
1349 spec._init = true ;
1350 return RooFit::makeOwningPtr(std::move(ret));
1351}
1352
1353
1354
1355
1356
1357////////////////////////////////////////////////////////////////////////////////
1358/// Generate a new dataset containing the specified variables with
1359/// events sampled from our distribution.
1360///
1361/// \param[in] whatVars Generate a dataset with the variables (and categories) in this set.
1362/// Any variables of this PDF that are not in `whatVars` will use their
1363/// current values and be treated as fixed parameters.
1364/// \param[in] nEvents Generate the specified number of events or else try to use
1365/// expectedEvents() if nEvents <= 0 (default).
1366/// \param[in] verbose Show which generator strategies are being used.
1367/// \param[in] autoBinned If original distribution is binned, return bin centers and randomise weights
1368/// instead of generating single events.
1369/// \param[in] binnedTag
1370/// \param[in] expectedData Call setExpectedData on the genContext.
1371/// \param[in] extended Randomise number of events generated according to Poisson(nEvents). Only useful
1372/// if PDF is extended.
1373/// \return New dataset. Returns zero in case of an error. The caller takes ownership of the returned
1374/// dataset.
1375
1376RooFit::OwningPtr<RooDataSet> RooAbsPdf::generate(const RooArgSet &whatVars, double nEvents, bool verbose, bool autoBinned, const char* binnedTag, bool expectedData, bool extended) const
1377{
1378 if (nEvents==0 && extendMode()==CanNotBeExtended) {
1379 return RooFit::makeOwningPtr(std::make_unique<RooDataSet>("emptyData","emptyData",whatVars));
1380 }
1381
1382 // Request for binned generation
1383 std::unique_ptr<RooAbsGenContext> context{autoGenContext(whatVars,nullptr,nullptr,verbose,autoBinned,binnedTag)};
1384 if (expectedData) {
1385 context->setExpectedData(true) ;
1386 }
1387
1388 std::unique_ptr<RooDataSet> generated;
1389 if(nullptr != context && context->isValid()) {
1390 generated = std::unique_ptr<RooDataSet>{context->generate(nEvents, false, extended)};
1391 }
1392 else {
1393 coutE(Generation) << "RooAbsPdf::generate(" << GetName() << ") cannot create a valid context" << std::endl;
1394 }
1395 return RooFit::makeOwningPtr(std::move(generated));
1396}
1397
1398
1399
1400
1401////////////////////////////////////////////////////////////////////////////////
1402/// Internal method
1403
1404std::unique_ptr<RooDataSet> RooAbsPdf::generate(RooAbsGenContext& context, const RooArgSet &whatVars, const RooDataSet *prototype,
1405 double nEvents, bool /*verbose*/, bool randProtoOrder, bool resampleProto,
1406 bool skipInit, bool extended) const
1407{
1408 if (nEvents==0 && (prototype==nullptr || prototype->numEntries()==0)) {
1409 return std::make_unique<RooDataSet>("emptyData","emptyData",whatVars);
1410 }
1411
1412 std::unique_ptr<RooDataSet> generated;
1413
1414 // Resampling implies reshuffling in the implementation
1415 if (resampleProto) {
1417 }
1418
1419 if (randProtoOrder && prototype && prototype->numEntries()!=nEvents) {
1420 coutI(Generation) << "RooAbsPdf::generate (Re)randomizing event order in prototype dataset (Nevt=" << nEvents << ")" << std::endl ;
1421 Int_t* newOrder = randomizeProtoOrder(prototype->numEntries(),Int_t(nEvents),resampleProto) ;
1422 context.setProtoDataOrder(newOrder) ;
1423 delete[] newOrder ;
1424 }
1425
1426 if(context.isValid()) {
1427 generated = std::unique_ptr<RooDataSet>{context.generate(nEvents,skipInit,extended)};
1428 }
1429 else {
1430 coutE(Generation) << "RooAbsPdf::generate(" << GetName() << ") do not have a valid generator context" << std::endl;
1431 }
1432 return generated;
1433}
1434
1435
1436
1437
1438////////////////////////////////////////////////////////////////////////////////
1439/// Generate a new dataset using a prototype dataset as a model,
1440/// with values of the variables in `whatVars` sampled from our distribution.
1441///
1442/// \param[in] whatVars Generate for these variables.
1443/// \param[in] prototype Use this dataset
1444/// as a prototype: the new dataset will contain the same number of
1445/// events as the prototype (by default), and any prototype variables not in
1446/// whatVars will be copied into the new dataset for each generated
1447/// event and also used to set our PDF parameters. The user can specify a
1448/// number of events to generate that will override the default. The result is a
1449/// copy of the prototype dataset with only variables in whatVars
1450/// randomized. Variables in whatVars that are not in the prototype
1451/// will be added as new columns to the generated dataset.
1452/// \param[in] nEvents Number of events to generate. Defaults to 0, which means number
1453/// of event in prototype dataset.
1454/// \param[in] verbose Show which generator strategies are being used.
1455/// \param[in] randProtoOrder Randomise order of retrieval of events from proto dataset.
1456/// \param[in] resampleProto Resample from the proto dataset.
1457/// \return The new dataset. Returns zero in case of an error. The caller takes ownership of the
1458/// returned dataset.
1459
1461 Int_t nEvents, bool verbose, bool randProtoOrder, bool resampleProto) const
1462{
1463 std::unique_ptr<RooAbsGenContext> context{genContext(whatVars,&prototype,nullptr,verbose)};
1464 if (context) {
1466 }
1467 coutE(Generation) << "RooAbsPdf::generate(" << GetName() << ") ERROR creating generator context" << std::endl ;
1468 return nullptr;
1469}
1470
1471
1472
1473////////////////////////////////////////////////////////////////////////////////
1474/// Return lookup table with randomized order for nProto prototype events.
1475
1477{
1478 // Make output list
1479 Int_t* lut = new Int_t[nProto] ;
1480
1481 // Randomly sample input list into output list
1482 if (!resampleProto) {
1483 // In this mode, randomization is a strict reshuffle of the order
1484 std::iota(lut, lut + nProto, 0); // fill the vector with 0 to nProto - 1
1485 // Shuffle code taken from https://en.cppreference.com/w/cpp/algorithm/random_shuffle.
1486 // The std::random_shuffle function was deprecated in C++17. We could have
1487 // used std::shuffle instead, but this is not straight-forward to use with
1488 // RooRandom::integer() and we didn't want to change the random number
1489 // generator. It might cause unwanted effects like reproducibility problems.
1490 for (int i = nProto-1; i > 0; --i) {
1491 std::swap(lut[i], lut[RooRandom::integer(i+1)]);
1492 }
1493 } else {
1494 // In this mode, we resample, i.e. events can be used more than once
1495 std::generate(lut, lut + nProto, [&]{ return RooRandom::integer(nProto); });
1496 }
1497
1498
1499 return lut ;
1500}
1501
1502
1503
1504////////////////////////////////////////////////////////////////////////////////
1505/// Load generatedVars with the subset of directVars that we can generate events for,
1506/// and return a code that specifies the generator algorithm we will use. A code of
1507/// zero indicates that we cannot generate any of the directVars (in this case, nothing
1508/// should be added to generatedVars). Any non-zero codes will be passed to our generateEvent()
1509/// implementation, but otherwise its value is arbitrary. The default implementation of
1510/// this method returns zero. Subclasses will usually implement this method using the
1511/// matchArgs() methods to advertise the algorithms they provide.
1512
1513Int_t RooAbsPdf::getGenerator(const RooArgSet &/*directVars*/, RooArgSet &/*generatedVars*/, bool /*staticInitOK*/) const
1514{
1515 return 0 ;
1516}
1517
1518
1519
1520////////////////////////////////////////////////////////////////////////////////
1521/// Interface for one-time initialization to setup the generator for the specified code.
1522
1524{
1525}
1526
1527
1528
1529////////////////////////////////////////////////////////////////////////////////
1530/// Interface for generation of an event using the algorithm
1531/// corresponding to the specified code. The meaning of each code is
1532/// defined by the getGenerator() implementation. The default
1533/// implementation does nothing.
1534
1536{
1537}
1538
1539
1540
1541////////////////////////////////////////////////////////////////////////////////
1542/// Check if given observable can be safely generated using the
1543/// pdfs internal generator mechanism (if that existsP). Observables
1544/// on which a PDF depends via more than route are not safe
1545/// for use with internal generators because they introduce
1546/// correlations not known to the internal generator
1547
1549{
1550 // Arg must be direct server of self
1551 if (!findServer(arg.GetName())) return false ;
1552
1553 // There must be no other dependency routes
1554 for (const auto server : _serverList) {
1555 if(server == &arg) continue;
1556 if(server->dependsOn(arg)) {
1557 return false ;
1558 }
1559 }
1560
1561 return true ;
1562}
1563
1564
1565////////////////////////////////////////////////////////////////////////////////
1566/// Generate a new dataset containing the specified variables with events sampled from our distribution.
1567/// \param[in] whatVars Choose variables in which to generate events. Variables not listed here will remain
1568/// constant and not be used for event generation
1569/// \param[in] arg1,arg2,arg3,arg4,arg5,arg6 Optional RooCmdArg to change behaviour of generateBinned()
1570/// \return RooDataHist *, to be managed by caller.
1571///
1572/// Generate the specified number of events or expectedEvents() if not specified.
1573///
1574/// Any variables of this PDF that are not in whatVars will use their
1575/// current values and be treated as fixed parameters. Returns zero
1576/// in case of an error. The caller takes ownership of the returned
1577/// dataset.
1578///
1579/// The following named arguments are supported
1580/// | Type of CmdArg | Effect on generation
1581/// |---------------------------|-----------------------
1582/// | `Name(const char* name)` | Name of the output dataset
1583/// | `Verbose(bool flag)` | Print informational messages during event generation
1584/// | `NumEvents(int nevt)` | Generate specified number of events
1585/// | `Extended()` | The actual number of events generated will be sampled from a Poisson distribution with mu=nevt. This can be *much* faster for peaked PDFs, but the number of events is not exactly what was requested.
1586/// | `ExpectedData()` | Return a binned dataset _without_ statistical fluctuations (also aliased as Asimov())
1587///
1588
1590 const RooCmdArg& arg3,const RooCmdArg& arg4, const RooCmdArg& arg5,const RooCmdArg& arg6) const
1591{
1592
1593 // Select the pdf-specific commands
1594 RooCmdConfig pc("RooAbsPdf::generate(" + std::string(GetName()) + ")");
1595 pc.defineString("dsetName","Name",0,"") ;
1596 pc.defineInt("verbose","Verbose",0,0) ;
1597 pc.defineInt("extended","Extended",0,0) ;
1598 pc.defineInt("nEvents","NumEvents",0,0) ;
1599 pc.defineDouble("nEventsD","NumEventsD",0,-1.) ;
1600 pc.defineInt("expectedData","ExpectedData",0,0) ;
1601
1602 // Process and check varargs
1604 if (!pc.ok(true)) {
1605 return nullptr;
1606 }
1607
1608 // Decode command line arguments
1609 double nEvents = pc.getDouble("nEventsD") ;
1610 if (nEvents<0) {
1611 nEvents = pc.getInt("nEvents") ;
1612 }
1613 //bool verbose = pc.getInt("verbose") ;
1614 bool extended = pc.getInt("extended") ;
1615 bool expectedData = pc.getInt("expectedData") ;
1616 const char* dsetName = pc.getString("dsetName") ;
1617
1618 if (extended) {
1619 //nEvents = (nEvents==0?Int_t(expectedEvents(&whatVars)+0.5):nEvents) ;
1620 nEvents = (nEvents==0 ? expectedEvents(&whatVars) :nEvents) ;
1621 cxcoutI(Generation) << " Extended mode active, number of events generated (" << nEvents << ") is Poisson fluctuation on "
1622 << GetName() << "::expectedEvents() = " << nEvents << std::endl ;
1623 // If Poisson fluctuation results in zero events, stop here
1624 if (nEvents==0) {
1625 return nullptr ;
1626 }
1627 } else if (nEvents==0) {
1628 cxcoutI(Generation) << "No number of events specified , number of events generated is "
1629 << GetName() << "::expectedEvents() = " << expectedEvents(&whatVars)<< std::endl ;
1630 }
1631
1632 // Forward to appropriate implementation
1634
1635 // Rename dataset to given name if supplied
1636 if (dsetName && strlen(dsetName)>0) {
1637 data->SetName(dsetName) ;
1638 }
1639
1640 return data;
1641}
1642
1643
1644
1645
1646////////////////////////////////////////////////////////////////////////////////
1647/// Generate a new dataset containing the specified variables with
1648/// events sampled from our distribution.
1649///
1650/// \param[in] whatVars Variables that values should be generated for.
1651/// \param[in] nEvents How many events to generate. If `nEvents <=0`, use the value returned by expectedEvents() as target.
1652/// \param[in] expectedData If set to true (false by default), the returned histogram returns the 'expected'
1653/// data sample, i.e. no statistical fluctuations are present.
1654/// \param[in] extended For each bin, generate Poisson(x, mu) events, where `mu` is chosen such that *on average*,
1655/// one would obtain `nEvents` events. This means that the true number of events will fluctuate around the desired value,
1656/// but the generation happens a lot faster.
1657/// Especially if the PDF is sharply peaked, the multinomial event generation necessary to generate *exactly* `nEvents` events can
1658/// be very slow.
1659///
1660/// The binning used for generation of events is the currently set binning for the variables.
1661/// It can e.g. be changed using
1662/// ```
1663/// x.setBins(15);
1664/// x.setRange(-5., 5.);
1665/// pdf.generateBinned(RooArgSet(x), 1000);
1666/// ```
1667///
1668/// Any variables of this PDF that are not in `whatVars` will use their
1669/// current values and be treated as fixed parameters.
1670/// \return RooDataHist* owned by the caller. Returns `nullptr` in case of an error.
1672{
1673 // Create empty RooDataHist
1674 auto hist = std::make_unique<RooDataHist>("genData","genData",whatVars);
1675
1676 // Scale to number of events and introduce Poisson fluctuations
1677 if (nEvents<=0) {
1678 if (!canBeExtended()) {
1679 coutE(InputArguments) << "RooAbsPdf::generateBinned(" << GetName() << ") ERROR: No event count provided and p.d.f does not provide expected number of events" << std::endl ;
1680 return nullptr;
1681 } else {
1682
1683 // Don't round in expectedData or extended mode
1684 if (expectedData || extended) {
1685 nEvents = expectedEvents(&whatVars) ;
1686 } else {
1687 nEvents = std::round(expectedEvents(&whatVars));
1688 }
1689 }
1690 }
1691
1692 // Sample p.d.f. distribution
1693 fillDataHist(hist.get(),&whatVars,1,true) ;
1694
1695 vector<int> histOut(hist->numEntries()) ;
1696 double histMax(-1) ;
1697 Int_t histOutSum(0) ;
1698 for (int i=0 ; i<hist->numEntries() ; i++) {
1699 hist->get(i) ;
1700 if (expectedData) {
1701
1702 // Expected data, multiply p.d.f by nEvents
1703 double w=hist->weight()*nEvents ;
1704 hist->set(i, w, sqrt(w));
1705
1706 } else if (extended) {
1707
1708 // Extended mode, set contents to Poisson(pdf*nEvents)
1709 double w = RooRandom::randomGenerator()->Poisson(hist->weight()*nEvents) ;
1710 hist->set(w,sqrt(w)) ;
1711
1712 } else {
1713
1714 // Regular mode, fill array of weights with Poisson(pdf*nEvents), but to not fill
1715 // histogram yet.
1716 if (hist->weight()>histMax) {
1717 histMax = hist->weight() ;
1718 }
1719 histOut[i] = RooRandom::randomGenerator()->Poisson(hist->weight()*nEvents) ;
1720 histOutSum += histOut[i] ;
1721 }
1722 }
1723
1724
1725 if (!expectedData && !extended) {
1726
1727 // Second pass for regular mode - Trim/Extend dataset to exact number of entries
1728
1729 // Calculate difference between what is generated so far and what is requested
1730 Int_t nEvtExtra = std::abs(Int_t(nEvents)-histOutSum) ;
1731 Int_t wgt = (histOutSum>nEvents) ? -1 : 1 ;
1732
1733 // Perform simple binned accept/reject procedure to get to exact event count
1734 std::size_t counter = 0;
1735 bool havePrintedInfo = false;
1736 while(nEvtExtra>0) {
1737
1738 Int_t ibinRand = RooRandom::randomGenerator()->Integer(hist->numEntries()) ;
1739 hist->get(ibinRand) ;
1740 double ranY = RooRandom::randomGenerator()->Uniform(histMax) ;
1741
1742 if (ranY<hist->weight()) {
1743 if (wgt==1) {
1744 histOut[ibinRand]++ ;
1745 } else {
1746 // If weight is negative, prior bin content must be at least 1
1747 if (histOut[ibinRand]>0) {
1748 histOut[ibinRand]-- ;
1749 } else {
1750 continue ;
1751 }
1752 }
1753 nEvtExtra-- ;
1754 }
1755
1756 if ((counter++ > 10*nEvents || nEvents > 1.E7) && !havePrintedInfo) {
1757 havePrintedInfo = true;
1758 coutP(Generation) << "RooAbsPdf::generateBinned(" << GetName() << ") Performing costly accept/reject sampling. If this takes too long, use "
1759 << "extended mode to speed up the process." << std::endl;
1760 }
1761 }
1762
1763 // Transfer working array to histogram
1764 for (int i=0 ; i<hist->numEntries() ; i++) {
1765 hist->get(i) ;
1766 hist->set(histOut[i],sqrt(1.0*histOut[i])) ;
1767 }
1768
1769 } else if (expectedData) {
1770
1771 // Second pass for expectedData mode -- Normalize to exact number of requested events
1772 // Minor difference may be present in first round due to difference between
1773 // bin average and bin integral in sampling bins
1774 double corr = nEvents/hist->sumEntries() ;
1775 for (int i=0 ; i<hist->numEntries() ; i++) {
1776 hist->get(i) ;
1777 hist->set(hist->weight()*corr,sqrt(hist->weight()*corr)) ;
1778 }
1779
1780 }
1781
1782 return RooFit::makeOwningPtr(std::move(hist));
1783}
1784
1785
1786
1787////////////////////////////////////////////////////////////////////////////////
1788/// Special generator interface for generation of 'global observables' -- for RooStats tools
1789
1794
1795namespace {
1796void removeRangeOverlap(std::vector<std::pair<double, double>>& ranges) {
1797 //Sort from left to right
1798 std::sort(ranges.begin(), ranges.end());
1799
1800 for (auto it = ranges.begin(); it != ranges.end(); ++it) {
1801 double& startL = it->first;
1802 double& endL = it->second;
1803
1804 for (auto innerIt = it+1; innerIt != ranges.end(); ++innerIt) {
1805 const double startR = innerIt->first;
1806 const double endR = innerIt->second;
1807
1808 if (startL <= startR && startR <= endL) {
1809 //Overlapping ranges, extend left one
1810 endL = std::max(endL, endR);
1811 *innerIt = make_pair(0., 0.);
1812 }
1813 }
1814 }
1815
1816 auto newEnd = std::remove_if(ranges.begin(), ranges.end(),
1817 [](const std::pair<double,double>& input){
1818 return input.first == input.second;
1819 });
1820 ranges.erase(newEnd, ranges.end());
1821}
1822}
1823
1824
1825////////////////////////////////////////////////////////////////////////////////
1826/// Plot (project) PDF on specified frame.
1827/// - If a PDF is plotted in an empty frame, it
1828/// will show a unit-normalized curve in the frame variable. When projecting a multi-
1829/// dimensional PDF onto the frame axis, hidden parameters are taken are taken at
1830/// their current value.
1831/// - If a PDF is plotted in a frame in which a dataset has already been plotted, it will
1832/// show a projection integrated over all variables that were present in the shown
1833/// dataset (except for the one on the x-axis). The normalization of the curve will
1834/// be adjusted to the event count of the plotted dataset. An informational message
1835/// will be printed for each projection step that is performed.
1836/// - If a PDF is plotted in a frame showing a dataset *after* a fit, the above happens,
1837/// but the PDF will be drawn and normalised only in the fit range. If this is not desired,
1838/// plotting and normalisation range can be overridden using Range() and NormRange() as
1839/// documented in the table below.
1840///
1841/// This function takes the following named arguments (for more arguments, see also
1842/// RooAbsReal::plotOn(RooPlot*,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,
1843/// const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,
1844/// const RooCmdArg&) const )
1845///
1846///
1847/// <table>
1848/// <tr><th> Type of argument <th> Controlling normalisation
1849/// <tr><td> `NormRange(const char* name)` <td> Calculate curve normalization w.r.t. specified range[s].
1850/// See the tutorial rf212_plottingInRanges_blinding.C
1851/// \note Setting a Range() by default also sets a NormRange() on the same range, meaning that the
1852/// PDF is plotted and normalised in the same range. Overriding this can be useful if the PDF was fit
1853/// in limited range[s] such as side bands, `NormRange("sidebandLeft,sidebandRight")`, but the PDF
1854/// should be drawn in the full range, `Range("")`.
1855///
1856/// <tr><td> `Normalization(double scale, ScaleType code)` <td> Adjust normalization by given scale factor.
1857/// Interpretation of number depends on code:
1858/// `RooAbsReal::Relative`: relative adjustment factor
1859/// `RooAbsReal::NumEvent`: scale to match given number of events.
1860///
1861/// <tr><th> Type of argument <th> Misc control
1862/// <tr><td> `Name(const chat* name)` <td> Give curve specified name in frame. Useful if curve is to be referenced later
1863/// <tr><td> `Asymmetry(const RooCategory& c)` <td> Show the asymmetry of the PDF in given two-state category
1864/// \f$ \frac{F(+)-F(-)}{F(+)+F(-)} \f$ rather than the PDF projection. Category must have two
1865/// states with indices -1 and +1 or three states with indices -1,0 and +1.
1866/// <tr><td> `ShiftToZero(bool flag)` <td> Shift entire curve such that lowest visible point is at exactly zero.
1867/// Mostly useful when plotting -log(L) or \f$ \chi^2 \f$ distributions
1868/// <tr><td> `AddTo(const char* name, double_t wgtSelf, double_t wgtOther)` <td> Create a projection of this PDF onto the x-axis, but
1869/// instead of plotting it directly, add it to an existing curve with given name (and relative weight factors).
1870/// <tr><td> `Components(const char* names)` <td> When plotting sums of PDFs, plot only the named components (*e.g.* only
1871/// the signal of a signal+background model).
1872/// <tr><td> `Components(const RooArgSet& compSet)` <td> As above, but pass a RooArgSet of the components themselves.
1873///
1874/// <tr><th> Type of argument <th> Projection control
1875/// <tr><td> `Slice(const RooArgSet& set)` <td> Override default projection behaviour by omitting observables listed
1876/// in set from the projection, i.e. by not integrating over these.
1877/// Slicing is usually only sensible in discrete observables, by e.g. creating a slice
1878/// of the PDF at the current value of the category observable.
1879/// <tr><td> `Slice(RooCategory& cat, const char* label)` <td> Override default projection behaviour by omitting the specified category
1880/// observable from the projection, i.e., by not integrating over all states of this category.
1881/// The slice is positioned at the given label value. Multiple Slice() commands can be given to specify slices
1882/// in multiple observables, e.g.
1883/// ```{.cpp}
1884/// pdf.plotOn(frame, Slice(tagCategory, "2tag"), Slice(jetCategory, "3jet"));
1885/// ```
1886/// <tr><td> `Project(const RooArgSet& set)` <td> Override default projection behaviour by projecting
1887/// over observables given in set, completely ignoring the default projection behavior. Advanced use only.
1888/// <tr><td> `ProjWData(const RooAbsData& d)` <td> Override default projection _technique_ (integration). For observables
1889/// present in given dataset projection of PDF is achieved by constructing an average over all observable
1890/// values in given set. Consult RooFit plotting tutorial for further explanation of meaning & use of this technique
1891/// <tr><td> `ProjWData(const RooArgSet& s, const RooAbsData& d)` <td> As above but only consider subset 's' of
1892/// observables in dataset 'd' for projection through data averaging
1893/// <tr><td> `ProjectionRange(const char* rn)` <td> When projecting the PDF onto the plot axis, it is usually integrated
1894/// over the full range of the invisible variables. The ProjectionRange overrides this.
1895/// This is useful if the PDF was fitted in a limited range in y, but it is now projected onto x. If
1896/// `ProjectionRange("<name of fit range>")` is passed, the projection is normalised correctly.
1897///
1898/// <tr><th> Type of argument <th> Plotting control
1899/// <tr><td> `LineStyle(Int_t style)` <td> Select line style by ROOT line style code, default is solid
1900/// <tr><td> `LineColor(Int_t color)` <td> Select line color by ROOT color code, default is blue
1901/// <tr><td> `LineWidth(Int_t width)` <td> Select line with in pixels, default is 3
1902/// <tr><td> `FillStyle(Int_t style)` <td> Select fill style, default is not filled. If a filled style is selected,
1903/// also use VLines() to add vertical downward lines at end of curve to ensure proper closure
1904/// <tr><td> `FillColor(Int_t color)` <td> Select fill color by ROOT color code
1905/// <tr><td> `Range(const char* name)` <td> Only draw curve in range defined by given name. Multiple comma-separated ranges can be given.
1906/// An empty string "" or `nullptr` means to use the default range of the variable.
1907/// <tr><td> `Range(double lo, double hi)` <td> Only draw curve in specified range
1908/// <tr><td> `VLines()` <td> Add vertical lines to y=0 at end points of curve
1909/// <tr><td> `Precision(double eps)` <td> Control precision of drawn curve w.r.t to scale of plot, default is 1e-3. A higher precision will
1910/// result in more and more densely spaced curve points. A negative precision value will disable
1911/// adaptive point spacing and restrict sampling to the grid point of points defined by the binning
1912/// of the plotted observable (recommended for expensive functions such as profile likelihoods)
1913/// <tr><td> `Invisible(bool flag)` <td> Add curve to frame, but do not display. Useful in combination AddTo()
1914/// <tr><td> `VisualizeError(const RooFitResult& fitres, double Z=1, bool linearMethod=true)`
1915/// <td> Visualize the uncertainty on the parameters, as given in fitres, at 'Z' sigma.
1916/// The linear method is fast but may not be accurate in the presence of strong correlations (~>0.9) and at Z>2 due to linear and Gaussian approximations made.
1917/// Intervals from the sampling method can be asymmetric, and may perform better in the presence of strong correlations, but may take (much) longer to calculate
1918/// \note To include the uncertainty from the expected number of events,
1919/// the Normalization() argument with `ScaleType` `RooAbsReal::RelativeExpected` has to be passed, e.g.
1920/// ```{.cpp}
1921/// pdf.plotOn(frame, VisualizeError(fitResult), Normalization(1.0, RooAbsReal::RelativeExpected));
1922/// ```
1923///
1924/// <tr><td> `VisualizeError(const RooFitResult& fitres, const RooArgSet& param, double Z=1, bool linearMethod=true)`
1925/// <td> Visualize the uncertainty on the subset of parameters 'param', as given in fitres, at 'Z' sigma
1926/// </table>
1927
1929{
1930
1931 // Pre-processing if p.d.f. contains a fit range and there is no command specifying one,
1932 // add a fit range as default range
1933 std::unique_ptr<RooCmdArg> plotRange;
1934 std::unique_ptr<RooCmdArg> normRange2;
1935 if (getStringAttribute("fitrange") && !cmdList.FindObject("Range") &&
1936 !cmdList.FindObject("RangeWithName")) {
1937 plotRange.reset(static_cast<RooCmdArg*>(RooFit::Range(getStringAttribute("fitrange")).Clone()));
1938 cmdList.Add(plotRange.get());
1939 }
1940
1941 if (getStringAttribute("fitrange") && !cmdList.FindObject("NormRange")) {
1942 normRange2.reset(static_cast<RooCmdArg*>(RooFit::NormRange(getStringAttribute("fitrange")).Clone()));
1943 cmdList.Add(normRange2.get());
1944 }
1945
1946 if (plotRange || normRange2) {
1947 coutI(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") p.d.f was fitted in a subrange and no explicit "
1948 << (plotRange?"Range()":"") << ((plotRange&&normRange2)?" and ":"")
1949 << (normRange2?"NormRange()":"") << " was specified. Plotting / normalising in fit range. To override, do one of the following"
1950 << "\n\t- Clear the automatic fit range attribute: <pdf>.removeStringAttribute(\"fitrange\");"
1951 << "\n\t- Explicitly specify the plotting range: Range(\"<rangeName>\")."
1952 << "\n\t- Explicitly specify where to compute the normalisation: NormRange(\"<rangeName>\")."
1953 << "\n\tThe default (full) range can be denoted with Range(\"\") / NormRange(\"\")."<< std::endl ;
1954 }
1955
1956 // Sanity checks
1957 if (plotSanityChecks(frame)) return frame ;
1958
1959 // Select the pdf-specific commands
1960 RooCmdConfig pc("RooAbsPdf::plotOn(" + std::string(GetName()) + ")");
1961 pc.defineDouble("scaleFactor","Normalization",0,1.0) ;
1962 pc.defineInt("scaleType","Normalization",0,Relative) ;
1963 pc.defineSet("compSet","SelectCompSet",0) ;
1964 pc.defineString("compSpec","SelectCompSpec",0) ;
1965 pc.defineObject("asymCat","Asymmetry",0) ;
1966 pc.defineDouble("rangeLo","Range",0,-999.) ;
1967 pc.defineDouble("rangeHi","Range",1,-999.) ;
1968 pc.defineString("rangeName","RangeWithName",0,"") ;
1969 pc.defineString("normRangeName","NormRange",0,"") ;
1970 pc.defineInt("rangeAdjustNorm","Range",0,0) ;
1971 pc.defineInt("rangeWNAdjustNorm","RangeWithName",0,0) ;
1972 pc.defineMutex("SelectCompSet","SelectCompSpec") ;
1973 pc.defineMutex("Range","RangeWithName") ;
1974 pc.allowUndefined() ; // unknowns may be handled by RooAbsReal
1975
1976 // Process and check varargs
1977 pc.process(cmdList) ;
1978 if (!pc.ok(true)) {
1979 return frame ;
1980 }
1981
1982 // Decode command line arguments
1983 ScaleType stype = (ScaleType) pc.getInt("scaleType") ;
1984 double scaleFactor = pc.getDouble("scaleFactor") ;
1985 const RooAbsCategoryLValue* asymCat = static_cast<const RooAbsCategoryLValue*>(pc.getObject("asymCat")) ;
1986 const char* compSpec = pc.getString("compSpec") ;
1987 const RooArgSet* compSet = pc.getSet("compSet");
1988 bool haveCompSel = ( (compSpec && strlen(compSpec)>0) || compSet) ;
1989
1990 // Suffix for curve name
1991 std::stringstream nameSuffix;
1992 if (compSpec && strlen(compSpec)>0) {
1993 nameSuffix << "_Comp[" << compSpec << "]";
1994 } else if (compSet) {
1995 nameSuffix << "_Comp[" << compSet->contentsString() << "]";
1996 }
1997
1998 // Remove PDF-only commands from command list
1999 RooCmdConfig::stripCmdList(cmdList,"SelectCompSet,SelectCompSpec") ;
2000
2001 // Adjust normalization, if so requested
2002 if (asymCat) {
2003 RooCmdArg cnsuffix("CurveNameSuffix", 0, 0, 0, 0, nameSuffix.str().c_str(), nullptr, nullptr, nullptr);
2004 cmdList.Add(&cnsuffix);
2005 return RooAbsReal::plotOn(frame, cmdList);
2006 }
2007
2008 // More sanity checks
2009 double nExpected(1) ;
2010 if (stype==RelativeExpected) {
2011 if (!canBeExtended()) {
2012 coutE(Plotting) << "RooAbsPdf::plotOn(" << GetName()
2013 << "): ERROR the 'Expected' scale option can only be used on extendable PDFs" << std::endl ;
2014 return frame ;
2015 }
2016 frame->updateNormVars(*frame->getPlotVar()) ;
2018 }
2019
2020 if (stype != Raw) {
2021
2022 if (frame->getFitRangeNEvt() && stype==Relative) {
2023
2024 bool hasCustomRange(false);
2025 bool adjustNorm(false);
2026
2027 std::vector<pair<double,double> > rangeLim;
2028
2029 // Retrieve plot range to be able to adjust normalization to data
2030 if (pc.hasProcessed("Range")) {
2031
2032 double rangeLo = pc.getDouble("rangeLo") ;
2033 double rangeHi = pc.getDouble("rangeHi") ;
2034 rangeLim.push_back(make_pair(rangeLo,rangeHi)) ;
2035 adjustNorm = pc.getInt("rangeAdjustNorm") ;
2037
2038 coutI(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") only plotting range ["
2039 << rangeLo << "," << rangeHi << "]" ;
2040 if (!pc.hasProcessed("NormRange")) {
2041 ccoutI(Plotting) << ", curve is normalized to data in " << (adjustNorm?"given":"full") << " range" << std::endl ;
2042 } else {
2043 ccoutI(Plotting) << std::endl ;
2044 }
2045
2046 nameSuffix << "_Range[" << rangeLo << "_" << rangeHi << "]";
2047
2048 } else if (pc.hasProcessed("RangeWithName")) {
2049
2050 for (const std::string& rangeNameToken : ROOT::Split(pc.getString("rangeName", "", false), ",")) {
2051 const char* thisRangeName = rangeNameToken.empty() ? nullptr : rangeNameToken.c_str();
2052 if (thisRangeName && !frame->getPlotVar()->hasRange(thisRangeName)) {
2053 coutE(Plotting) << "Range '" << rangeNameToken << "' not defined for variable '"
2054 << frame->getPlotVar()->GetName() << "'. Ignoring ..." << std::endl;
2055 continue;
2056 }
2057 rangeLim.push_back(frame->getPlotVar()->getRange(thisRangeName));
2058 }
2059 adjustNorm = pc.getInt("rangeWNAdjustNorm") ;
2061
2062 coutI(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") only plotting range '" << pc.getString("rangeName", "", false) << "'" ;
2063 if (!pc.hasProcessed("NormRange")) {
2064 ccoutI(Plotting) << ", curve is normalized to data in " << (adjustNorm?"given":"full") << " range" << std::endl ;
2065 } else {
2066 ccoutI(Plotting) << std::endl ;
2067 }
2068
2069 nameSuffix << "_Range[" << pc.getString("rangeName") << "]";
2070 }
2071 // Specification of a normalization range override those in a regular range
2072 if (pc.hasProcessed("NormRange")) {
2073 rangeLim.clear();
2074 for (const auto& rangeNameToken : ROOT::Split(pc.getString("normRangeName", "", false), ",")) {
2075 const char* thisRangeName = rangeNameToken.empty() ? nullptr : rangeNameToken.c_str();
2076 if (thisRangeName && !frame->getPlotVar()->hasRange(thisRangeName)) {
2077 coutE(Plotting) << "Range '" << rangeNameToken << "' not defined for variable '"
2078 << frame->getPlotVar()->GetName() << "'. Ignoring ..." << std::endl;
2079 continue;
2080 }
2081 rangeLim.push_back(frame->getPlotVar()->getRange(thisRangeName));
2082 }
2083 adjustNorm = true ;
2085 coutI(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") p.d.f. curve is normalized using explicit choice of ranges '" << pc.getString("normRangeName", "", false) << "'" << std::endl ;
2086
2087 nameSuffix << "_NormRange[" << pc.getString("rangeName") << "]";
2088 }
2089
2090 if (hasCustomRange && adjustNorm) {
2091 // If overlapping ranges were given, remove them now
2092 const std::size_t oldSize = rangeLim.size();
2094
2095 if (oldSize != rangeLim.size() && !pc.hasProcessed("NormRange")) {
2096 // User gave overlapping ranges. This leads to double-counting events and integrals, and must
2097 // therefore be avoided. If a NormRange has been given, the overlap is already gone.
2098 // It's safe to plot even with overlap now.
2099 coutE(Plotting) << "Requested plot/integration ranges overlap. For correct plotting, new ranges "
2100 "will be defined." << std::endl;
2101 auto plotVar = dynamic_cast<RooRealVar*>(frame->getPlotVar());
2102 assert(plotVar);
2103 std::string rangesNoOverlap;
2104 for (auto it = rangeLim.begin(); it != rangeLim.end(); ++it) {
2105 std::stringstream rangeName;
2106 rangeName << "Remove_overlap_range_" << it - rangeLim.begin();
2107 plotVar->setRange(rangeName.str().c_str(), it->first, it->second);
2108 if (!rangesNoOverlap.empty())
2109 rangesNoOverlap += ",";
2110 rangesNoOverlap += rangeName.str();
2111 }
2112
2113 auto rangeArg = static_cast<RooCmdArg*>(cmdList.FindObject("RangeWithName"));
2114 if (rangeArg) {
2115 rangeArg->setString(0, rangesNoOverlap.c_str());
2116 } else {
2117 plotRange = std::make_unique<RooCmdArg>(RooFit::Range(rangesNoOverlap.c_str()));
2118 cmdList.Add(plotRange.get());
2119 }
2120 }
2121
2122 double rangeNevt(0) ;
2123 for (const auto& riter : rangeLim) {
2124 double nevt= frame->getFitRangeNEvt(riter.first, riter.second);
2125 rangeNevt += nevt ;
2126 }
2127
2128 scaleFactor *= rangeNevt/nExpected ;
2129
2130 } else {
2131 // First, check if the PDF *can* be extended.
2132 if (this->canBeExtended()) {
2133 // If it can, get the expected events.
2134 const double nExp = expectedEvents(frame->getNormVars());
2135 if (nExp > 0) {
2136 // If the prediction is valid, use it for normalization.
2137 scaleFactor *= nExp / nExpected;
2138 } else {
2139 // If prediction is not valid (e.g. 0), fall back to data.
2140 scaleFactor *= frame->getFitRangeNEvt() / nExpected;
2141 }
2142 } else {
2143 // If the PDF can't be extended, just use the data.
2144 scaleFactor *= frame->getFitRangeNEvt() / nExpected;
2145 }
2146 }
2147 } else if (stype==RelativeExpected) {
2148 scaleFactor *= nExpected ;
2149 } else if (stype==NumEvent) {
2150 scaleFactor /= nExpected ;
2151 }
2152 scaleFactor *= frame->getFitRangeBinW() ;
2153 }
2154 frame->updateNormVars(*frame->getPlotVar()) ;
2155
2156 // Append overriding scale factor command at end of original command list
2157 RooCmdArg tmp = RooFit::Normalization(scaleFactor,Raw) ;
2158 tmp.setInt(1,1) ; // Flag this normalization command as created for internal use (so that VisualizeError can strip it)
2160
2161 // Was a component selected requested
2162 if (haveCompSel) {
2163
2164 // Get complete set of tree branch nodes
2167
2168 // Discard any non-RooAbsReal nodes
2169 for (const auto arg : branchNodeSet) {
2170 if (!dynamic_cast<RooAbsReal*>(arg)) {
2171 branchNodeSet.remove(*arg) ;
2172 }
2173 }
2174
2175 // Obtain direct selection
2176 std::unique_ptr<RooArgSet> dirSelNodes;
2177 if (compSet) {
2178 dirSelNodes = std::unique_ptr<RooArgSet>{branchNodeSet.selectCommon(*compSet)};
2179 } else {
2180 dirSelNodes = std::unique_ptr<RooArgSet>{branchNodeSet.selectByName(compSpec)};
2181 }
2182 if (!dirSelNodes->empty()) {
2183 coutI(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") directly selected PDF components: " << *dirSelNodes << std::endl ;
2184
2185 // Do indirect selection and activate both
2187 } else {
2188 if (compSet) {
2189 coutE(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") ERROR: component selection set " << *compSet << " does not match any components of p.d.f." << std::endl ;
2190 } else {
2191 coutE(Plotting) << "RooAbsPdf::plotOn(" << GetName() << ") ERROR: component selection expression '" << compSpec << "' does not select any components of p.d.f." << std::endl ;
2192 }
2193 return nullptr ;
2194 }
2195 }
2196
2197 RooCmdArg cnsuffix("CurveNameSuffix", 0, 0, 0, 0, nameSuffix.str().c_str(), nullptr, nullptr, nullptr);
2198 cmdList.Add(&cnsuffix);
2199
2201
2202 // Restore selection status ;
2203 if (haveCompSel) plotOnCompSelect(nullptr) ;
2204
2205 return ret ;
2206}
2207
2208
2209//_____________________________________________________________________________
2210/// Plot oneself on 'frame'. In addition to features detailed in RooAbsReal::plotOn(),
2211/// the scale factor for a PDF can be interpreted in three different ways. The interpretation
2212/// is controlled by ScaleType
2213/// ```
2214/// Relative - Scale factor is applied on top of PDF normalization scale factor
2215/// NumEvent - Scale factor is interpreted as a number of events. The surface area
2216/// under the PDF curve will match that of a histogram containing the specified
2217/// number of event
2218/// Raw - Scale factor is applied to the raw (projected) probability density.
2219/// Not too useful, option provided for completeness.
2220/// ```
2221// coverity[PASS_BY_VALUE]
2223{
2224
2225 // Sanity checks
2226 if (plotSanityChecks(frame)) return frame ;
2227
2228 // More sanity checks
2229 double nExpected(1) ;
2230 if (o.stype==RelativeExpected) {
2231 if (!canBeExtended()) {
2232 coutE(Plotting) << "RooAbsPdf::plotOn(" << GetName()
2233 << "): ERROR the 'Expected' scale option can only be used on extendable PDFs" << std::endl ;
2234 return frame ;
2235 }
2236 frame->updateNormVars(*frame->getPlotVar()) ;
2238 }
2239
2240 // Adjust normalization, if so requested
2241 if (o.stype != Raw) {
2242
2243 if (frame->getFitRangeNEvt() && o.stype==Relative) {
2244 // If non-default plotting range is specified, adjust number of events in fit range
2245 o.scaleFactor *= frame->getFitRangeNEvt()/nExpected ;
2246 } else if (o.stype==RelativeExpected) {
2247 o.scaleFactor *= nExpected ;
2248 } else if (o.stype==NumEvent) {
2249 o.scaleFactor /= nExpected ;
2250 }
2251 o.scaleFactor *= frame->getFitRangeBinW() ;
2252 }
2253 frame->updateNormVars(*frame->getPlotVar()) ;
2254
2255 return RooAbsReal::plotOn(frame,o) ;
2256}
2257
2258
2259
2260
2261////////////////////////////////////////////////////////////////////////////////
2262/// The following named arguments are supported
2263/// <table>
2264/// <tr><th> Type of CmdArg <th> Effect on parameter box
2265/// <tr><td> `Parameters(const RooArgSet& param)` <td> Only the specified subset of parameters will be shown. By default all non-constant parameters are shown.
2266/// <tr><td> `ShowConstants(bool flag)` <td> Also display constant parameters
2267/// <tr><td> `Format(const char* what,...)` <td> Parameter formatting options.
2268/// | Parameter | Format
2269/// | ---------------------- | --------------------------
2270/// | `const char* what` | Controls what is shown. "N" adds name (alternatively, "T" adds the title), "E" adds error, "A" shows asymmetric error, "U" shows unit, "H" hides the value
2271/// | `FixedPrecision(int n)`| Controls precision, set fixed number of digits
2272/// | `AutoPrecision(int n)` | Controls precision. Number of shown digits is calculated from error + n specified additional digits (1 is sensible default)
2273/// <tr><td> `Label(const chat* label)` <td> Add label to parameter box. Use `\n` for multi-line labels.
2274/// <tr><td> `Layout(double xmin, double xmax, double ymax)` <td> Specify relative position of left/right side of box and top of box.
2275/// Coordinates are given as position on the pad between 0 and 1.
2276/// The lower end of the box is calculated automatically from the number of lines in the box.
2277/// </table>
2278///
2279///
2280/// Example use:
2281/// ```
2282/// pdf.paramOn(frame, Label("fit result"), Format("NEU",AutoPrecision(1)) ) ;
2283/// ```
2284///
2285
2287 const RooCmdArg& arg3, const RooCmdArg& arg4, const RooCmdArg& arg5,
2288 const RooCmdArg& arg6, const RooCmdArg& arg7, const RooCmdArg& arg8)
2289{
2290 // Stuff all arguments in a list
2292 cmdList.Add(const_cast<RooCmdArg*>(&arg1)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg2)) ;
2293 cmdList.Add(const_cast<RooCmdArg*>(&arg3)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg4)) ;
2294 cmdList.Add(const_cast<RooCmdArg*>(&arg5)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg6)) ;
2295 cmdList.Add(const_cast<RooCmdArg*>(&arg7)) ; cmdList.Add(const_cast<RooCmdArg*>(&arg8)) ;
2296
2297 // Select the pdf-specific commands
2298 RooCmdConfig pc("RooAbsPdf::paramOn(" + std::string(GetName()) + ")");
2299 pc.defineString("label","Label",0,"") ;
2300 pc.defineDouble("xmin","Layout",0,0.65) ;
2301 pc.defineDouble("xmax","Layout",1,0.9) ;
2302 pc.defineInt("ymaxi","Layout",0,Int_t(0.9*10000)) ;
2303 pc.defineInt("showc","ShowConstants",0,0) ;
2304 pc.defineSet("params","Parameters",0,nullptr) ;
2305 pc.defineInt("dummy","FormatArgs",0,0) ;
2306
2307 // Process and check varargs
2308 pc.process(cmdList) ;
2309 if (!pc.ok(true)) {
2310 return frame ;
2311 }
2312
2313 auto formatCmd = static_cast<RooCmdArg const*>(cmdList.FindObject("FormatArgs")) ;
2314
2315 const char* label = pc.getString("label") ;
2316 double xmin = pc.getDouble("xmin") ;
2317 double xmax = pc.getDouble("xmax") ;
2318 double ymax = pc.getInt("ymaxi") / 10000. ;
2319 int showc = pc.getInt("showc") ;
2320
2321 // Decode command line arguments
2322 std::unique_ptr<RooArgSet> params{getParameters(frame->getNormVars())} ;
2323 if(RooArgSet* requestedParams = pc.getSet("params")) {
2324 params = std::unique_ptr<RooArgSet>{params->selectCommon(*requestedParams)};
2325 }
2326 paramOn(frame,*params,showc,label,xmin,xmax,ymax,formatCmd);
2327
2328 return frame ;
2329}
2330
2331
2332////////////////////////////////////////////////////////////////////////////////
2333/// Add a text box with the current parameter values and their errors to the frame.
2334/// Observables of this PDF appearing in the 'data' dataset will be omitted.
2335///
2336/// An optional label will be inserted if passed. Multi-line labels can be generated
2337/// by adding `\n` to the label string. Use 'sigDigits'
2338/// to modify the default number of significant digits printed. The 'xmin,xmax,ymax'
2339/// values specify the initial relative position of the text box in the plot frame.
2340
2341RooPlot* RooAbsPdf::paramOn(RooPlot* frame, const RooArgSet& params, bool showConstants, const char *label,
2342 double xmin, double xmax ,double ymax, const RooCmdArg* formatCmd)
2343{
2344
2345 // parse the options
2346 bool showLabel= (label != nullptr && strlen(label) > 0);
2347
2348 // calculate the box's size, adjusting for constant parameters
2349
2350 double ymin(ymax);
2351 double dy(0.06);
2352 for (const auto param : params) {
2353 auto var = static_cast<RooRealVar*>(param);
2354 if(showConstants || !var->isConstant()) ymin-= dy;
2355 }
2356
2357 std::string labelString = label;
2358 unsigned int numLines = std::count(labelString.begin(), labelString.end(), '\n') + 1;
2359 if (showLabel) ymin -= numLines * dy;
2360
2361 // create the box and set its options
2362 TPaveText *box= new TPaveText(xmin,ymax,xmax,ymin,"BRNDC");
2363 if(!box) return nullptr;
2364 box->SetName((std::string(GetName()) + "_paramBox").c_str());
2365 box->SetFillColor(0);
2366 box->SetBorderSize(0);
2367 box->SetTextAlign(12);
2368 box->SetTextSize(0.04F);
2369 box->SetFillStyle(0);
2370
2371 for (const auto param : params) {
2372 auto var = static_cast<const RooRealVar*>(param);
2373 if(var->isConstant() && !showConstants) continue;
2374
2375 box->AddText((formatCmd ? var->format(*formatCmd) : var->format(2, "NELU")).c_str());
2376 }
2377
2378 // add the optional label if specified
2379 if (showLabel) {
2380 for (const auto& line : ROOT::Split(label, "\n")) {
2381 box->AddText(line.c_str());
2382 }
2383 }
2384
2385 // Add box to frame
2386 frame->addObject(box) ;
2387
2388 return frame ;
2389}
2390
2391
2392
2393
2394////////////////////////////////////////////////////////////////////////////////
2395/// Return expected number of events from this p.d.f for use in extended
2396/// likelihood calculations. This default implementation returns zero
2397
2399{
2400 return 0 ;
2401}
2402
2403
2404
2405////////////////////////////////////////////////////////////////////////////////
2406/// Change global level of verbosity for p.d.f. evaluations
2407
2409{
2410 _verboseEval = stat ;
2411}
2412
2413
2414
2415////////////////////////////////////////////////////////////////////////////////
2416/// Return global level of verbosity for p.d.f. evaluations
2417
2419{
2420 return _verboseEval ;
2421}
2422
2423
2424
2425////////////////////////////////////////////////////////////////////////////////
2426/// Destructor of normalization cache element. If this element
2427/// provides the 'current' normalization stored in RooAbsPdf::_norm
2428/// zero _norm pointer here before object pointed to is deleted here
2429
2431{
2432 // Zero _norm pointer in RooAbsPdf if it is points to our cache payload
2433 if (_owner) {
2434 RooAbsPdf* pdfOwner = static_cast<RooAbsPdf*>(_owner) ;
2435 if (pdfOwner->_norm == _norm.get()) {
2436 pdfOwner->_norm = nullptr ;
2437 }
2438 }
2439}
2440
2441
2442
2443////////////////////////////////////////////////////////////////////////////////
2444/// Return a p.d.f that represent a projection of this p.d.f integrated over given observables
2445
2447{
2448 // Construct name for new object
2449 std::string name = std::string{GetName()} + "_Proj[" + RooHelpers::getColonSeparatedNameString(iset, ',') + "]";
2450
2451 // Return projected p.d.f.
2452 return new RooProjectedPdf(name.c_str(),name.c_str(),*this,iset) ;
2453}
2454
2455
2456
2457////////////////////////////////////////////////////////////////////////////////
2458/// Create a cumulative distribution function of this p.d.f in terms
2459/// of the observables listed in iset. If no nset argument is given
2460/// the c.d.f normalization is constructed over the integrated
2461/// observables, so that its maximum value is precisely 1. It is also
2462/// possible to choose a different normalization for
2463/// multi-dimensional p.d.f.s: eg. for a pdf f(x,y,z) one can
2464/// construct a partial cdf c(x,y) that only when integrated itself
2465/// over z results in a maximum value of 1. To construct such a cdf pass
2466/// z as argument to the optional nset argument
2467
2472
2473
2474
2475////////////////////////////////////////////////////////////////////////////////
2476/// Create an object that represents the integral of the function over one or more observables listed in `iset`.
2477/// The actual integration calculation is only performed when the return object is evaluated. The name
2478/// of the integral object is automatically constructed from the name of the input function, the variables
2479/// it integrates and the range integrates over
2480///
2481/// The following named arguments are accepted
2482/// | Type of CmdArg | Effect on CDF
2483/// | ---------------------|-------------------
2484/// | SupNormSet(const RooArgSet&) | Observables over which should be normalized _in addition_ to the integration observables
2485/// | ScanNumCdf() | Apply scanning technique if cdf integral involves numeric integration [ default ]
2486/// | ScanAllCdf() | Always apply scanning technique
2487/// | ScanNoCdf() | Never apply scanning technique
2488/// | ScanParameters(Int_t nbins, Int_t intOrder) | Parameters for scanning technique of making CDF: number of sampled bins and order of interpolation applied on numeric cdf
2489
2491 const RooCmdArg& arg3, const RooCmdArg& arg4, const RooCmdArg& arg5,
2492 const RooCmdArg& arg6, const RooCmdArg& arg7, const RooCmdArg& arg8)
2493{
2494 // Define configuration for this method
2495 RooCmdConfig pc("RooAbsReal::createCdf(" + std::string(GetName()) + ")");
2496 pc.defineSet("supNormSet","SupNormSet",0,nullptr) ;
2497 pc.defineInt("numScanBins","ScanParameters",0,1000) ;
2498 pc.defineInt("intOrder","ScanParameters",1,2) ;
2499 pc.defineInt("doScanNum","ScanNumCdf",0,1) ;
2500 pc.defineInt("doScanAll","ScanAllCdf",0,0) ;
2501 pc.defineInt("doScanNon","ScanNoCdf",0,0) ;
2502 pc.defineMutex("ScanNumCdf","ScanAllCdf","ScanNoCdf") ;
2503
2504 // Process & check varargs
2506 if (!pc.ok(true)) {
2507 return nullptr ;
2508 }
2509
2510 // Extract values from named arguments
2511 const RooArgSet* snset = pc.getSet("supNormSet",nullptr);
2512 RooArgSet nset ;
2513 if (snset) {
2514 nset.add(*snset) ;
2515 }
2516 Int_t numScanBins = pc.getInt("numScanBins") ;
2517 Int_t intOrder = pc.getInt("intOrder") ;
2518 Int_t doScanNum = pc.getInt("doScanNum") ;
2519 Int_t doScanAll = pc.getInt("doScanAll") ;
2520 Int_t doScanNon = pc.getInt("doScanNon") ;
2521
2522 // If scanning technique is not requested make integral-based cdf and return
2523 if (doScanNon) {
2524 return createIntRI(iset,nset) ;
2525 }
2526 if (doScanAll) {
2527 return createScanCdf(iset,nset,numScanBins,intOrder) ;
2528 }
2529 if (doScanNum) {
2530 std::unique_ptr<RooAbsReal> tmp{createIntegral(iset)} ;
2531 Int_t isNum= !static_cast<RooRealIntegral&>(*tmp).numIntRealVars().empty();
2532
2533 if (isNum) {
2534 coutI(NumericIntegration) << "RooAbsPdf::createCdf(" << GetName() << ") integration over observable(s) " << iset << " involves numeric integration," << std::endl
2535 << " constructing cdf though numeric integration of sampled pdf in " << numScanBins << " bins and applying order "
2536 << intOrder << " interpolation on integrated histogram." << std::endl
2537 << " To override this choice of technique use argument ScanNone(), to change scan parameters use ScanParameters(nbins,order) argument" << std::endl ;
2538 }
2539
2541 }
2542 return nullptr ;
2543}
2544
2546{
2547 string name = string(GetName()) + "_NUMCDF_" + integralNameSuffix(iset,&nset).Data() ;
2548 RooRealVar* ivar = static_cast<RooRealVar*>(iset.first()) ;
2549 ivar->setBins(numScanBins,"numcdf") ;
2550 auto ret = std::make_unique<RooNumCdf>(name.c_str(),name.c_str(),*this,*ivar,"numcdf");
2551 ret->setInterpolationOrder(intOrder) ;
2552 return RooFit::makeOwningPtr<RooAbsReal>(std::move(ret));
2553}
2554
2555
2556
2557
2558////////////////////////////////////////////////////////////////////////////////
2559/// This helper function finds and collects all constraints terms of all component p.d.f.s
2560/// and returns a RooArgSet with all those terms.
2561
2562std::unique_ptr<RooArgSet>
2564{
2565 RooArgSet constraints;
2567
2568 std::unique_ptr<RooArgSet> comps(getComponents());
2569 for (const auto arg : *comps) {
2570 auto pdf = dynamic_cast<const RooAbsPdf*>(arg) ;
2571 if (pdf && !constraints.find(pdf->GetName())) {
2572 if (auto compRet = pdf->getConstraints(observables,constrainedParams, pdfParams)) {
2573 constraints.add(*compRet,false) ;
2574 }
2575 }
2576 }
2577
2579
2580 // Strip any constraints that are completely decoupled from the other product terms
2581 auto finalConstraints = std::make_unique<RooArgSet>("AllConstraints");
2582 for(auto * pdf : static_range_cast<RooAbsPdf*>(constraints)) {
2583
2584 RooArgSet tmp;
2585 pdf->getParameters(nullptr, tmp);
2586 conParams.add(tmp,true) ;
2587
2588 if (pdf->dependsOnValue(pdfParams) || !stripDisconnected) {
2589 finalConstraints->add(*pdf) ;
2590 } else {
2591 coutI(Minimization) << "RooAbsPdf::getAllConstraints(" << GetName() << ") omitting term " << pdf->GetName()
2592 << " as constraint term as it does not share any parameters with the other pdfs in product. "
2593 << "To force inclusion in likelihood, add an explicit Constrain() argument for the target parameter" << std::endl ;
2594 }
2595 }
2596
2597 // Now remove from constrainedParams all parameters that occur exclusively in constraint term and not in regular pdf term
2598
2600 conParams.selectCommon(constrainedParams, cexl);
2601 cexl.remove(pdfParams,true,true) ;
2602 constrainedParams.remove(cexl,true,true) ;
2603
2604 return finalConstraints ;
2605}
2606
2607
2608////////////////////////////////////////////////////////////////////////////////
2609/// Returns the default numeric MC generator configuration for all RooAbsReals
2610
2615
2616
2617////////////////////////////////////////////////////////////////////////////////
2618/// Returns the specialized integrator configuration for _this_ RooAbsReal.
2619/// If this object has no specialized configuration, a null pointer is returned
2620
2625
2626
2627
2628////////////////////////////////////////////////////////////////////////////////
2629/// Returns the specialized integrator configuration for _this_ RooAbsReal.
2630/// If this object has no specialized configuration, a null pointer is returned,
2631/// unless createOnTheFly is true in which case a clone of the default integrator
2632/// configuration is created, installed as specialized configuration, and returned
2633
2635{
2637 _specGeneratorConfig = std::make_unique<RooNumGenConfig>(*defaultGeneratorConfig()) ;
2638 }
2639 return _specGeneratorConfig.get();
2640}
2641
2642
2643
2644////////////////////////////////////////////////////////////////////////////////
2645/// Return the numeric MC generator configuration used for this object. If
2646/// a specialized configuration was associated with this object, that configuration
2647/// is returned, otherwise the default configuration for all RooAbsReals is returned
2648
2650{
2651 const RooNumGenConfig *config = specialGeneratorConfig();
2652 return config ? config : defaultGeneratorConfig();
2653}
2654
2655
2656
2657////////////////////////////////////////////////////////////////////////////////
2658/// Set the given configuration as default numeric MC generator
2659/// configuration for this object
2660
2662{
2663 _specGeneratorConfig = std::make_unique<RooNumGenConfig>(config);
2664}
2665
2666
2667
2668////////////////////////////////////////////////////////////////////////////////
2669/// Remove the specialized numeric MC generator configuration associated
2670/// with this object
2671
2676
2678
2679
2680////////////////////////////////////////////////////////////////////////////////
2681
2683 bool extended, bool randProto, bool resampleProto, TString dsetName, bool init) :
2684 _genContext(context), _whatVars(whatVars), _protoData(protoData), _nGen(nGen), _extended(extended),
2685 _randProto(randProto), _resampleProto(resampleProto), _dsetName(dsetName), _init(init)
2686{
2687}
2688
2689
2690namespace {
2691
2692void sterilizeClientCaches(RooAbsArg & arg) {
2693 auto const& clients = arg.clients();
2694 for(std::size_t iClient = 0; iClient < clients.size(); ++iClient) {
2695
2696 const std::size_t oldClientsSize = clients.size();
2697 RooAbsArg* client = clients[iClient];
2698
2699 for(int iCache = 0; iCache < client->numCaches(); ++iCache) {
2700 if(auto cacheMgr = dynamic_cast<RooObjCacheManager*>(client->getCache(iCache))) {
2701 cacheMgr->sterilize();
2702 }
2703 }
2704
2705 // It can happen that the objects cached by the client are also clients of
2706 // the arg itself! In that case, the position of the client in the client
2707 // list might have changed, and we need to find the new index.
2708 if(clients.size() != oldClientsSize) {
2709 auto clientIter = std::find(clients.begin(), clients.end(), client);
2710 if(clientIter == clients.end()) {
2711 throw std::runtime_error("After a clients caches were cleared, the client was gone! This should not happen.");
2712 }
2713 iClient = std::distance(clients.begin(), clientIter);
2714 }
2715 }
2716}
2717
2718} // namespace
2719
2720
2721////////////////////////////////////////////////////////////////////////////////
2722
2724{
2726
2727 // the stuff that the clients have cached may depend on the normalization range
2728 sterilizeClientCaches(*this);
2729
2730 if (_norm) {
2732 _norm = nullptr ;
2733 }
2734}
2735
2736
2737////////////////////////////////////////////////////////////////////////////////
2738
2740{
2742
2743 // the stuff that the clients have cached may depend on the normalization range
2744 sterilizeClientCaches(*this);
2745
2746 if (_norm) {
2748 _norm = nullptr ;
2749 }
2750}
2751
2752
2753////////////////////////////////////////////////////////////////////////////////
2754/// Hook function intercepting redirectServer calls. Discard current
2755/// normalization object if any server is redirected
2756
2758 bool nameChange, bool isRecursiveStep)
2759{
2760 // If servers are redirected, the cached normalization integrals and
2761 // normalization sets are most likely invalid.
2763
2764 // Object is own by _normCacheManager that will delete object as soon as cache
2765 // is sterilized by server redirect
2766 _norm = nullptr ;
2767
2768 // Similar to the situation with the normalization integral above: if a
2769 // server is redirected, the cached normalization set might not point to
2770 // the right observables anymore. We need to reset it.
2771 setActiveNormSet(nullptr);
2773}
2774
2775
2776std::unique_ptr<RooAbsArg>
2778{
2779 if (normSet.empty() || selfNormalized()) {
2781 }
2782 std::unique_ptr<RooAbsPdf> pdfClone(static_cast<RooAbsPdf *>(this->Clone()));
2784
2785 auto newArg = std::make_unique<RooFit::Detail::RooNormalizedPdf>(*pdfClone, normSet);
2786
2787 // The direct servers are this pdf and the normalization integral, which
2788 // don't need to be compiled further.
2789 for (RooAbsArg *server : newArg->servers()) {
2790 ctx.markAsCompiled(*server);
2791 }
2792 ctx.markAsCompiled(*newArg);
2793 newArg->addOwnedComponents(std::move(pdfClone));
2794 return newArg;
2795}
2796
2797/// Returns an object that represents the expected number of events for a given
2798/// normalization set, similar to how createIntegral() returns an object that
2799/// returns the integral. This is used to build the computation graph for the
2800/// final likelihood.
2801std::unique_ptr<RooAbsReal> RooAbsPdf::createExpectedEventsFunc(const RooArgSet * /*nset*/) const
2802{
2803 std::stringstream errMsg;
2804 errMsg << "The pdf \"" << GetName() << "\" of type " << ClassName()
2805 << " did not overload RooAbsPdf::createExpectedEventsFunc()!";
2806 coutE(InputArguments) << errMsg.str() << std::endl;
2807 return nullptr;
2808}
#define e(i)
Definition RSha256.hxx:103
#define coutI(a)
#define cxcoutI(a)
#define cxcoutD(a)
#define coutP(a)
#define oocoutW(o, a)
#define coutW(a)
#define coutE(a)
#define ccoutI(a)
#define ccoutD(a)
int Int_t
Signed integer 4 bytes (int)
Definition RtypesCore.h:59
static void indent(ostringstream &buf, int indent_level)
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void data
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void input
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
char name[80]
Definition TGX11.cxx:148
float xmin
float ymin
float xmax
float ymax
char * Form(const char *fmt,...)
Formats a string in a circular formatting buffer.
Definition TString.cxx:2495
const_iterator begin() const
const_iterator end() const
Common abstract base class for objects that represent a value and a "shape" in RooFit.
Definition RooAbsArg.h:76
void clearValueAndShapeDirty() const
Definition RooAbsArg.h:535
void Print(Option_t *options=nullptr) const override
Print the object to the defaultPrintStream().
Definition RooAbsArg.h:238
RooFit::OwningPtr< RooArgSet > getParameters(const RooAbsData *data, bool stripDisconnected=true) const
Create a list of leaf nodes in the arg tree starting with ourself as top node that don't match any of...
RooFit::OwningPtr< RooArgSet > getObservables(const RooArgSet &set, bool valueOnly=true) const
Given a set of possible observables, return the observables that this PDF depends on.
const Text_t * getStringAttribute(const Text_t *key) const
Get string attribute mapped under key 'key'.
virtual std::unique_ptr< RooAbsArg > compileForNormSet(RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const
RooFit::OwningPtr< RooArgSet > getComponents() const
Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.
bool getAttribute(const Text_t *name) const
Check if a named attribute is set. By default, all attributes are unset.
RooAbsCache * getCache(Int_t index) const
Return registered cache object by index.
const RefCountList_t & clients() const
List of all clients of this object.
Definition RooAbsArg.h:137
bool isValueDirty() const
Definition RooAbsArg.h:356
void setProxyNormSet(const RooArgSet *nset)
Forward a change in the cached normalization argset to all the registered proxies.
void branchNodeServerList(RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool recurseNonDerived=false) const
Fill supplied list with all branch nodes of the arg tree starting with ourself as top node.
TObject * Clone(const char *newname=nullptr) const override
Make a clone of an object using the Streamer facility.
Definition RooAbsArg.h:88
RefCountList_t _serverList
Definition RooAbsArg.h:564
Int_t numCaches() const
Return number of registered caches.
RooAbsArg * findServer(const char *name) const
Return server of this with name name. Returns nullptr if not found.
Definition RooAbsArg.h:147
RooAbsArg * _owner
! Pointer to owning RooAbsArg
Abstract base class for objects that represent a discrete value that can be set from the outside,...
Abstract container object that can hold multiple RooAbsArg objects.
virtual bool add(const RooAbsArg &var, bool silent=false)
Add the specified argument to list.
RooAbsArg * find(const char *name) const
Find object with given name in list.
void Print(Option_t *options=nullptr) const override
This method must be overridden when a class wants to print itself.
Abstract base class for binned and unbinned datasets.
Definition RooAbsData.h:56
Abstract base class for generator contexts of RooAbsPdf objects.
virtual RooDataSet * generate(double nEvents=0, bool skipInit=false, bool extendedMode=false)
Generate the specified number of events with nEvents>0 and and return a dataset containing the genera...
bool isValid() const
virtual void setProtoDataOrder(Int_t *lut)
Set the traversal order of prototype data to that in the lookup tables passed as argument.
std::unique_ptr< RooAbsReal > _norm
Definition RooAbsPdf.h:321
~CacheElem() override
Destructor of normalization cache element.
Abstract interface for all probability density functions.
Definition RooAbsPdf.h:32
virtual bool syncNormalization(const RooArgSet *dset, bool adjustProxies=true) const
Verify that the normalization integral cached with this PDF is valid for given set of normalization o...
double getNorm(const RooArgSet &nset) const
Get normalisation term needed to normalise the raw values returned by getVal().
Definition RooAbsPdf.h:191
std::unique_ptr< RooAbsArg > compileForNormSet(RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const override
RooObjCacheManager _normMgr
! The cache manager
Definition RooAbsPdf.h:323
std::unique_ptr< RooNumGenConfig > _specGeneratorConfig
! MC generator configuration specific for this object
Definition RooAbsPdf.h:334
double getValV(const RooArgSet *set=nullptr) const override
Return current value, normalized by integrating over the observables in nset.
virtual std::unique_ptr< RooFitResult > fitToImpl(RooAbsData &data, const RooLinkedList &cmdList)
Protected implementation of the likelihood fitting routine.
virtual void generateEvent(Int_t code)
Interface for generation of an event using the algorithm corresponding to the specified code.
RooFit::OwningPtr< RooAbsReal > createScanCdf(const RooArgSet &iset, const RooArgSet &nset, Int_t numScanBins, Int_t intOrder)
void setGeneratorConfig()
Remove the specialized numeric MC generator configuration associated with this object.
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...
std::unique_ptr< RooArgSet > getAllConstraints(const RooArgSet &observables, RooArgSet &constrainedParams, bool stripDisconnected=true) const
This helper function finds and collects all constraints terms of all component p.d....
static int verboseEval()
Return global level of verbosity for p.d.f. evaluations.
RooFit::OwningPtr< RooAbsReal > createCdf(const RooArgSet &iset, const RooArgSet &nset=RooArgSet())
Create a cumulative distribution function of this p.d.f in terms of the observables listed in iset.
bool isActiveNormSet(RooArgSet const *normSet) const
Checks if normSet is the currently active normalization set of this PDF, meaning is exactly the same ...
Definition RooAbsPdf.h:295
virtual double expectedEvents(const RooArgSet *nset) const
Return expected number of events to be used in calculation of extended likelihood.
virtual RooAbsGenContext * binnedGenContext(const RooArgSet &vars, bool verbose=false) const
Return a binned generator context.
TString _normRange
Normalization range.
Definition RooAbsPdf.h:336
virtual bool isDirectGenSafe(const RooAbsArg &arg) const
Check if given observable can be safely generated using the pdfs internal generator mechanism (if tha...
Int_t * randomizeProtoOrder(Int_t nProto, Int_t nGen, bool resample=false) const
Return lookup table with randomized order for nProto prototype events.
void setNormRange(const char *rangeName)
~RooAbsPdf() override
Destructor.
RooArgSet const * _normSet
! Normalization set with for above integral
Definition RooAbsPdf.h:314
RooPlot * plotOn(RooPlot *frame, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}, const RooCmdArg &arg9={}, const RooCmdArg &arg10={}) const override
Helper calling plotOn(RooPlot*, RooLinkedList&) const.
Definition RooAbsPdf.h:116
RooNumGenConfig * specialGeneratorConfig() const
Returns the specialized integrator configuration for this RooAbsReal.
virtual bool selfNormalized() const
Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.
Definition RooAbsPdf.h:203
void printMultiline(std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Print multi line detailed information of this RooAbsPdf.
virtual double getCorrection() const
This function returns the penalty term.
Int_t _traceCount
Number of traces remaining to print.
Definition RooAbsPdf.h:329
bool canBeExtended() const
If true, PDF can provide extended likelihood term.
Definition RooAbsPdf.h:214
RooAbsReal * _norm
! Normalization integral (owned by _normMgr)
Definition RooAbsPdf.h:313
GenSpec * prepareMultiGen(const RooArgSet &whatVars, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={})
Prepare GenSpec configuration object for efficient generation of multiple datasets from identical spe...
void setTraceCounter(Int_t value, bool allNodes=false)
Reset trace counter to given value, limiting the number of future trace messages for this pdf to 'val...
Int_t _errorCount
Number of errors remaining to print.
Definition RooAbsPdf.h:328
@ CanNotBeExtended
Definition RooAbsPdf.h:208
virtual std::unique_ptr< RooAbsReal > createExpectedEventsFunc(const RooArgSet *nset) const
Returns an object that represents the expected number of events for a given normalization set,...
Int_t _negCount
Number of negative probabilities remaining to print.
Definition RooAbsPdf.h:330
virtual RooPlot * paramOn(RooPlot *frame, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={})
Add a box with parameter values (and errors) to the specified frame.
RooFit::OwningPtr< RooDataSet > generate(const RooArgSet &whatVars, Int_t nEvents, const RooCmdArg &arg1, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={})
See RooAbsPdf::generate(const RooArgSet&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,...
Definition RooAbsPdf.h:49
virtual const RooAbsReal * getNormObj(const RooArgSet *set, const RooArgSet *iset, const TNamed *rangeName=nullptr) const
Return pointer to RooAbsReal object that implements calculation of integral over observables iset in ...
void setActiveNormSet(RooArgSet const *normSet) const
Setter for the _normSet member, which should never be set directly.
Definition RooAbsPdf.h:280
double analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Analytical integral with normalization (see RooAbsReal::analyticalIntegralWN() for further informatio...
void setNormRangeOverride(const char *rangeName)
virtual RooFit::OwningPtr< RooDataSet > generateSimGlobal(const RooArgSet &whatVars, Int_t nEvents)
Special generator interface for generation of 'global observables' – for RooStats tools.
virtual RooAbsGenContext * autoGenContext(const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false, bool autoBinned=true, const char *binnedTag="") const
const RooNumGenConfig * getGeneratorConfig() const
Return the numeric MC generator configuration used for this object.
virtual void initGenerator(Int_t code)
Interface for one-time initialization to setup the generator for the specified code.
virtual ExtendMode extendMode() const
Returns ability of PDF to provide extended likelihood terms.
Definition RooAbsPdf.h:212
RooAbsPdf()
Default constructor.
virtual RooFit::OwningPtr< RooDataHist > generateBinned(const RooArgSet &whatVars, double nEvents, const RooCmdArg &arg1, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}) const
As RooAbsPdf::generateBinned(const RooArgSet&, const RooCmdArg&,const RooCmdArg&, const RooCmdArg&,...
Definition RooAbsPdf.h:102
bool traceEvalPdf(double value) const
Check that passed value is positive and not 'not-a-number'.
static RooNumGenConfig * defaultGeneratorConfig()
Returns the default numeric MC generator configuration for all RooAbsReals.
bool redirectServersHook(const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep) override
Hook function intercepting redirectServer calls.
void printValue(std::ostream &os) const override
Print value of p.d.f, also print normalization integral that was last used, if any.
virtual std::unique_ptr< RooAbsReal > createNLLImpl(RooAbsData &data, const RooLinkedList &cmdList)
Protected implementation of the NLL creation routine.
void logBatchComputationErrors(std::span< const double > &outputs, std::size_t begin) const
Scan through outputs and fix+log all nans and negative values.
virtual RooAbsGenContext * genContext(const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false) const
Interface function to create a generator context from a p.d.f.
void getLogProbabilities(std::span< const double > pdfValues, double *output) const
static TString _normRangeOverride
Definition RooAbsPdf.h:337
static Int_t _verboseEval
Definition RooAbsPdf.h:308
double extendedTerm(double sumEntries, double expected, double sumEntriesW2=0.0, bool doOffset=false) const
virtual Int_t getGenerator(const RooArgSet &directVars, RooArgSet &generateVars, bool staticInitOK=true) const
Load generatedVars with the subset of directVars that we can generate events for, and return a code t...
virtual RooAbsPdf * createProjection(const RooArgSet &iset)
Return a p.d.f that represent a projection of this p.d.f integrated over given observables.
virtual double getLogVal(const RooArgSet *set=nullptr) const
Return the log of the current value with given normalization An error message is printed if the argum...
bool hasRange(const char *name) const override
Check if variable has a binning with given name.
std::pair< double, double > getRange(const char *name=nullptr) const
Get low and high bound of the variable.
Abstract base class for objects that represent a real value and implements functionality common to al...
Definition RooAbsReal.h:63
RooDataHist * fillDataHist(RooDataHist *hist, const RooArgSet *nset, double scaleFactor, bool correctForBinVolume=false, bool showProgress=false) const
Fill a RooDataHist with values sampled from this function at the bin centers.
void plotOnCompSelect(RooArgSet *selNodes) const
Helper function for plotting of composite p.d.fs.
double getVal(const RooArgSet *normalisationSet=nullptr) const
Evaluate object.
Definition RooAbsReal.h:107
bool plotSanityChecks(RooPlot *frame) const
Utility function for plotOn(), perform general sanity check on frame to ensure safe plotting operatio...
void printMultiline(std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Structure printing.
bool redirectServersHook(const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep) override
Function that is called at the end of redirectServers().
double _value
Cache for current value of object.
Definition RooAbsReal.h:539
virtual double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
TString integralNameSuffix(const RooArgSet &iset, const RooArgSet *nset=nullptr, const char *rangeName=nullptr, bool omitEmpty=false) const
Construct string with unique suffix name to give to integral object that encodes integrated observabl...
virtual double evaluate() const =0
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
void logEvalError(const char *message, const char *serverValueString=nullptr) const
Log evaluation error message.
const RooNumIntConfig * getIntegratorConfig() const
Return the numeric integration configuration used for this object.
virtual bool isBinnedDistribution(const RooArgSet &) const
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
Definition RooAbsReal.h:343
RooFit::OwningPtr< RooAbsReal > createIntRI(const RooArgSet &iset, const RooArgSet &nset={})
Utility function for createRunningIntegral.
virtual RooPlot * plotOn(RooPlot *frame, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}, const RooCmdArg &arg9={}, const RooCmdArg &arg10={}) const
Plot (project) PDF on specified frame.
RooFit::OwningPtr< RooAbsReal > createIntegral(const RooArgSet &iset, const RooCmdArg &arg1, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}) const
Create an object that represents the integral of the function over one or more observables listed in ...
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:24
Efficient implementation of the generator context specific for binned pdfs.
Int_t setObj(const RooArgSet *nset, T *obj, const TNamed *isetRangeName=nullptr)
Setter function without integration set.
T * getObj(const RooArgSet *nset, Int_t *sterileIndex=nullptr, const TNamed *isetRangeName=nullptr)
Getter function without integration set.
Implementation of RooAbsCachedReal that can cache any external RooAbsReal input function provided in ...
Named container for two doubles, two integers two object points and three string pointers that can be...
Definition RooCmdArg.h:26
Configurable parser for RooCmdArg named arguments.
void defineMutex(const char *head, Args_t &&... tail)
Define arguments where any pair is mutually exclusive.
bool process(const RooCmdArg &arg)
Process given RooCmdArg.
bool hasProcessed(const char *cmdName) const
Return true if RooCmdArg with name 'cmdName' has been processed.
double getDouble(const char *name, double defaultValue=0.0) const
Return double property registered with name 'name'.
bool defineDouble(const char *name, const char *argName, int doubleNum, double defValue=0.0)
Define double property name 'name' mapped to double in slot 'doubleNum' in RooCmdArg with name argNam...
static void stripCmdList(RooLinkedList &cmdList, const char *cmdsToPurge)
Utility function that strips command names listed (comma separated) in cmdsToPurge from cmdList.
RooArgSet * getSet(const char *name, RooArgSet *set=nullptr) const
Return RooArgSet property registered with name 'name'.
bool defineSet(const char *name, const char *argName, int setNum, const RooArgSet *set=nullptr)
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName ...
bool ok(bool verbose) const
Return true of parsing was successful.
bool defineObject(const char *name, const char *argName, int setNum, const TObject *obj=nullptr, bool isArray=false)
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName ...
const char * getString(const char *name, const char *defaultValue="", bool convEmptyToNull=false) const
Return string property registered with name 'name'.
bool defineString(const char *name, const char *argName, int stringNum, const char *defValue="", bool appendMode=false)
Define double property name 'name' mapped to double in slot 'stringNum' in RooCmdArg with name argNam...
bool defineInt(const char *name, const char *argName, int intNum, int defValue=0)
Define integer property name 'name' mapped to integer in slot 'intNum' in RooCmdArg with name argName...
void allowUndefined(bool flag=true)
If flag is true the processing of unrecognized RooCmdArgs is not considered an error.
int getInt(const char *name, int defaultValue=0) const
Return integer property registered with name 'name'.
TObject * getObject(const char *name, TObject *obj=nullptr) const
Return TObject property registered with name 'name'.
Container class to hold unbinned data.
Definition RooDataSet.h:32
void markAsCompiled(RooAbsArg &arg) const
void compileServers(RooAbsArg &arg, RooArgSet const &normSet)
Implements a universal generator context for all RooAbsPdf classes that do not have or need a special...
Switches the message service to a different level while the instance is alive.
Definition RooHelpers.h:37
Collection class for internal use, storing a collection of RooAbsArg pointers in a doubly linked list...
static const char * str(const TNamed *ptr)
Return C++ string corresponding to given TNamed pointer.
Definition RooNameReg.h:39
Holds the configuration parameters of the various numeric integrators used by RooRealIntegral.
static RooNumGenConfig & defaultConfig()
Return reference to instance of default numeric integrator configuration object.
Implementation of a RooCacheManager<RooAbsCacheElement> that specializes in the storage of cache elem...
void sterilize() override
Clear the cache payload but retain slot mapping w.r.t to normalization and integration sets.
Plot frame and a container for graphics objects within that frame.
Definition RooPlot.h:43
void addObject(TObject *obj, Option_t *drawOptions="", bool invisible=false)
Add a generic object to this plot.
Definition RooPlot.cxx:326
double getFitRangeNEvt() const
Return the number of events in the fit range.
Definition RooPlot.h:139
const RooArgSet * getNormVars() const
Definition RooPlot.h:146
RooAbsRealLValue * getPlotVar() const
Definition RooPlot.h:137
void updateNormVars(const RooArgSet &vars)
Install the given set of observables are reference normalization variables for this frame.
Definition RooPlot.cxx:311
double getFitRangeBinW() const
Return the bin width that is being used to normalise the PDF.
Definition RooPlot.h:142
virtual void printStream(std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
Print description of object on ostream, printing contents set by contents integer,...
A RooAbsPdf implementation that represent a projection of a given input p.d.f and the object returned...
static UInt_t integer(UInt_t max, TRandom *generator=randomGenerator())
Return an integer uniformly distributed from [0,n-1].
Definition RooRandom.cxx:95
static TRandom * randomGenerator()
Return a pointer to a singleton random-number generator implementation.
Definition RooRandom.cxx:47
Performs hybrid numerical/analytical integrals of RooAbsReal objects.
const RooArgSet & numIntRealVars() const
Variable that can be changed from the outside.
Definition RooRealVar.h:37
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
const char * GetName() const override
Returns name of object.
Definition TNamed.h:49
const char * GetTitle() const override
Returns title of object.
Definition TNamed.h:50
Mother of all ROOT objects.
Definition TObject.h:42
virtual const char * GetName() const
Returns name of object.
Definition TObject.cxx:459
virtual const char * ClassName() const
Returns name of class to which the object belongs.
Definition TObject.cxx:224
A Pave (see TPave) with text, lines or/and boxes inside.
Definition TPaveText.h:21
Basic string class.
Definition TString.h:138
Ssiz_t Length() const
Definition TString.h:425
const char * Data() const
Definition TString.h:384
TLine * line
void box(Int_t pat, Double_t x1, Double_t y1, Double_t x2, Double_t y2)
Definition fillpatterns.C:1
RooCmdArg SupNormSet(const RooArgSet &nset)
RooCmdArg NormRange(const char *rangeNameList)
RooCmdArg Range(const char *rangeName, bool adjustNorm=true)
RooCmdArg Normalization(double scaleFactor)
std::vector< std::string > Split(std::string_view str, std::string_view delims, bool skipEmpty=false)
Splits a string at each character in delims.
double normalizeWithNaNPacking(RooAbsPdf const &pdf, double rawVal, double normVal)
T * OwningPtr
An alias for raw pointers for indicating that the return type of a RooFit function is an owning point...
Definition Config.h:35
OwningPtr< T > makeOwningPtr(std::unique_ptr< T > &&ptr)
Internal helper to turn a std::unique_ptr<T> into an OwningPtr.
Definition Config.h:40
RooArgSet selectFromArgSet(RooArgSet const &, std::string const &names)
std::string getColonSeparatedNameString(RooArgSet const &argSet, char delim=':')
Bool_t IsNaN(Double_t x)
Definition TMath.h:903
Double_t QuietNaN()
Returns a quiet NaN as defined by IEEE 754.
Definition TMath.h:913
static double packFloatIntoNaN(float payload)
Pack float into mantissa of a NaN.