Logo ROOT  
Reference Guide
RooHistFunc.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id$
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_HIST_FUNC
17#define ROO_HIST_FUNC
18
19#include "RooAbsReal.h"
20#include "RooRealProxy.h"
21#include "RooSetProxy.h"
22#include "RooAICRegistry.h"
23#include "RooTrace.h"
24#include "RooDataHist.h"
25
26#include <list>
27
28class RooRealVar;
29class RooAbsReal;
30
31class RooHistFunc : public RooAbsReal {
32public:
34 RooHistFunc(const char *name, const char *title, const RooArgSet& vars, const RooDataHist& dhist, Int_t intOrder=0);
35 RooHistFunc(const char *name, const char *title, const RooArgList& funcObs, const RooArgList& histObs, const RooDataHist& dhist, Int_t intOrder=0);
36 RooHistFunc(const char *name, const char *title, const RooArgSet& vars,
37 std::unique_ptr<RooDataHist> dhist, int intOrder=0);
38 RooHistFunc(const char *name, const char *title, const RooArgList& pdfObs, const RooArgList& histObs,
39 std::unique_ptr<RooDataHist> dhist, int intOrder=0);
40 RooHistFunc(const RooHistFunc& other, const char* name=nullptr);
41 TObject* clone(const char* newname) const override { return new RooHistFunc(*this,newname); }
42 ~RooHistFunc() override ;
43
44 /// Return RooDataHist that is represented.
46 return *_dataHist ;
47 }
48
49 /// Return RooDataHist that is represented.
50 const RooDataHist& dataHist() const {
51 return *_dataHist ;
52 }
53
54 /// Get total bin volume spanned by this hist function.
55 /// In 1-d, this is e.g. the range spanned on the x-axis.
56 double totVolume() const;
57
58 /// Set histogram interpolation order.
60
61 _intOrder = order ;
62 }
63
64 /// Return histogram interpolation order.
66
67 return _intOrder ;
68 }
69
70 Int_t getAnalyticalIntegral(RooArgSet& allVars, RooArgSet& analVars, const char* rangeName=nullptr) const override ;
71 double analyticalIntegral(Int_t code, const char* rangeName=nullptr) const override ;
72
73 /// Set use of special boundary conditions for c.d.f.s
74 void setCdfBoundaries(bool flag) {
75 _cdfBoundaries = flag ;
76 }
77
78 /// If true, special boundary conditions for c.d.f.s are used
79 bool getCdfBoundaries() const {
80
81 return _cdfBoundaries ;
82 }
83
84 Int_t getMaxVal(const RooArgSet& vars) const override;
85 double maxVal(Int_t code) const override;
86
87 std::list<double>* binBoundaries(RooAbsRealLValue& /*obs*/, double /*xlo*/, double /*xhi*/) const override ;
88 std::list<double>* plotSamplingHint(RooAbsRealLValue& obs, double xlo, double xhi) const override ;
89 bool isBinnedDistribution(const RooArgSet&) const override { return _intOrder==0 ; }
90 RooArgSet const& getHistObsList() const { return _histObsList; }
91
92
93 Int_t getBin() const;
94 std::vector<Int_t> getBins(RooFit::Detail::DataMap const& dataMap) const;
95
96protected:
97
98 bool importWorkspaceHook(RooWorkspace& ws) override ;
99 bool areIdentical(const RooDataHist& dh1, const RooDataHist& dh2) ;
100
101 double evaluate() const override;
102 void computeBatch(cudaStream_t*, double* output, size_t size, RooFit::Detail::DataMap const&) const override;
103 friend class RooAbsCachedReal ;
104
105 void ioStreamerPass2() override ;
106
107 RooArgSet _histObsList; ///< List of observables defining dimensions of histogram
108 RooSetProxy _depList; ///< List of observables mapped onto histogram observables
109 RooDataHist* _dataHist = nullptr; ///< Unowned pointer to underlying histogram
110 std::unique_ptr<RooDataHist> _ownedDataHist; ///<! Owned pointer to underlying histogram
111 mutable RooAICRegistry _codeReg; ///<! Auxiliary class keeping tracking of analytical integration code
112 Int_t _intOrder = 0; ///< Interpolation order
113 bool _cdfBoundaries = false; ///< Use boundary conditions for CDFs.
114 mutable double _totVolume = 0.0; ///<! Total volume of space (product of ranges of observables)
115 bool _unitNorm = false; ///<! Assume contents is unit normalized (for use as pdf cache)
116
117 ClassDefOverride(RooHistFunc,2) // Histogram based function
118};
119
120#endif
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
char name[80]
Definition: TGX11.cxx:110
RooAICRegistry is a utility class for operator p.d.f classes that keeps track of analytical integrati...
RooAbsCachedReal is the abstract base class for functions that need or want to cache their evaluate()...
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:62
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:22
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:56
The RooDataHist is a container class to hold N-dimensional binned data.
Definition: RooDataHist.h:39
RooHistFunc implements a real-valued function sampled from a multidimensional histogram.
Definition: RooHistFunc.h:31
Int_t getInterpolationOrder() const
Return histogram interpolation order.
Definition: RooHistFunc.h:65
bool _cdfBoundaries
Use boundary conditions for CDFs.
Definition: RooHistFunc.h:113
RooDataHist * _dataHist
Unowned pointer to underlying histogram.
Definition: RooHistFunc.h:109
double _totVolume
! Total volume of space (product of ranges of observables)
Definition: RooHistFunc.h:114
void setCdfBoundaries(bool flag)
Set use of special boundary conditions for c.d.f.s.
Definition: RooHistFunc.h:74
void setInterpolationOrder(Int_t order)
Set histogram interpolation order.
Definition: RooHistFunc.h:59
std::vector< Int_t > getBins(RooFit::Detail::DataMap const &dataMap) const
Compute bin numbers corresponding to all coordinates in evalData.
double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const override
Return integral identified by 'code'.
~RooHistFunc() override
RooAICRegistry _codeReg
! Auxiliary class keeping tracking of analytical integration code
Definition: RooHistFunc.h:111
void computeBatch(cudaStream_t *, double *output, size_t size, RooFit::Detail::DataMap const &) const override
Base function for computing multiple values of a RooAbsReal.
bool _unitNorm
! Assume contents is unit normalized (for use as pdf cache)
Definition: RooHistFunc.h:115
std::list< double > * binBoundaries(RooAbsRealLValue &, double, double) const override
Return sampling hint for making curves of (projections) of this function as the recursive division st...
std::unique_ptr< RooDataHist > _ownedDataHist
! Owned pointer to underlying histogram
Definition: RooHistFunc.h:110
void ioStreamerPass2() override
Schema evolution: if histObsList wasn't filled from persistence (v1) then fill it here.
double evaluate() const override
Return the current value: The value of the bin enclosing the current coordinates of the dependents,...
std::list< double > * plotSamplingHint(RooAbsRealLValue &obs, double xlo, double xhi) const override
Return sampling hint for making curves of (projections) of this function as the recursive division st...
bool getCdfBoundaries() const
If true, special boundary conditions for c.d.f.s are used.
Definition: RooHistFunc.h:79
Int_t getMaxVal(const RooArgSet &vars) const override
Only handle case of maximum in all variables.
double totVolume() const
Get total bin volume spanned by this hist function.
Int_t getBin() const
Compute bin number corresponding to current coordinates.
bool areIdentical(const RooDataHist &dh1, const RooDataHist &dh2)
double maxVal(Int_t code) const override
Return maximum value for set of observables identified by code assigned in getMaxVal.
const RooDataHist & dataHist() const
Return RooDataHist that is represented.
Definition: RooHistFunc.h:50
bool importWorkspaceHook(RooWorkspace &ws) override
Check if our datahist is already in the workspace.
RooArgSet const & getHistObsList() const
Definition: RooHistFunc.h:90
Int_t getAnalyticalIntegral(RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const override
Determine integration scenario.
bool isBinnedDistribution(const RooArgSet &) const override
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
Definition: RooHistFunc.h:89
RooDataHist & dataHist()
Return RooDataHist that is represented.
Definition: RooHistFunc.h:45
Int_t _intOrder
Interpolation order.
Definition: RooHistFunc.h:112
RooSetProxy _depList
List of observables mapped onto histogram observables.
Definition: RooHistFunc.h:108
RooArgSet _histObsList
List of observables defining dimensions of histogram.
Definition: RooHistFunc.h:107
TObject * clone(const char *newname) const override
Definition: RooHistFunc.h:41
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:40
The RooWorkspace is a persistable container for RooFit projects.
Definition: RooWorkspace.h:43
Mother of all ROOT objects.
Definition: TObject.h:41
static void output()