Logo ROOT  
Reference Guide
RooAbsTestStatistic.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooAbsGoodnessOfFit.h,v 1.15 2007/05/11 09:11:30 verkerke Exp $
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_ABS_TEST_STATISTIC
17#define ROO_ABS_TEST_STATISTIC
18
19#include "RooAbsReal.h"
20#include "RooSetProxy.h"
21#include "RooRealProxy.h"
22#include "TStopwatch.h"
23#include <string>
24
25class RooArgSet ;
26class RooAbsData ;
27class RooAbsReal ;
28class RooSimultaneous ;
29class RooRealMPFE ;
30
35
37 friend class RooRealMPFE;
38public:
39
40 // Constructors, assignment etc
42 RooAbsTestStatistic(const char *name, const char *title, RooAbsReal& real, RooAbsData& data,
43 const RooArgSet& projDeps, const char* rangeName=0, const char* addCoefRangeName=0,
44 Int_t nCPU=1, RooFit::MPSplit interleave=RooFit::BulkPartition, Bool_t verbose=kTRUE, Bool_t splitCutRange=kTRUE) ;
45 RooAbsTestStatistic(const RooAbsTestStatistic& other, const char* name=0);
46 virtual ~RooAbsTestStatistic();
47 virtual RooAbsTestStatistic* create(const char *name, const char *title, RooAbsReal& real, RooAbsData& data,
48 const RooArgSet& projDeps, const char* rangeName=0, const char* addCoefRangeName=0,
49 Int_t nCPU=1, RooFit::MPSplit interleave=RooFit::BulkPartition, Bool_t verbose=kTRUE, Bool_t splitCutRange=kFALSE, Bool_t binnedL=kFALSE) = 0 ;
50
51 virtual void constOptimizeTestStatistic(ConstOpCode opcode, Bool_t doAlsoTrackingOpt=kTRUE) ;
52
53 virtual Double_t combinedValue(RooAbsReal** gofArray, Int_t nVal) const = 0 ;
54 virtual Double_t globalNormalization() const {
55 // Default value of global normalization factor is 1.0
56 return 1.0 ;
57 }
58
59 Bool_t setData(RooAbsData& data, Bool_t cloneData=kTRUE) ;
60
61 void enableOffsetting(Bool_t flag) ;
62 Bool_t isOffsetting() const { return _doOffset ; }
63 virtual Double_t offset() const { return _offset ; }
64 virtual Double_t offsetCarry() const { return _offsetCarry; }
65
66protected:
67
68 virtual void printCompactTreeHook(std::ostream& os, const char* indent="") ;
69
70 virtual Bool_t redirectServersHook(const RooAbsCollection& newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive) ;
71 virtual Double_t evaluate() const ;
72
73 virtual Double_t evaluatePartition(std::size_t firstEvent, std::size_t lastEvent, std::size_t stepSize) const = 0 ;
74 virtual Double_t getCarry() const;
75
77 void setSimCount(Int_t simCount) {
78 // Store total number of components p.d.f. of a RooSimultaneous in this component test statistic
79 _simCount = simCount ;
80 }
81
82 void setEventCount(Int_t nEvents) {
83 // Store total number of events in this component test statistic
84 _nEvents = nEvents ;
85 }
86
87 Int_t numSets() const {
88 // Return total number of sets for parallel calculation
89 return _numSets ;
90 }
91 Int_t setNum() const {
92 // Return parallel calculation set number for this instance
93 return _setNum ;
94 }
95
96 RooSetProxy _paramSet ; // Parameters of the test statistic (=parameters of the input function)
97
100 // Return test statistic operation mode of this instance (SimMaster, MPMaster or Slave)
101 return _gofOpMode ;
102 }
103
104 // Original arguments
105 RooAbsReal* _func ; // Pointer to original input function
106 RooAbsData* _data ; // Pointer to original input dataset
107 const RooArgSet* _projDeps ; // Pointer to set with projected observables
108 std::string _rangeName ; // Name of range in which to calculate test statistic
109 std::string _addCoefRangeName ; // Name of reference to be used for RooAddPdf components
110 Bool_t _splitRange ; // Split rangeName in RooSimultaneous index labels if true
111 Int_t _simCount ; // Total number of component p.d.f.s in RooSimultaneous (if any)
112 Bool_t _verbose ; // Verbose messaging if true
113
114 virtual Bool_t setDataSlave(RooAbsData& /*data*/, Bool_t /*cloneData*/=kTRUE, Bool_t /*ownNewDataAnyway*/=kFALSE) { return kTRUE ; }
115
116 //private:
117
118
119 virtual Bool_t processEmptyDataSets() const { return kTRUE ; }
120
122 void initSimMode(RooSimultaneous* pdf, RooAbsData* data, const RooArgSet* projDeps, const char* rangeName, const char* addCoefRangeName) ;
123 void initMPMode(RooAbsReal* real, RooAbsData* data, const RooArgSet* projDeps, const char* rangeName, const char* addCoefRangeName) ;
124
125 mutable Bool_t _init ; //! Is object initialized
126 GOFOpMode _gofOpMode ; // Operation mode of test statistic instance
127
128 Int_t _nEvents ; // Total number of events in test statistic calculation
129 Int_t _setNum ; // Partition number of this instance in parallel calculation mode
130 Int_t _numSets ; // Total number of partitions in parallel calculation mode
131 Int_t _extSet ; //! Number of designated set to calculated extended term
132
133 // Simultaneous mode data
134 Int_t _nGof ; // Number of sub-contexts
135 pRooAbsTestStatistic* _gofArray ; //! Array of sub-contexts representing part of the combined test statistic
136 std::vector<RooFit::MPSplit> _gofSplitMode ; //! GOF MP Split mode specified by component (when Auto is active)
137
138 // Parallel mode data
139 Int_t _nCPU ; // Number of processors to use in parallel calculation mode
140 pRooRealMPFE* _mpfeArray ; //! Array of parallel execution frond ends
141
142 RooFit::MPSplit _mpinterl ; // Use interleaving strategy rather than N-wise split for partioning of dataset for multiprocessor-split
143 Bool_t _doOffset ; // Apply interval value offset to control numeric precision?
144 mutable Double_t _offset ; //! Offset
145 mutable Double_t _offsetCarry; //! avoids loss of precision
146 mutable Double_t _evalCarry; //! carry of Kahan sum in evaluatePartition
147
148 ClassDef(RooAbsTestStatistic,2) // Abstract base class for real-valued test statistics
149
150};
151
152#endif
RooAbsData * pRooAbsData
RooAbsTestStatistic * pRooAbsTestStatistic
RooRealMPFE * pRooRealMPFE
int Int_t
Definition: RtypesCore.h:43
const Bool_t kFALSE
Definition: RtypesCore.h:90
bool Bool_t
Definition: RtypesCore.h:61
double Double_t
Definition: RtypesCore.h:57
const Bool_t kTRUE
Definition: RtypesCore.h:89
#define ClassDef(name, id)
Definition: Rtypes.h:322
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition: TGX11.cxx:109
RooAbsCollection is an abstract container object that can hold multiple RooAbsArg objects.
RooAbsData is the common abstract base class for binned and unbinned datasets.
Definition: RooAbsData.h:44
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:60
RooAbsTestStatistic is the abstract base class for all test statistics.
virtual Bool_t processEmptyDataSets() const
Int_t _nGof
Number of designated set to calculated extended term.
GOFOpMode operMode() const
void initSimMode(RooSimultaneous *pdf, RooAbsData *data, const RooArgSet *projDeps, const char *rangeName, const char *addCoefRangeName)
Initialize simultaneous p.d.f processing mode.
Int_t _nCPU
GOF MP Split mode specified by component (when Auto is active)
virtual RooAbsTestStatistic * create(const char *name, const char *title, RooAbsReal &real, RooAbsData &data, const RooArgSet &projDeps, const char *rangeName=0, const char *addCoefRangeName=0, Int_t nCPU=1, RooFit::MPSplit interleave=RooFit::BulkPartition, Bool_t verbose=kTRUE, Bool_t splitCutRange=kFALSE, Bool_t binnedL=kFALSE)=0
RooFit::MPSplit _mpinterl
Array of parallel execution frond ends.
virtual void constOptimizeTestStatistic(ConstOpCode opcode, Bool_t doAlsoTrackingOpt=kTRUE)
Forward constant term optimization management calls to component test statistics.
pRooAbsTestStatistic * _gofArray
virtual Double_t globalNormalization() const
Bool_t setData(RooAbsData &data, Bool_t cloneData=kTRUE)
Change dataset that is used to given one.
void enableOffsetting(Bool_t flag)
GOFOpMode _gofOpMode
Is object initialized
RooAbsTestStatistic()
Default constructor.
virtual Double_t offsetCarry() const
void setSimCount(Int_t simCount)
virtual Bool_t redirectServersHook(const RooAbsCollection &newServerList, Bool_t mustReplaceAll, Bool_t nameChange, Bool_t isRecursive)
Forward server redirect calls to component test statistics.
void setEventCount(Int_t nEvents)
virtual Double_t getCarry() const
virtual Double_t evaluatePartition(std::size_t firstEvent, std::size_t lastEvent, std::size_t stepSize) const =0
virtual Bool_t setDataSlave(RooAbsData &, Bool_t=kTRUE, Bool_t=kFALSE)
virtual ~RooAbsTestStatistic()
Destructor.
const RooArgSet * _projDeps
virtual Double_t combinedValue(RooAbsReal **gofArray, Int_t nVal) const =0
virtual Double_t evaluate() const
Calculate and return value of test statistic.
Bool_t isOffsetting() const
Double_t _evalCarry
avoids loss of precision
void initMPMode(RooAbsReal *real, RooAbsData *data, const RooArgSet *projDeps, const char *rangeName, const char *addCoefRangeName)
Initialize multi-processor calculation mode.
virtual Double_t offset() const
std::vector< RooFit::MPSplit > _gofSplitMode
Array of sub-contexts representing part of the combined test statistic.
Double_t _offsetCarry
Offset.
virtual void printCompactTreeHook(std::ostream &os, const char *indent="")
Add extra information on component test statistics when printing itself as part of a tree structure.
void setMPSet(Int_t setNum, Int_t numSets)
Set MultiProcessor set number identification of this instance.
Bool_t initialize()
One-time initialization of the test statistic.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
RooRealMPFE is the multi-processor front-end for parallel calculation of RooAbsReal objects.
Definition: RooRealMPFE.h:30
RooSetProxy is the concrete proxy for RooArgSet objects.
Definition: RooSetProxy.h:24
RooSimultaneous facilitates simultaneous fitting of multiple PDFs to subsets of a given dataset.
@ BulkPartition
Definition: RooGlobalFunc.h:70