Logo ROOT  
Reference Guide
RooWrapperPdf.h
Go to the documentation of this file.
1// Author: Stephan Hageboeck, CERN
2/*****************************************************************************
3 * Project: RooFit *
4 * Package: RooFitCore *
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-2018, 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_WRAPPER_PDF
17#define ROO_WRAPPER_PDF
18
19#include "RooAbsReal.h"
20#include "RooRealProxy.h"
21#include "RooAbsPdf.h"
22#include <list>
23
24class RooWrapperPdf final : public RooAbsPdf {
25public:
26
28 /// Construct a new RooWrapperPdf.
29 /// \param[in] name A name to identify this object.
30 /// \param[in] title Title (for e.g. plotting)
31 /// \param[in] inputFunction Any RooAbsReal that should be converted into a PDF. Although it's possible
32 /// to pass a PDF, it only makes sense for non-PDF functions.
33 RooWrapperPdf(const char *name, const char *title, RooAbsReal& inputFunction) :
34 RooAbsPdf(name, title),
35 _func("inputFunction", "Function to be converted into a PDF", this, inputFunction) { }
36 ~RooWrapperPdf() override {};
37
38 RooWrapperPdf(const RooWrapperPdf& other, const char *name = nullptr) :
39 RooAbsPdf(other, name),
40 _func("inputFunction", this, other._func) { }
41
42 TObject* clone(const char* newname) const override {
43 return new RooWrapperPdf(*this, newname);
44 }
45
46 // Analytical Integration handling
47 bool forceAnalyticalInt(const RooAbsArg& dep) const override {
48 return _func.arg().forceAnalyticalInt(dep);
49 }
50 Int_t getAnalyticalIntegralWN(RooArgSet& allVars, RooArgSet& analVars, const RooArgSet* normSet,
51 const char* rangeName=nullptr) const override {
52 return _func.arg().getAnalyticalIntegralWN(allVars, analVars, normSet, rangeName);
53 }
55 const char* rangeName=nullptr) const override {
56 return _func.arg().getAnalyticalIntegral(allVars, numVars, rangeName);
57 }
58 double analyticalIntegralWN(Int_t code, const RooArgSet* normSet, const char* rangeName) const override {
59 return _func.arg().analyticalIntegralWN(code, normSet, rangeName);
60 }
61 double analyticalIntegral(Int_t code, const char* rangeName=nullptr) const override {
62 return _func.arg().analyticalIntegral(code, rangeName);
63 }
64
65
66 // Internal toy generation. Since our _func is not a PDF (if it is, it doesn't make sense to use this wrapper),
67 // we cannot do anything.
68 /// Get specialised generator. Since the underlying function is not a PDF, this will always return zero.
69// Int_t getGenerator(const RooArgSet& /*directVars*/, RooArgSet& /*generateVars*/,
70// bool /*staticInitOK = true*/) const override { return 0; }
71// void initGenerator(Int_t /*code*/) override { }
72// void generateEvent(Int_t /*code*/) override { }
73// bool isDirectGenSafe(const RooAbsArg& /*arg*/) const override { return false; }
74
75
76 // Hints for optimized brute-force sampling
77 Int_t getMaxVal(const RooArgSet& vars) const override {
78 return _func.arg().getMaxVal(vars);
79 }
80 double maxVal(Int_t code) const override {
81 return _func.arg().maxVal(code);
82 }
83 Int_t minTrialSamples(const RooArgSet& arGenObs) const override {
84 return _func.arg().minTrialSamples(arGenObs);
85 }
86
87 // Plotting and binning hints
88 bool isBinnedDistribution(const RooArgSet& obs) const override {
89 return _func.arg().isBinnedDistribution(obs);
90 }
91 std::list<double>* binBoundaries(RooAbsRealLValue& obs, double xlo, double xhi) const override {
92 return _func.arg().binBoundaries(obs, xlo, xhi);
93 }
94 std::list<double>* plotSamplingHint(RooAbsRealLValue& obs, double xlo, double xhi) const override {
95 return _func.arg().plotSamplingHint(obs, xlo, xhi);
96 }
97
98
99
100private:
102
103 double evaluate() const override {
104 return _func;
105 }
106
108};
109
110#endif
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
char name[80]
Definition: TGX11.cxx:110
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:71
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
virtual std::list< double > * binBoundaries(RooAbsRealLValue &obs, double xlo, double xhi) const
Retrieve bin boundaries if this distribution is binned in obs.
virtual Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &analVars, const RooArgSet *normSet, const char *rangeName=nullptr) const
Variant of getAnalyticalIntegral that is also passed the normalization set that should be applied to ...
Definition: RooAbsReal.cxx:360
virtual Int_t minTrialSamples(const RooArgSet &) const
Definition: RooAbsReal.h:246
virtual bool forceAnalyticalInt(const RooAbsArg &) const
Definition: RooAbsReal.h:168
virtual double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
Definition: RooAbsReal.cxx:403
virtual Int_t getAnalyticalIntegral(RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const
Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.
Definition: RooAbsReal.cxx:377
virtual double maxVal(Int_t code) const
Return maximum value for set of observables identified by code assigned in getMaxVal.
virtual double analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName=nullptr) const
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
Definition: RooAbsReal.cxx:389
virtual bool isBinnedDistribution(const RooArgSet &) const
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
Definition: RooAbsReal.h:342
virtual std::list< double > * plotSamplingHint(RooAbsRealLValue &obs, double xlo, double xhi) const
Interface for returning an optional hint for initial sampling points when constructing a curve projec...
virtual Int_t getMaxVal(const RooArgSet &vars) const
Advertise capability to determine maximum value of function for given set of observables.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:56
const T & arg() const
Return reference to object held in proxy.
The RooWrapperPdf is a class that can be used to convert a function into a PDF.
Definition: RooWrapperPdf.h:24
RooWrapperPdf(const RooWrapperPdf &other, const char *name=nullptr)
Definition: RooWrapperPdf.h:38
double maxVal(Int_t code) const override
Return maximum value for set of observables identified by code assigned in getMaxVal.
Definition: RooWrapperPdf.h:80
Int_t getMaxVal(const RooArgSet &vars) const override
Get specialised generator. Since the underlying function is not a PDF, this will always return zero.
Definition: RooWrapperPdf.h:77
Int_t getAnalyticalIntegral(RooArgSet &allVars, RooArgSet &numVars, const char *rangeName=nullptr) const override
Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.
Definition: RooWrapperPdf.h:54
Int_t getAnalyticalIntegralWN(RooArgSet &allVars, RooArgSet &analVars, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Variant of getAnalyticalIntegral that is also passed the normalization set that should be applied to ...
Definition: RooWrapperPdf.h:50
RooRealProxy _func
bool isBinnedDistribution(const RooArgSet &obs) const override
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
Definition: RooWrapperPdf.h:88
std::list< double > * plotSamplingHint(RooAbsRealLValue &obs, double xlo, double xhi) const override
Interface for returning an optional hint for initial sampling points when constructing a curve projec...
Definition: RooWrapperPdf.h:94
TObject * clone(const char *newname) const override
Definition: RooWrapperPdf.h:42
double analyticalIntegral(Int_t code, const char *rangeName=nullptr) const override
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
Definition: RooWrapperPdf.h:61
bool forceAnalyticalInt(const RooAbsArg &dep) const override
Definition: RooWrapperPdf.h:47
RooWrapperPdf(const char *name, const char *title, RooAbsReal &inputFunction)
Construct a new RooWrapperPdf.
Definition: RooWrapperPdf.h:33
double analyticalIntegralWN(Int_t code, const RooArgSet *normSet, const char *rangeName) const override
Analytical integral with normalization (see RooAbsReal::analyticalIntegralWN() for further informatio...
Definition: RooWrapperPdf.h:58
double evaluate() const override
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
std::list< double > * binBoundaries(RooAbsRealLValue &obs, double xlo, double xhi) const override
Retrieve bin boundaries if this distribution is binned in obs.
Definition: RooWrapperPdf.h:91
Int_t minTrialSamples(const RooArgSet &arGenObs) const override
Definition: RooWrapperPdf.h:83
~RooWrapperPdf() override
Definition: RooWrapperPdf.h:36
Mother of all ROOT objects.
Definition: TObject.h:41