Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsOptTestStatistic.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\file RooAbsOptTestStatistic.cxx
19\class RooAbsOptTestStatistic
20\ingroup Roofitcore
21
22Abstract base class for test
23statistics objects that evaluate a function or PDF at each point of a given
24dataset. This class provides generic optimizations, such as
25caching and precalculation of constant terms that can be made for
26all such quantities.
27
28Implementations should define evaluatePartition(), which calculates the
29value of a (sub)range of the dataset and optionally combinedValue(),
30which combines the values calculated for each partition. If combinedValue()
31is not overloaded, the default implementation will add the partition results
32to obtain the combined result.
33
34Support for calculation in partitions is needed to allow multi-core
35parallelized calculation of test statistics.
36**/
37
39
40#include "Riostream.h"
41#include "TClass.h"
42#include <cstring>
43
44#include "RooAbsData.h"
45#include "RooAbsDataStore.h"
46#include "RooAbsPdf.h"
47#include "RooAddPdf.h"
48#include "RooArgSet.h"
49#include "RooBinSamplingPdf.h"
50#include "RooBinning.h"
51#include "RooCategory.h"
52#include "RooDataHist.h"
53#include "RooDataSet.h"
54#include "RooErrorHandler.h"
55#include "RooFitImplHelpers.h"
56#include "RooGlobalFunc.h"
57#include "RooMsgService.h"
58#include "RooProdPdf.h"
59#include "RooProduct.h"
60#include "RooRealSumPdf.h"
61#include "RooRealVar.h"
62#include "RooTrace.h"
63#include "RooVectorDataStore.h"
64
65#include "ROOT/StringUtils.hxx"
66
67using std::endl, std::ostream;
68
69////////////////////////////////////////////////////////////////////////////////
70/// Create a test statistic, and optimise its calculation.
71/// \param[in] name Name of the instance.
72/// \param[in] title Title (for e.g. plotting).
73/// \param[in] real Function to evaluate.
74/// \param[in] indata Dataset for which to compute test statistic.
75/// \param[in] projDeps A set of projected observables.
76/// \param[in] cfg the statistic configuration
77///
78/// cfg contains:
79/// - rangeName If not null, only events in the dataset inside the range will be used in the test
80/// statistic calculation.
81/// - addCoefRangeName If not null, all RooAddPdf components of `real` will be
82/// instructed to fix their fraction definitions to the given named range.
83/// - nCPU If > 1, the test statistic calculation will be parallelised over multiple processes. By default, the data
84/// is split with 'bulk' partitioning (each process calculates a contiguous block of fraction 1/nCPU
85/// of the data). For binned data, this approach may be suboptimal as the number of bins with >0 entries
86/// in each processing block may vary greatly; thereby distributing the workload rather unevenly.
87/// - interleave Strategy how to distribute events among workers. If an interleave partitioning strategy is used where each partition
88/// i takes all bins for which (ibin % ncpu == i), an even distribution of work is more likely.
89/// - splitCutRange If true, a different rangeName constructed as `rangeName_{catName}` will be used
90/// as range definition for each index state of a RooSimultaneous.
91/// - cloneInputData Not used. Data is always cloned.
92/// - integrateOverBinsPrecision If > 0, PDF in binned fits are integrated over the bins. This sets the precision. If = 0,
93/// only unbinned PDFs fit to RooDataHist are integrated. If < 0, PDFs are never integrated.
95 RooAbsData &indata, const RooArgSet &projDeps,
97 : RooAbsTestStatistic(name, title, real, indata, projDeps, cfg),
98 _integrateBinsPrecision(cfg.integrateOverBinsPrecision)
99{
100 // Don't do a thing in master mode
101 if (operMode() != Slave) {
102 return;
103 }
104
105 initSlave(real, indata, projDeps, _rangeName.c_str(), _addCoefRangeName.c_str());
106}
107
108////////////////////////////////////////////////////////////////////////////////
109/// Copy constructor
110
112 : RooAbsTestStatistic(other, name),
113 _sealed(other._sealed),
114 _sealNotice(other._sealNotice),
115 _skipZeroWeights(other._skipZeroWeights),
116 _integrateBinsPrecision(other._integrateBinsPrecision)
117{
118 // Don't do a thing in master mode
119 if (operMode() != Slave) {
120
121 if (other._normSet) {
122 _normSet = new RooArgSet;
123 other._normSet->snapshot(*_normSet);
124 }
125 return;
126 }
127
128 initSlave(*other._funcClone, *other._dataClone, other._projDeps ? *other._projDeps : RooArgSet(),
129 other._rangeName.c_str(), other._addCoefRangeName.c_str());
130}
131
132
133
134////////////////////////////////////////////////////////////////////////////////
135
136void RooAbsOptTestStatistic::initSlave(RooAbsReal& real, RooAbsData& indata, const RooArgSet& projDeps, const char* rangeName,
137 const char* addCoefRangeName) {
138 // ******************************************************************
139 // *** PART 1 *** Clone incoming pdf, attach to each other *
140 // ******************************************************************
141
142 // Clone FUNC
143 _funcClone = RooHelpers::cloneTreeWithSameParameters(real, indata.get()).release();
144 _funcCloneSet = nullptr ;
145
146 // Attach FUNC to data set
147 _funcObsSet = std::unique_ptr<RooArgSet>{_funcClone->getObservables(indata)}.release();
148
149 if (_funcClone->getAttribute("BinnedLikelihood")) {
150 _funcClone->setAttribute("BinnedLikelihoodActive") ;
151 }
152
153 // Mark all projected dependents as such
154 if (!projDeps.empty()) {
155 std::unique_ptr<RooArgSet> projDataDeps{_funcObsSet->selectCommon(projDeps)};
156 projDataDeps->setAttribAll("projectedDependent") ;
157 }
158
159 // If PDF is a RooProdPdf (with possible constraint terms)
160 // analyze pdf for actual parameters (i.e those in unconnected constraint terms should be
161 // ignored as here so that the test statistic will not be recalculated if those
162 // are changed
163 RooProdPdf* pdfWithCons = dynamic_cast<RooProdPdf*>(_funcClone) ;
164 if (pdfWithCons) {
165
166 std::unique_ptr<RooArgSet> connPars{pdfWithCons->getConnectedParameters(*indata.get())};
167 // Add connected parameters as servers
168 _paramSet.add(*connPars) ;
169
170 } else {
171 // Add parameters as servers
173 }
174
175 // Store normalization set
176 _normSet = new RooArgSet;
177 indata.get()->snapshot(*_normSet, false);
178
179 // Expand list of observables with any observables used in parameterized ranges.
180 // This NEEDS to be a counting loop since we are inserting during the loop.
181 for (std::size_t i = 0; i < _funcObsSet->size(); ++i) {
182 auto realDepRLV = dynamic_cast<const RooAbsRealLValue*>((*_funcObsSet)[i]);
183 if (realDepRLV && realDepRLV->isDerived()) {
184 RooArgSet tmp2;
185 realDepRLV->leafNodeServerList(&tmp2, nullptr, true);
186 _funcObsSet->add(tmp2,true);
187 }
188 }
189
190
191
192 // ******************************************************************
193 // *** PART 2 *** Clone and adjust incoming data, attach to PDF *
194 // ******************************************************************
195
196 // Check if the fit ranges of the dependents in the data and in the FUNC are consistent
197 const RooArgSet* dataDepSet = indata.get() ;
198 for (const auto arg : *_funcObsSet) {
199
200 // Check that both dataset and function argument are of type RooRealVar
201 RooRealVar* realReal = dynamic_cast<RooRealVar*>(arg) ;
202 if (!realReal) continue ;
203 RooRealVar* datReal = dynamic_cast<RooRealVar*>(dataDepSet->find(realReal->GetName())) ;
204 if (!datReal) continue ;
205
206 // Check that range of observables in pdf is equal or contained in range of observables in data
207
208 if (!realReal->getBinning().lowBoundFunc() && realReal->getMin()<(datReal->getMin()-1e-6)) {
209 coutE(InputArguments) << "RooAbsOptTestStatistic: ERROR minimum of FUNC observable " << arg->GetName()
210 << "(" << realReal->getMin() << ") is smaller than that of "
211 << arg->GetName() << " in the dataset (" << datReal->getMin() << ")" << endl ;
213 return ;
214 }
215
216 if (!realReal->getBinning().highBoundFunc() && realReal->getMax()>(datReal->getMax()+1e-6)) {
217 coutE(InputArguments) << "RooAbsOptTestStatistic: ERROR maximum of FUNC observable " << arg->GetName()
218 << " is larger than that of " << arg->GetName() << " in the dataset" << endl ;
220 return ;
221 }
222 }
223
224 // Copy data and strip entries lost by adjusted fit range, _dataClone ranges will be copied from realDepSet ranges
225 if (rangeName && strlen(rangeName)) {
226 _dataClone = std::unique_ptr<RooAbsData>{indata.reduce(RooFit::SelectVars(*_funcObsSet),RooFit::CutRange(rangeName))}.release();
227 // cout << "RooAbsOptTestStatistic: reducing dataset to fit in range named " << rangeName << " resulting dataset has " << _dataClone->sumEntries() << " events" << endl ;
228 } else {
229 _dataClone = static_cast<RooAbsData*>(indata.Clone()) ;
230 }
231 _ownData = true ;
232
233
234 // ******************************************************************
235 // *** PART 3 *** Make adjustments for fit ranges, if specified *
236 // ******************************************************************
237
238 std::unique_ptr<RooArgSet> origObsSet( real.getObservables(indata) );
239 if (rangeName && strlen(rangeName)) {
240 cxcoutI(Fitting) << "RooAbsOptTestStatistic::ctor(" << GetName() << ") constructing test statistic for sub-range named " << rangeName << endl ;
241
242 if(auto pdfClone = dynamic_cast<RooAbsPdf*>(_funcClone)) {
243 pdfClone->setNormRange(rangeName);
244 }
245
246 // Print warnings if the requested ranges are not available for the observable
247 for (const auto arg : *_funcObsSet) {
248
249 if (auto realObs = dynamic_cast<RooRealVar*>(arg)) {
250
251 auto tokens = ROOT::Split(rangeName, ",");
252 for(std::string const& token : tokens) {
253 if(!realObs->hasRange(token.c_str())) {
254 std::stringstream errMsg;
255 errMsg << "The observable \"" << realObs->GetName() << "\" doesn't define the requested range \""
256 << token << "\". Replacing it with the default range." << std::endl;
257 coutI(Fitting) << errMsg.str() << std::endl;
258 }
259 }
260 }
261 }
262 }
263
264
265 // ******************************************************************
266 // *** PART 3.2 *** Binned fits *
267 // ******************************************************************
268
270
271
272 // Fix RooAddPdf coefficients to original normalization range
273 if (rangeName && strlen(rangeName)) {
274
275 // WVE Remove projected dependents from normalization
277
278 if (addCoefRangeName && strlen(addCoefRangeName)) {
279 cxcoutI(Fitting) << "RooAbsOptTestStatistic::ctor(" << GetName()
280 << ") fixing interpretation of coefficients of any RooAddPdf component to range " << addCoefRangeName << endl ;
281 _funcClone->fixAddCoefRange(addCoefRangeName,false) ;
282 }
283 }
284
285
286 // This is deferred from part 2 - but must happen after part 3 - otherwise invalid bins cannot be properly marked in cacheValidEntries
289
290
291
292
293 // *********************************************************************
294 // *** PART 4 *** Adjust normalization range for projected observables *
295 // *********************************************************************
296
297 // Remove projected dependents from normalization set
298 if (!projDeps.empty()) {
299
300 _projDeps = new RooArgSet;
301 projDeps.snapshot(*_projDeps, false) ;
302
303 //RooArgSet* tobedel = (RooArgSet*) _normSet->selectCommon(*_projDeps) ;
304 _normSet->remove(*_projDeps,true,true) ;
305
306 // Mark all projected dependents as such
307 RooArgSet projDataDeps;
308 _funcObsSet->selectCommon(*_projDeps, projDataDeps);
309 projDataDeps.setAttribAll("projectedDependent") ;
310 }
311
312
313 coutI(Optimization) << "RooAbsOptTestStatistic::ctor(" << GetName() << ") optimizing internal clone of p.d.f for likelihood evaluation."
314 << "Lazy evaluation and associated change tracking will disabled for all nodes that depend on observables" << endl ;
315
316
317 // *********************************************************************
318 // *** PART 4 *** Finalization and activation of optimization *
319 // *********************************************************************
320
321 // Redirect pointers of base class to clone
322 _func = _funcClone ;
323 _data = _dataClone ;
324
326
328
329 // It would be unusual if the global observables are used in the likelihood
330 // outside of the constraint terms, but if they are we have to be consistent
331 // and also redirect them to the snapshots in the dataset if appropriate.
334 }
335
336}
337
338
339////////////////////////////////////////////////////////////////////////////////
340/// Destructor
341
343{
344 if (operMode()==Slave) {
345 delete _funcClone ;
346 delete _funcObsSet ;
347 if (_projDeps) {
348 delete _projDeps ;
349 }
350 if (_ownData) {
351 delete _dataClone ;
352 }
353 }
354 delete _normSet ;
355}
356
357
358
359////////////////////////////////////////////////////////////////////////////////
360/// Method to combined test statistic results calculated into partitions into
361/// the global result. This default implementation adds the partition return
362/// values
363
365{
366 // Default implementation returns sum of components
367 double sum(0);
368 double carry(0);
369 for (Int_t i = 0; i < n; ++i) {
370 double y = array[i]->getValV();
371 carry += reinterpret_cast<RooAbsOptTestStatistic*>(array[i])->getCarry();
372 y -= carry;
373 const double t = sum + y;
374 carry = (t - sum) - y;
375 sum = t;
376 }
377 _evalCarry = carry;
378 return sum ;
379}
380
381
382
383////////////////////////////////////////////////////////////////////////////////
384/// Catch server redirect calls and forward to internal clone of function
385
386bool RooAbsOptTestStatistic::redirectServersHook(const RooAbsCollection& newServerList, bool mustReplaceAll, bool nameChange, bool isRecursive)
387{
388 RooAbsTestStatistic::redirectServersHook(newServerList,mustReplaceAll,nameChange,isRecursive) ;
389 if (operMode()!=Slave) return false ;
390 bool ret = _funcClone->recursiveRedirectServers(newServerList,false,nameChange) ;
391 return ret || RooAbsReal::redirectServersHook(newServerList, mustReplaceAll, nameChange, isRecursive);
392}
393
394
395
396////////////////////////////////////////////////////////////////////////////////
397/// Catch print hook function and forward to function clone
398
400{
402 if (operMode()!=Slave) return ;
403 TString indent2(indent) ;
404 indent2 += "opt >>" ;
405 _funcClone->printCompactTree(os,indent2.Data()) ;
406 os << indent2 << " dataset clone = " << _dataClone << " first obs = " << _dataClone->get()->first() << endl ;
407}
408
409
410
411////////////////////////////////////////////////////////////////////////////////
412/// Driver function to propagate constant term optimizations in test statistic.
413/// If code Activate is sent, constant term optimization will be executed.
414/// If code Deactivate is sent, any existing constant term optimizations will
415/// be abandoned. If codes ConfigChange or ValueChange are sent, any existing
416/// constant term optimizations will be redone.
417
419{
420 // cout << "ROATS::constOpt(" << GetName() << ") funcClone structure dump BEFORE const-opt" << endl ;
421 // _funcClone->Print("t") ;
422
423 RooAbsTestStatistic::constOptimizeTestStatistic(opcode,doAlsoTrackingOpt);
424 if (operMode()!=Slave) return ;
425
426 if (_dataClone->hasFilledCache() && _dataClone->store()->cacheOwner()!=this) {
427 if (opcode==Activate) {
428 cxcoutW(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
429 << ") dataset cache is owned by another object, no constant term optimization can be applied" << endl ;
430 }
431 return ;
432 }
433
434 if (!allowFunctionCache()) {
435 if (opcode==Activate) {
436 cxcoutI(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
437 << ") function caching prohibited by test statistic, no constant term optimization is applied" << endl ;
438 }
439 return ;
440 }
441
442 if (_dataClone->hasFilledCache() && opcode==Activate) {
443 opcode=ValueChange ;
444 }
445
446 switch(opcode) {
447 case Activate:
448 cxcoutI(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
449 << ") optimizing evaluation of test statistic by finding all nodes in p.d.f that depend exclusively"
450 << " on observables and constant parameters and precalculating their values" << endl ;
451 optimizeConstantTerms(true,doAlsoTrackingOpt) ;
452 break ;
453
454 case DeActivate:
455 cxcoutI(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
456 << ") deactivating optimization of constant terms in test statistic" << endl ;
457 optimizeConstantTerms(false) ;
458 break ;
459
460 case ConfigChange:
461 cxcoutI(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
462 << ") one ore more parameter were changed from constant to floating or vice versa, "
463 << "re-evaluating constant term optimization" << endl ;
464 optimizeConstantTerms(false) ;
465 optimizeConstantTerms(true,doAlsoTrackingOpt) ;
466 break ;
467
468 case ValueChange:
469 cxcoutI(Optimization) << "RooAbsOptTestStatistic::constOptimize(" << GetName()
470 << ") the value of one ore more constant parameter were changed re-evaluating constant term optimization" << endl ;
471 // Request a forcible cache update of all cached nodes
473
474 break ;
475 }
476
477// cout << "ROATS::constOpt(" << GetName() << ") funcClone structure dump AFTER const-opt" << endl ;
478// _funcClone->Print("t") ;
479}
480
481
482
483////////////////////////////////////////////////////////////////////////////////
484/// This method changes the value caching logic for all nodes that depends on any of the observables
485/// as defined by the given dataset. When evaluating a test statistic constructed from the RooAbsReal
486/// with a dataset the observables are guaranteed to change with every call, thus there is no point
487/// in tracking these changes which result in a net overhead. Thus for observable-dependent nodes,
488/// the evaluation mechanism is changed from being dependent on a 'valueDirty' flag to guaranteed evaluation.
489/// On the dataset side, the observables objects are modified to no longer send valueDirty messages
490/// to their client
491
493{
494// cout << "RooAbsOptTestStatistic::optimizeCaching(" << GetName() << "," << this << ")" << endl ;
495
496 // Trigger create of all object caches now in nodes that have deferred object creation
497 // so that cache contents can be processed immediately
499
500 // Set value caching mode for all nodes that depend on any of the observables to ADirty
502
503 // Disable propagation of dirty state flags for observables
504 _dataClone->setDirtyProp(false) ;
505
506 // Disable reading of observables that are not used
508}
509
510
511
512////////////////////////////////////////////////////////////////////////////////
513/// Driver function to activate global constant term optimization.
514/// If activated, constant terms are found and cached with the dataset.
515/// The operation mode of cached nodes is set to AClean meaning that
516/// their getVal() call will never result in an evaluate call.
517/// Finally the branches in the dataset that correspond to observables
518/// that are exclusively used in constant terms are disabled as
519/// they serve no more purpose
520
521void RooAbsOptTestStatistic::optimizeConstantTerms(bool activate, bool applyTrackingOpt)
522{
523 if(activate) {
524
525 if (_optimized) {
526 return ;
527 }
528
529 // Trigger create of all object caches now in nodes that have deferred object creation
530 // so that cache contents can be processed immediately
532
533
534 // WVE - Patch to allow customization of optimization level per component pdf
535 if (_funcClone->getAttribute("NoOptimizeLevel1")) {
536 coutI(Minimization) << " Optimization customization: Level-1 constant-term optimization prohibited by attribute NoOptimizeLevel1 set on top-level pdf "
537 << _funcClone->ClassName() << "::" << _funcClone->GetName() << endl ;
538 return ;
539 }
540 if (_funcClone->getAttribute("NoOptimizeLevel2")) {
541 coutI(Minimization) << " Optimization customization: Level-2 constant-term optimization prohibited by attribute NoOptimizeLevel2 set on top-level pdf "
542 << _funcClone->ClassName() << "::" << _funcClone->GetName() << endl ;
543 applyTrackingOpt=false ;
544 }
545
546 // Apply tracking optimization here. Default strategy is to track components
547 // of RooAddPdfs and RooRealSumPdfs. If these components are a RooProdPdf
548 // or a RooProduct respectively, track the components of these products instead
549 // of the product term
550 RooArgSet trackNodes ;
551
552
553 // Add safety check here - applyTrackingOpt will only be applied if present
554 // dataset is constructed in terms of a RooVectorDataStore
555 if (applyTrackingOpt) {
556 if (!dynamic_cast<RooVectorDataStore*>(_dataClone->store())) {
557 coutW(Optimization) << "RooAbsOptTestStatistic::optimizeConstantTerms(" << GetName()
558 << ") WARNING Cache-and-track optimization (Optimize level 2) is only available for datasets"
559 << " implement in terms of RooVectorDataStore - ignoring this option for current dataset" << endl ;
560 applyTrackingOpt = false ;
561 }
562 }
563
564 if (applyTrackingOpt) {
565 RooArgSet branches ;
566 _funcClone->branchNodeServerList(&branches) ;
567 for (auto arg : branches) {
568 arg->setCacheAndTrackHints(trackNodes);
569 }
570 // Do not set CacheAndTrack on constant expressions
571 trackNodes.remove(*std::unique_ptr<RooAbsCollection>{trackNodes.selectByAttrib("Constant",true)});
572
573 // Set CacheAndTrack flag on all remaining nodes
574 trackNodes.setAttribAll("CacheAndTrack",true) ;
575 }
576
577 // Find all nodes that depend exclusively on constant parameters
579
581
582 // Cache constant nodes with dataset - also cache entries corresponding to zero-weights in data when using BinnedLikelihood
584
585 // Put all cached nodes in AClean value caching mode so that their evaluate() is never called
586 for (auto cacheArg : _cachedNodes) {
587 cacheArg->setOperMode(RooAbsArg::AClean) ;
588 }
589
590 std::unique_ptr<RooAbsCollection> constNodes{_cachedNodes.selectByAttrib("ConstantExpressionCached",true)};
591 RooArgSet actualTrackNodes(_cachedNodes) ;
592 actualTrackNodes.remove(*constNodes) ;
593 if (!constNodes->empty()) {
594 if (constNodes->size()<20) {
595 coutI(Minimization) << " The following expressions have been identified as constant and will be precalculated and cached: " << *constNodes << endl ;
596 } else {
597 coutI(Minimization) << " A total of " << constNodes->size() << " expressions have been identified as constant and will be precalculated and cached." << endl ;
598 }
599 }
600 if (!actualTrackNodes.empty()) {
601 if (actualTrackNodes.size()<20) {
602 coutI(Minimization) << " The following expressions will be evaluated in cache-and-track mode: " << actualTrackNodes << endl ;
603 } else {
604 coutI(Minimization) << " A total of " << constNodes->size() << " expressions will be evaluated in cache-and-track-mode." << endl ;
605 }
606 }
607
608 // Disable reading of observables that are no longer used
610
611 _optimized = true ;
612
613 } else {
614
615 // Delete the cache
617
618 // Reactivate all tree branches
620
621 // Reset all nodes to ADirty
623
624 // Disable propagation of dirty state flags for observables
625 _dataClone->setDirtyProp(false) ;
626
628
629
630 _optimized = false ;
631 }
632}
633
634
635
636////////////////////////////////////////////////////////////////////////////////
637/// Change dataset that is used to given one. If cloneData is true, a clone of
638/// in the input dataset is made. If the test statistic was constructed with
639/// a range specification on the data, the cloneData argument is ignored and
640/// the data is always cloned.
641bool RooAbsOptTestStatistic::setDataSlave(RooAbsData& indata, bool cloneData, bool ownNewData)
642{
643
644 if (operMode()==SimMaster) {
645 //cout << "ROATS::setDataSlave() ERROR this is SimMaster _funcClone = " << _funcClone << endl ;
646 return false ;
647 }
648
649 //cout << "ROATS::setDataSlave() new dataset size = " << indata.numEntries() << endl ;
650 //indata.Print("v") ;
651
652
653 // If the current dataset is owned, transfer the ownership to unique pointer
654 // that will get out of scope at the end of this function. We can't delete it
655 // right now, because there might be global observables in the model that
656 // first need to be redirected to the new dataset with a later call to
657 // RooAbsArg::recursiveRedirectServers.
658 std::unique_ptr<RooAbsData> oldOwnedData;
659 if (_ownData) {
660 oldOwnedData.reset(_dataClone);
661 _dataClone = nullptr ;
662 }
663
664 if (!cloneData && !_rangeName.empty()) {
665 coutW(InputArguments) << "RooAbsOptTestStatistic::setData(" << GetName() << ") WARNING: test statistic was constructed with range selection on data, "
666 << "ignoring request to _not_ clone the input dataset" << endl ;
667 cloneData = true ;
668 }
669
670 if (cloneData) {
671 // Cloning input dataset
672 if (_rangeName.empty()) {
673 _dataClone = std::unique_ptr<RooAbsData>{indata.reduce(*indata.get())}.release();
674 } else {
675 _dataClone = std::unique_ptr<RooAbsData>{indata.reduce(RooFit::SelectVars(*indata.get()),RooFit::CutRange(_rangeName.c_str()))}.release();
676 }
677 _ownData = true ;
678
679 } else {
680
681 // Taking input dataset
682 _dataClone = &indata ;
683 _ownData = ownNewData ;
684
685 }
686
687 // Attach function clone to dataset
689 _dataClone->setDirtyProp(false) ;
690 _data = _dataClone ;
691
692 // ReCache constant nodes with dataset
693 if (!_cachedNodes.empty()) {
695 }
696
697 // Adjust internal event count
698 setEventCount(indata.numEntries()) ;
699
700 setValueDirty() ;
701
702 // It would be unusual if the global observables are used in the likelihood
703 // outside of the constraint terms, but if they are we have to be consistent
704 // and also redirect them to the snapshots in the dataset if appropriate.
707 }
708
709 return true ;
710}
711
712
713
714
715////////////////////////////////////////////////////////////////////////////////
716
718{
719 if (_sealed) {
720 bool notice = (sealNotice() && strlen(sealNotice())) ;
721 coutW(ObjectHandling) << "RooAbsOptTestStatistic::data(" << GetName()
722 << ") WARNING: object sealed by creator - access to data is not permitted: "
723 << (notice?sealNotice():"<no user notice>") << endl ;
724 static RooDataSet dummy ("dummy","dummy",RooArgSet()) ;
725 return dummy ;
726 }
727 return *_dataClone ;
728}
729
730
731////////////////////////////////////////////////////////////////////////////////
732
734{
735 if (_sealed) {
736 bool notice = (sealNotice() && strlen(sealNotice())) ;
737 coutW(ObjectHandling) << "RooAbsOptTestStatistic::data(" << GetName()
738 << ") WARNING: object sealed by creator - access to data is not permitted: "
739 << (notice?sealNotice():"<no user notice>") << endl ;
740 static RooDataSet dummy ("dummy","dummy",RooArgSet()) ;
741 return dummy ;
742 }
743 return *_dataClone ;
744}
745
746
747////////////////////////////////////////////////////////////////////////////////
748/// Inspect PDF to find out if we are doing a binned fit to a 1-dimensional unbinned PDF.
749/// If this is the case, enable finer sampling of bins by wrapping PDF into a RooBinSamplingPdf.
750/// The member _integrateBinsPrecision decides how we act:
751/// - < 0: Don't do anything.
752/// - = 0: Only enable feature if fitting unbinned PDF to RooDataHist.
753/// - > 0: Enable as requested.
755
756 auto& pdf = static_cast<RooAbsPdf&>(*_funcClone);
759 _funcClone = newPdf.release();
760 }
761
762}
763
764
765/// Returns a suffix string that is unique for RooAbsOptTestStatistic
766/// instances that don't share the same cloned input data object.
768 return Form("_%lx", _dataClone->uniqueId().value()) ;
769}
770
771
772void RooAbsOptTestStatistic::runRecalculateCache(std::size_t firstEvent, std::size_t lastEvent, std::size_t stepSize) const
773{
774 _dataClone->store()->recalculateCache(_projDeps, firstEvent, lastEvent, stepSize, _skipZeroWeights);
775}
#define e(i)
Definition RSha256.hxx:103
#define coutI(a)
#define cxcoutI(a)
#define coutW(a)
#define cxcoutW(a)
#define coutE(a)
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition TGX11.cxx:110
char * Form(const char *fmt,...)
Formats a string in a circular formatting buffer.
Definition TString.cxx:2489
bool recursiveRedirectServers(const RooAbsCollection &newServerList, bool mustReplaceAll=false, bool nameChange=false, bool recurseInNewSet=true)
Recursively replace all servers with the new servers in newSet.
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.
bool addOwnedComponents(const RooAbsCollection &comps)
Take ownership of the contents of 'comps'.
bool findConstantNodes(const RooArgSet &observables, RooArgSet &cacheList)
Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached ...
void printCompactTree(const char *indent="", const char *fileName=nullptr, const char *namePat=nullptr, RooAbsArg *client=nullptr)
Print tree structure of expression tree on stdout, or to file if filename is specified.
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition RooAbsArg.h:431
bool getAttribute(const Text_t *name) const
Check if a named attribute is set. By default, all attributes are unset.
virtual void optimizeCacheMode(const RooArgSet &observables)
Activate cache mode optimization with given definition of observables.
void setAttribute(const Text_t *name, bool value=true)
Set (default) or clear a named boolean attribute of this object.
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.
virtual RooAbsReal * highBoundFunc() const
Return pointer to RooAbsReal parameterized upper bound, if any.
virtual RooAbsReal * lowBoundFunc() const
Return pointer to RooAbsReal parameterized lower bound, if any.
Abstract container object that can hold multiple RooAbsArg objects.
RooAbsCollection * selectByAttrib(const char *name, bool value) const
Create a subset of the current collection, consisting only of those elements with the specified attri...
virtual void removeAll()
Remove all arguments from our set, deleting them if we own them.
virtual bool remove(const RooAbsArg &var, bool silent=false, bool matchByNameOnly=false)
Remove the specified argument from our list.
virtual bool add(const RooAbsArg &var, bool silent=false)
Add the specified argument to list.
void setAttribAll(const Text_t *name, bool value=true)
Set given attribute in each element of the collection by calling each elements setAttribute() functio...
Storage_t::size_type size() const
RooAbsArg * first() const
RooAbsArg * find(const char *name) const
Find object with given name in list.
virtual const RooAbsArg * cacheOwner()=0
virtual void forceCacheUpdate()
virtual void recalculateCache(const RooArgSet *, Int_t, Int_t, Int_t, bool)
Abstract base class for binned and unbinned datasets.
Definition RooAbsData.h:57
virtual const RooArgSet * get() const
Definition RooAbsData.h:101
RooAbsDataStore * store()
Definition RooAbsData.h:77
RooFit::UniqueId< RooAbsData > const & uniqueId() const
Returns a unique ID that is different for every instantiated RooAbsData object.
Definition RooAbsData.h:310
void setDirtyProp(bool flag)
Control propagation of dirty flags from observables in dataset.
virtual void setArgStatus(const RooArgSet &set, bool active)
virtual void cacheArgs(const RooAbsArg *owner, RooArgSet &varSet, const RooArgSet *nset=nullptr, bool skipZeroWeights=false)
Internal method – Cache given set of functions with data.
virtual void optimizeReadingWithCaching(RooAbsArg &arg, const RooArgSet &cacheList, const RooArgSet &keepObsList)
Prepare dataset for use with cached constant terms listed in 'cacheList' of expression 'arg'.
RooFit::OwningPtr< RooAbsData > reduce(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 a reduced copy of this dataset.
bool hasFilledCache() const
virtual Int_t numEntries() const
Return number of entries in dataset, i.e., count unweighted entries.
RooArgSet const * getGlobalObservables() const
Returns snapshot of global observables stored in this data.
Definition RooAbsData.h:290
virtual void resetCache()
Internal method – Remove cached function values.
void attachBuffers(const RooArgSet &extObs)
Abstract base class for test statistics objects that evaluate a function or PDF at each point of a gi...
bool setDataSlave(RooAbsData &data, bool cloneData=true, bool ownNewDataAnyway=false) override
Change dataset that is used to given one.
~RooAbsOptTestStatistic() override
Destructor.
RooAbsReal * _funcClone
Pointer to internal clone of input function.
bool _sealed
Is test statistic sealed – i.e. no access to data.
void optimizeConstantTerms(bool, bool=true)
Driver function to activate global constant term optimization.
double combinedValue(RooAbsReal **gofArray, Int_t nVal) const override
Method to combined test statistic results calculated into partitions into the global result.
void runRecalculateCache(std::size_t firstEvent, std::size_t lastEvent, std::size_t stepSize) const override
bool _ownData
Do we own the dataset.
void optimizeCaching()
This method changes the value caching logic for all nodes that depends on any of the observables as d...
const char * sealNotice() const
bool _skipZeroWeights
! Whether to skip entries with weight zero in the evaluation
RooArgSet * _funcObsSet
List of observables in the pdf expression.
RooAbsOptTestStatistic(const char *name, const char *title, RooAbsReal &real, RooAbsData &data, const RooArgSet &projDeps, RooAbsTestStatistic::Configuration const &cfg)
Create a test statistic, and optimise its calculation.
void constOptimizeTestStatistic(ConstOpCode opcode, bool doAlsoTrackingOpt=true) override
Driver function to propagate constant term optimizations in test statistic.
void setUpBinSampling()
Inspect PDF to find out if we are doing a binned fit to a 1-dimensional unbinned PDF.
bool redirectServersHook(const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursive) override
Catch server redirect calls and forward to internal clone of function.
RooArgSet _cachedNodes
! List of nodes that are cached as constant expressions
void initSlave(RooAbsReal &real, RooAbsData &indata, const RooArgSet &projDeps, const char *rangeName, const char *addCoefRangeName)
void printCompactTreeHook(std::ostream &os, const char *indent="") override
Catch print hook function and forward to function clone.
RooArgSet * _normSet
Pointer to set with observables used for normalization.
const char * cacheUniqueSuffix() const override
Returns a suffix string that is unique for RooAbsOptTestStatistic instances that don't share the same...
RooArgSet * _funcCloneSet
Set owning all components of internal clone of input function.
RooAbsData * _dataClone
Pointer to internal clone if input data.
virtual RooArgSet requiredExtraObservables() const
RooArgSet * _projDeps
Set of projected observable.
Abstract interface for all probability density functions.
Definition RooAbsPdf.h:40
Abstract base class for objects that represent a real value that may appear on the left hand side of ...
virtual double getMax(const char *name=nullptr) const
Get maximum of currently defined range.
virtual double getMin(const char *name=nullptr) const
Get minimum of currently defined range.
Abstract base class for objects that represent a real value and implements functionality common to al...
Definition RooAbsReal.h:59
double getVal(const RooArgSet *normalisationSet=nullptr) const
Evaluate object.
Definition RooAbsReal.h:103
virtual double getValV(const RooArgSet *normalisationSet=nullptr) const
Return value of object.
virtual void fixAddCoefNormalization(const RooArgSet &addNormSet=RooArgSet(), bool force=true)
Fix the interpretation of the coefficient of any RooAddPdf component in the expression tree headed by...
bool redirectServersHook(const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep) override
Function that is called at the end of redirectServers().
virtual void fixAddCoefRange(const char *rangeName=nullptr, bool force=true)
Fix the interpretation of the coefficient of any RooAddPdf component in the expression tree headed by...
Abstract base class for all test statistics.
double _evalCarry
! carry of Kahan sum in evaluatePartition
std::string _addCoefRangeName
Name of reference to be used for RooAddPdf components.
GOFOpMode operMode() const
RooSetProxy _paramSet
Parameters of the test statistic (=parameters of the input function)
RooAbsReal * _func
Pointer to original input function.
void printCompactTreeHook(std::ostream &os, const char *indent="") override
Add extra information on component test statistics when printing itself as part of a tree structure.
std::string _rangeName
Name of range in which to calculate test statistic.
void constOptimizeTestStatistic(ConstOpCode opcode, bool doAlsoTrackingOpt=true) override
Forward constant term optimization management calls to component test statistics.
void setEventCount(Int_t nEvents)
virtual double getCarry() const
RooAbsData * _data
Pointer to original input dataset.
const bool _takeGlobalObservablesFromData
If the global observable values are taken from data.
bool redirectServersHook(const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursive) override
Forward server redirect calls to component test statistics.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition RooArgSet.h:24
RooArgSet * snapshot(bool deepCopy=true) const
Use RooAbsCollection::snapshot(), but return as RooArgSet.
Definition RooArgSet.h:154
RooArgSet * selectCommon(const RooAbsCollection &refColl) const
Use RooAbsCollection::selecCommon(), but return as RooArgSet.
Definition RooArgSet.h:149
static std::unique_ptr< RooAbsPdf > create(RooAbsPdf &pdf, RooAbsData const &data, double precision)
Creates a wrapping RooBinSamplingPdf if appropriate.
bool add(const RooAbsArg &var, bool valueServer, bool shapeServer, bool silent)
Overloaded RooCollection_t::add() method insert object into set and registers object as server to own...
Container class to hold unbinned data.
Definition RooDataSet.h:34
static void softAbort()
Soft abort function that interrupts macro execution but doesn't kill ROOT.
Efficient implementation of a product of PDFs of the form.
Definition RooProdPdf.h:39
RooArgSet * getConnectedParameters(const RooArgSet &observables) const
Return all parameter constraint p.d.f.s on parameters listed in constrainedParams.
Variable that can be changed from the outside.
Definition RooRealVar.h:37
const RooAbsBinning & getBinning(const char *name=nullptr, bool verbose=true, bool createOnTheFly=false) const override
Return binning definition with name.
Uses std::vector to store data columns.
TObject * Clone(const char *newname="") const override
Make a clone of an object using the Streamer facility.
Definition TNamed.cxx:74
const char * GetName() const override
Returns name of object.
Definition TNamed.h:47
virtual const char * ClassName() const
Returns name of class to which the object belongs.
Definition TObject.cxx:225
Basic string class.
Definition TString.h:139
const char * Data() const
Definition TString.h:376
RooCmdArg SelectVars(const RooArgSet &vars)
RooCmdArg CutRange(const char *rangeName)
Double_t y[n]
Definition legend1.C:17
const Int_t n
Definition legend1.C:16
std::vector< std::string > Split(std::string_view str, std::string_view delims, bool skipEmpty=false)
Splits a string at each character in delims.
std::unique_ptr< T > cloneTreeWithSameParameters(T const &arg, RooArgSet const *observables=nullptr)
Clone RooAbsArg object and reattach to original parameters.
constexpr Value_t value() const
Return numerical value of ID.
Definition UniqueId.h:59
static uint64_t sum(uint64_t i)
Definition Factory.cxx:2345