ROOT   Reference Guide
Searching...
No Matches
RooFFTConvPdf Class Reference

PDF for the numerical (FFT) convolution of two PDFs.

This class implements a generic one-dimensional numeric convolution of two PDFs, and can convolve any two RooAbsPdfs.

The class exploits the convolution theorem

$f(x) * g(x) \rightarrow F(k_i) \cdot G(k_i)$

to calculate the convolution by calculating a Real->Complex FFT of both input PDFs, multiplying the complex coefficients and performing the reverse Complex->Real FFT to get the result in the input space. This class uses the ROOT FFT interface to the (free) FFTW3 package (www.fftw.org), and requires that your ROOT installation is compiled with the fftw3=ON (default). Instructions for manually installing fftw below.

Note that the performance in terms of speed and stability of RooFFTConvPdf is vastly superior to that of RooNumConvPdf.

An important feature of FFT convolutions is that the observable is assumed to be cyclical. This is correct for cyclical observables such as angles, but does not hold in general. For non-cyclical variables, wrap-around artifacts may be encountered, e.g. if the PDF is zero at xMin and non-zero at xMax. A rising tail may appear at xMin. This is inevitable when using FFTs. A distribution with 3 bins therefore looks like:

... 0 1 2 0 1 2 0 1 2 ...

Therefore, if bins 0 and 2 are not equal, the FFT sees a cyclical function with a step at the 2|0 boundary, which causes artifacts in Fourier space.

The spillover or discontinuity can be reduced or eliminated by introducing a buffer zone in the FFT calculation. If this feature is activated (on by default), the sampling array for the FFT calculation is extended in both directions, and padded with the lowest/highest bin. Example:

original: -5 -4 -3 -2 -1 0 +1 +2 +3 +4 +5
add buffer zones: U U -5 -4 -3 -2 -1 0 +1 +2 +3 +4 +5 O O
rotate: 0 +1 +2 +3 +4 +5 O O U U -5 -4 -3 -2 -1
Definition zones.py:1

The buffer bins are stripped away when the FFT output values are transferred back to the p.d.f cache. The default buffer size is 10% of the observable domain size, and can be changed with the setBufferFraction() member function.

The RooFFTConvPdf uses caching inherited from a RooAbsCachedPdf. If it is evaluated for a particular value of x, the FFT and convolution is calculated for all bins in the observable space for the given choice of parameters, which are also stored in the cache. Subsequent evaluations for different values of the convolution observable and identical parameters will be retrieved from the cache. If one or more of the parameters change, the cache will be updated, i.e., a new FFT runs.

The sampling density of the FFT is controlled by the binning of the the convolution observable, which can be changed using RooRealVar::setBins(N). For good results, N should be large (>=1000). Additional interpolation between the bins may improve the result if coarse binnings are chosen. These can be activated in the constructor or by calling setInterpolationOrder(). For N >> 1000, interpolation will not substantially improve the accuracy.

Additionial information on caching can be displayed by monitoring the message stream with topic "Caching" at the INFO level, i.e. by calling RooMsgService::instance().addStream(RooMsgService::INFO,Topic("Caching")) to see these message on stdout.

Multi-dimensional convolutions are not supported at the moment.

## Installing an external version of FFTW on Linux and compiling ROOT to use it

You have two options:

1) Go to www.fftw.org and download the latest stable version (a .tar.gz file)

If you have root access to your machine and want to make a system installation of FFTW

2) Untar fftw-XXX.tar.gz in /tmp, cd into the untarred directory and type './configure' followed by 'make install'. This will install fftw in /usr/local/bin,lib etc...

3) Start from a source installation of ROOT. ROOT should discover it. See https://root.cern/building-root

If you do not have root access and want to make a private installation of FFTW

2) Make a private install area for FFTW, e.g. /home/myself/fftw

3) Untar fftw-XXX.tar.gz in /tmp, cd into the untarred directory and type './configure –prefix=/home/myself/fftw' followed by 'make install'. Substitute /home/myself/fftw with a directory of your choice. This procedure will install FFTW in the location designated by you

4) Start from a source installation of ROOT. Look up and set the proper paths for ROOT to discover FFTW. See https://root.cern/building-root

Definition at line 25 of file RooFFTConvPdf.h.

## Classes

class  FFTCacheElem

## Public Types

enum  BufStrat { Extend =0 , Mirror =1 , Flat =2 }

Public Types inherited from RooAbsCachedPdf
using CacheElem = PdfCacheElem

Public Types inherited from RooAbsPdf
enum  ExtendMode { CanNotBeExtended , CanBeExtended , MustBeExtended }

Public Types inherited from RooAbsReal
enum  ErrorLoggingMode { PrintErrors , CollectErrors , CountErrors , Ignore }

typedef std::map< constRooAbsArg *, std::pair< std::string, std::list< EvalError > > >::const_iterator EvalErrorIter

enum  ScaleType { Raw , Relative , NumEvent , RelativeExpected }

using value_type = double

Public Types inherited from RooAbsArg
enum  CacheMode { Always =0 , NotAdvised =1 , Never =2 }

enum  ConstOpCode { Activate =0 , DeActivate =1 , ConfigChange =2 , ValueChange =3 }

enum  OperMode { Auto =0 , AClean =1 , ADirty =2 }

using RefCountList_t = RooSTLRefCountList< RooAbsArg >

using RefCountListLegacyIterator_t = TIteratorToSTLInterface< RefCountList_t::Container_t >

Public Types inherited from TObject
enum  {
kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
}

enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum  EStatusBits {
kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}

Public Types inherited from RooPrintable
enum  ContentsOption {
kName =1 , kClassName =2 , kValue =4 , kArgs =8 ,
}

enum  StyleOption {
kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 ,
kTreeStructure =5
}

## Public Member Functions

RooFFTConvPdf ()

RooFFTConvPdf (const char *name, const char *title, RooAbsReal &pdfConvVar, RooRealVar &convVar, RooAbsPdf &pdf1, RooAbsPdf &pdf2, Int_t ipOrder=2)
Constructor for numerical (FFT) convolution of PDFs.

RooFFTConvPdf (const char *name, const char *title, RooRealVar &convVar, RooAbsPdf &pdf1, RooAbsPdf &pdf2, Int_t ipOrder=2)
Constructor for numerical (FFT) convolution of PDFs.

RooFFTConvPdf (const RooFFTConvPdf &other, const char *name=nullptr)
Copy constructor.

~RooFFTConvPdf () override
Destructor.

double bufferFraction () const
Return value of buffer fraction applied in FFT calculation array beyond either end of the observable domain to reduce cyclical effects.

BufStrat bufferStrategy () const
Return the strategy currently used to fill the buffer: 'Extend' means is that the input p.d.f convolution observable range is widened to include the buffer range 'Flat' means that the buffer is filled with the p.d.f.

const RooArgSetcacheObservables () const

TObjectclone (const char *newname) const override

Int_t getMaxVal (const RooArgSet &vars) const override
Advertise capability to determine maximum value of function for given set of observables.

TClassIsA () const override

double maxVal (Int_t code) const override
Return maximum value for set of observables identified by code assigned in getMaxVal.

void printMetaArgs (std::ostream &os) const override
Customized printing of arguments of a RooNumConvPdf to more intuitively reflect the contents of the product operator construction.

void setBufferFraction (double frac)
Change the size of the buffer on either side of the observable range to frac times the size of the range of the convolution observable.

void setBufferStrategy (BufStrat bs)
Change strategy to fill the overflow buffer on either side of the convolution observable range.

void setCacheObservables (const RooArgSet &obs)

void setShift (double val1, double val2)

void Streamer (TBuffer &) override
Stream an object of class TObject.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooAbsCachedPdf
RooAbsCachedPdf ()

RooAbsCachedPdf (const char *name, const char *title, int ipOrder=0)
Constructor.

RooAbsCachedPdf (const RooAbsCachedPdf &other, const char *name=nullptr)
Copy constructor.

double analyticalIntegralWN (Int_t code, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Implements internal (analytical) integration capabilities.

std::unique_ptr< RooAbsArgcompileForNormSet (RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const override

bool forceAnalyticalInt (const RooAbsArg &dep) const override
Force RooRealIntegral to offer all our actual observable for internal integration.

Int_t getAnalyticalIntegralWN (RooArgSet &allVars, RooArgSet &analVars, const RooArgSet *normSet, const char *rangeName=nullptr) const override

RooDataHistgetCacheHist (const RooArgSet &nset) const

RooDataHistgetCacheHist (const RooArgSet *nset=nullptr) const
Return pointer to RooDataHist cache histogram for given choice of observables.

RooAbsPdfgetCachePdf (const RooArgSet &nset) const

RooAbsPdfgetCachePdf (const RooArgSet *nset=nullptr) const
Return pointer to RooHistPdf cache pdf for given choice of observables.

Int_t getInterpolationOrder () const

double getValV (const RooArgSet *set=nullptr) const override
Implementation of getVal() overriding default implementation of RooAbsPdf.

bool selfNormalized () const override
Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.

void setInterpolationOrder (int order)
Change the interpolation order that is used in RooHistPdf cache representation smoothing the RooDataHist shapes.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooAbsPdf
RooAbsPdf ()
Default constructor.

RooAbsPdf (const char *name, const char *title, double minVal, double maxVal)
Constructor with name, title, and plot range.

RooAbsPdf (const char *name, const char *title=nullptr)
Constructor with name and title only.

~RooAbsPdf () override
Destructor.

double analyticalIntegralWN (Int_t code, const RooArgSet *normSet, const char *rangeName=nullptr) const override
Analytical integral with normalization (see RooAbsReal::analyticalIntegralWN() for further information).

virtual RooAbsGenContextautoGenContext (const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false, bool autoBinned=true, const char *binnedTag="") const

virtual RooAbsGenContextbinnedGenContext (const RooArgSet &vars, bool verbose=false) const
Return a binned generator context.

bool canBeExtended () const
If true, PDF can provide extended likelihood term.

std::unique_ptr< RooAbsArgcompileForNormSet (RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const override

RooFit::OwningPtr< RooAbsRealcreateCdf (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.

RooFit::OwningPtr< RooAbsRealcreateCdf (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={})
Create an object that represents the integral of the function over one or more observables listed in iset.

virtual std::unique_ptr< RooAbsRealcreateExpectedEventsFunc (const RooArgSet *nset) const
Returns an object that represents the expected number of events for a given normalization set, similar to how createIntegral() returns an object that returns the integral.

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooAbsRealcreateNLL (RooAbsData &data, CmdArgs_t const &... cmdArgs)
Construct representation of -log(L) of PDF with given dataset.

virtual RooAbsPdfcreateProjection (const RooArgSet &iset)
Return a p.d.f that represent a projection of this p.d.f integrated over given observables.

RooFit::OwningPtr< RooAbsRealcreateScanCdf (const RooArgSet &iset, const RooArgSet &nset, Int_t numScanBins, Int_t intOrder)

double expectedEvents (const RooArgSet &nset) const
Return expected number of events to be used in calculation of extended likelihood.

virtual double expectedEvents (const RooArgSet *nset) const
Return expected number of events to be used in calculation of extended likelihood.

double extendedTerm (double sumEntries, double expected, double sumEntriesW2=0.0, bool doOffset=false) const

double extendedTerm (double sumEntries, RooArgSet const *nset, double sumEntriesW2=0.0, bool doOffset=false) const
Return the extended likelihood term ( $$N_\mathrm{expect} - N_\mathrm{observed} \cdot \log(N_\mathrm{expect}$$) of this PDF for the given number of observed events.

double extendedTerm (RooAbsData const &data, bool weightSquared, bool doOffset=false) const
Return the extended likelihood term ( $$N_\mathrm{expect} - N_\mathrm{observed} \cdot \log(N_\mathrm{expect}$$) of this PDF for the given number of observed events.

virtual ExtendMode extendMode () const
Returns ability of PDF to provide extended likelihood terms.

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooFitResultfitTo (RooAbsData &data, CmdArgs_t const &... cmdArgs)
Fit PDF to given dataset.

RooFit::OwningPtr< RooDataSetgenerate (const RooArgSet &whatVars, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={})
Generate a new dataset containing the specified variables with events sampled from our distribution.

RooFit::OwningPtr< RooDataSetgenerate (const RooArgSet &whatVars, const RooDataSet &prototype, Int_t nEvents=0, bool verbose=false, bool randProtoOrder=false, bool resampleProto=false) const
Generate a new dataset using a prototype dataset as a model, with values of the variables in whatVars sampled from our distribution.

RooFit::OwningPtr< RooDataSetgenerate (const RooArgSet &whatVars, double nEvents=0, bool verbose=false, bool autoBinned=true, const char *binnedTag="", bool expectedData=false, bool extended=false) const
Generate a new dataset containing the specified variables with events sampled from our distribution.

RooFit::OwningPtr< RooDataSetgenerate (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&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&)

RooFit::OwningPtr< RooDataSetgenerate (GenSpec &) const
Generate according to GenSpec obtained from prepareMultiGen().

virtual RooFit::OwningPtr< RooDataHistgenerateBinned (const RooArgSet &whatVars, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}) const
Generate a new dataset containing the specified variables with events sampled from our distribution.

virtual RooFit::OwningPtr< RooDataHistgenerateBinned (const RooArgSet &whatVars, double nEvents, bool expectedData=false, bool extended=false) const
Generate a new dataset containing the specified variables with events sampled from our distribution.

virtual RooFit::OwningPtr< RooDataHistgenerateBinned (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&,const RooCmdArg&, const RooCmdArg&,const RooCmdArg&) const.

virtual void generateEvent (Int_t code)
Interface for generation of an event using the algorithm corresponding to the specified code.

virtual RooFit::OwningPtr< RooDataSetgenerateSimGlobal (const RooArgSet &whatVars, Int_t nEvents)
Special generator interface for generation of 'global observables' – for RooStats tools.

RooArgSetgetAllConstraints (const RooArgSet &observables, RooArgSet &constrainedParams, bool stripDisconnected=true, bool removeConstraintsFromPdf=false) const
This helper function finds and collects all constraints terms of all component p.d.f.s and returns a RooArgSet with all those terms.

virtual RooArgSetgetConstraints (const RooArgSet &, RooArgSet &, bool, bool=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 that specifies the generator algorithm we will use.

const RooNumGenConfiggetGeneratorConfig () const
Return the numeric MC generator configuration used for this object.

void getLogProbabilities (std::span< const double > pdfValues, double *output) const

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 argument of the log is negative.

double getNorm (const RooArgSet &nset) const
Get normalisation term needed to normalise the raw values returned by getVal().

virtual double getNorm (const RooArgSet *set=nullptr) const
Get normalisation term needed to normalise the raw values returned by getVal().

const RooAbsRealgetNormIntegral (const RooArgSet &nset) const

virtual const RooAbsRealgetNormObj (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 range rangeName, optionally taking the integrand normalized over observables nset.

double getValV (const RooArgSet *set=nullptr) const override
Return current value, normalized by integrating over the observables in nset.

virtual void initGenerator (Int_t code)
Interface for one-time initialization to setup the generator for the specified code.

virtual bool isDirectGenSafe (const RooAbsArg &arg) const
Check if given observable can be safely generated using the pdfs internal generator mechanism (if that existsP).

bool mustBeExtended () const
If true PDF must provide extended likelihood term.

const char * normRange () const

virtual RooPlotparamOn (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.

RooPlotplotOn (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

RooPlotplotOn (RooPlot *frame, RooLinkedList &cmdList) const override
Plot (project) PDF on specified frame.

GenSpecprepareMultiGen (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 specification.

void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Print multi line detailed information of this RooAbsPdf.

void printValue (std::ostream &os) const override
Print value of p.d.f, also print normalization integral that was last used, if any.

virtual void resetErrorCounters (Int_t resetValue=10)
Reset error counter to given value, limiting the number of future error messages for this pdf to 'resetValue'.

void setGeneratorConfig ()
Remove the specialized numeric MC generator configuration associated with this object.

void setGeneratorConfig (const RooNumGenConfig &config)
Set the given configuration as default numeric MC generator configuration for this object.

void setNormRange (const char *rangeName)

void setNormRangeOverride (const char *rangeName)

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 'value'.

RooNumGenConfigspecialGeneratorConfig () const
Returns the specialized integrator configuration for this RooAbsReal.

RooNumGenConfigspecialGeneratorConfig (bool createOnTheFly)
Returns the specialized integrator configuration for this RooAbsReal.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from RooAbsReal
RooAbsReal ()
coverity[UNINIT_CTOR] Default constructor

RooAbsReal (const char *name, const char *title, const char *unit="")
Constructor with unit label.

RooAbsReal (const char *name, const char *title, double minVal, double maxVal, const char *unit="")
Constructor with plot range and unit label.

RooAbsReal (const RooAbsReal &other, const char *name=nullptr)
Copy constructor.

~RooAbsReal () override
Destructor.

virtual double analyticalIntegral (Int_t code, const char *rangeName=nullptr) const
Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.

TF1asTF (const RooArgList &obs, const RooArgList &pars=RooArgList(), const RooArgSet &nset=RooArgSet()) const
Return a ROOT TF1,2,3 object bound to this RooAbsReal with given definition of observables and parameters.

virtual std::list< double > * binBoundaries (RooAbsRealLValue &obs, double xlo, double xhi) const
Retrieve bin boundaries if this distribution is binned in obs.

RooFit::OwningPtr< RooAbsFuncbindVars (const RooArgSet &vars, const RooArgSet *nset=nullptr, bool clipInvalid=false) const
Create an interface adaptor f(vars) that binds us to the specified variables (in arbitrary order).

virtual std::string buildCallToAnalyticIntegral (Int_t code, const char *rangeName, RooFit::Detail::CodeSquashContext &ctx) const
This function defines the analytical integral translation for the class.

virtual RooFit::OwningPtr< RooFitResultchi2FitTo (RooDataHist &data, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={})
Perform a $$\chi^2$$ fit to given histogram.

virtual RooFit::OwningPtr< RooFitResultchi2FitTo (RooDataHist &data, const RooLinkedList &cmdList)
Calls RooAbsReal::createChi2(RooDataSet& data, const RooLinkedList& cmdList) and returns fit result.

virtual RooFit::OwningPtr< RooFitResultchi2FitTo (RooDataSet &xydata, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={})
Perform a 2-D $$\chi^2$$ fit using a series of x and y values stored in the dataset xydata.

virtual RooFit::OwningPtr< RooFitResultchi2FitTo (RooDataSet &xydata, const RooLinkedList &cmdList)
Perform a 2-D $$\chi^2$$ fit using a series of x and y values stored in the dataset xydata.

virtual RooFit::OwningPtr< RooAbsRealcreateChi2 (RooDataHist &data, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={})
Create a $$\chi^2$$ variable from a histogram and this function.

virtual RooFit::OwningPtr< RooAbsRealcreateChi2 (RooDataHist &data, const RooLinkedList &cmdList)

virtual RooFit::OwningPtr< RooAbsRealcreateChi2 (RooDataSet &data, const RooCmdArg &arg1={}, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={})
Create a $$\chi^2$$ from a series of x and y values stored in a dataset.

virtual RooFit::OwningPtr< RooAbsRealcreateChi2 (RooDataSet &data, const RooLinkedList &cmdList)
See RooAbsReal::createChi2(RooDataSet&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&)

RooFit::OwningPtr< RooAbsArgcreateFundamental (const char *newname=nullptr) const override
Create a RooRealVar fundamental object with our properties.

TH1createHistogram (const char *name, const RooAbsRealLValue &xvar, 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 and fill a ROOT histogram TH1, TH2 or TH3 with the values of this function.

TH1createHistogram (const char *name, const RooAbsRealLValue &xvar, RooLinkedList &argList) const
Internal method implementing createHistogram.

TH1createHistogram (RooStringView varNameList, Int_t xbins=0, Int_t ybins=0, Int_t zbins=0) const
Create and fill a ROOT histogram TH1, TH2 or TH3 with the values of this function for the variables with given names.

RooFit::OwningPtr< RooAbsRealcreateIntegral (const RooArgSet &iset, const char *rangeName) const
Create integral over observables in iset in range named rangeName.

RooFit::OwningPtr< RooAbsRealcreateIntegral (const RooArgSet &iset, const RooArgSet &nset, const char *rangeName=nullptr) const
Create integral over observables in iset in range named rangeName with integrand normalized over observables in nset.

RooFit::OwningPtr< RooAbsRealcreateIntegral (const RooArgSet &iset, const RooArgSet &nset, const RooNumIntConfig &cfg, const char *rangeName=nullptr) const
Create integral over observables in iset in range named rangeName with integrand normalized over observables in nset while using specified configuration for any numeric integration.

virtual RooFit::OwningPtr< RooAbsRealcreateIntegral (const RooArgSet &iset, const RooArgSet *nset=nullptr, const RooNumIntConfig *cfg=nullptr, const char *rangeName=nullptr) const
Create an object that represents the integral of the function over one or more observables listed in iset.

RooFit::OwningPtr< RooAbsRealcreateIntegral (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 iset.

RooFit::OwningPtr< RooAbsRealcreateIntegral (const RooArgSet &iset, const RooNumIntConfig &cfg, const char *rangeName=nullptr) const
Create integral over observables in iset in range named rangeName using specified configuration for any numeric integration.

RooFit::OwningPtr< RooAbsRealcreateIntRI (const RooArgSet &iset, const RooArgSet &nset={})
Utility function for createRunningIntegral.

const RooAbsRealcreatePlotProjection (const RooArgSet &dependentVars, const RooArgSet *projectedVars, RooArgSet *&cloneSet, const char *rangeName=nullptr, const RooArgSet *condObs=nullptr) const
Utility function for plotOn() that creates a projection of a function or p.d.f to be plotted on a RooPlot.

const RooAbsRealcreatePlotProjection (const RooArgSet &depVars, const RooArgSet &projVars, RooArgSet *&cloneSet) const
Utility function for plotOn() that creates a projection of a function or p.d.f to be plotted on a RooPlot.

virtual RooFit::OwningPtr< RooAbsRealcreateProfile (const RooArgSet &paramsOfInterest)
Create a RooProfileLL object that eliminates all nuisance parameters in the present function.

RooFit::OwningPtr< RooAbsRealcreateRunningIntegral (const RooArgSet &iset, const RooArgSet &nset={})
Calls createRunningIntegral(const RooArgSet&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&)

RooFit::OwningPtr< RooAbsRealcreateRunningIntegral (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={})
Create an object that represents the running integral of the function over one or more observables listed in iset, i.e.

RooFit::OwningPtr< RooAbsRealcreateScanRI (const RooArgSet &iset, const RooArgSet &nset, Int_t numScanBins, Int_t intOrder)
Utility function for createRunningIntegral that construct an object implementing the numeric scanning technique for calculating the running integral.

virtual double defaultErrorLevel () const

RooDerivativederivative (RooRealVar &obs, const RooArgSet &normSet, Int_t order, double eps=0.001)
Return function representing first, second or third order derivative of this function.

RooDerivativederivative (RooRealVar &obs, Int_t order=1, double eps=0.001)
Return function representing first, second or third order derivative of this function.

virtual void enableOffsetting (bool)

RooDataHistfillDataHist (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.

TH1fillHistogram (TH1 *hist, const RooArgList &plotVars, double scaleFactor=1, const RooArgSet *projectedVars=nullptr, bool scaling=true, const RooArgSet *condObs=nullptr, bool setError=true) const
Fill the ROOT histogram 'hist' with values sampled from this function at the bin centers.

double findRoot (RooRealVar &x, double xmin, double xmax, double yval)
Return value of x (in range xmin,xmax) at which function equals yval.

Fix the interpretation of the coefficient of any RooAddPdf component in the expression tree headed by this object to the given set of observables.

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 this object to the given set of observables.

virtual void forceNumInt (bool flag=true)

RooFunctorfunctor (const RooArgList &obs, const RooArgList &pars=RooArgList(), const RooArgSet &nset=RooArgSet()) const
Return a RooFunctor object bound to this RooAbsReal with given definition of observables and parameters.

virtual Int_t getAnalyticalIntegral (RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const
Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.

bool getForceNumInt () const

RooNumIntConfiggetIntegratorConfig ()
Return the numeric integration configuration used for this object.

const RooNumIntConfiggetIntegratorConfig () const
Return the numeric integration configuration used for this object.

const char * getPlotLabel () const
Get the label associated with the variable.

double getPropagatedError (const RooFitResult &fr, const RooArgSet &nset={}) const
Propagates parameter uncertainties to an uncertainty estimate for this RooAbsReal.

TString getTitle (bool appendUnit=false) const
Return this variable's title string.

const Text_tgetUnit () const

double getVal (const RooArgSet &normalisationSet) const
Like getVal(const RooArgSet*), but always requires an argument for normalisation.

double getVal (const RooArgSet *normalisationSet=nullptr) const
Evaluate object.

virtual void gradient (double *) const

virtual bool isBinnedDistribution (const RooArgSet &) const
Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.

bool isIdentical (const RooAbsArg &other, bool assumeSameType=false) const override

virtual bool isOffsetting () const

bool isSelectedComp () const
If true, the current pdf is a selected component (for use in plotting)

void logEvalError (const char *message, const char *serverValueString=nullptr) const
Log evaluation error message.

RooAbsMomentmean (RooRealVar &obs)

RooAbsMomentmean (RooRealVar &obs, const RooArgSet &nset)

virtual Int_t minTrialSamples (const RooArgSet &) const

RooAbsMomentmoment (RooRealVar &obs, const RooArgSet &normObs, Int_t order, bool central, bool takeRoot, bool intNormObs)
Return function representing moment of p.d.f (normalized w.r.t given observables) of given order.

RooAbsMomentmoment (RooRealVar &obs, Int_t order, bool central, bool takeRoot)
Return function representing moment of function of given order.

virtual double offset () const

bool operator== (const RooAbsArg &other) const override
Equality operator when comparing to another RooAbsArg.

bool operator== (double value) const
Equality operator comparing to a double.

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 projected on observable obs.

virtual RooPlotplotSliceOn (RooPlot *frame, const RooArgSet &sliceSet, Option_t *drawOptions="L", double scaleFactor=1.0, ScaleType stype=Relative, const RooAbsData *projData=nullptr) const

virtual void preferredObservableScanOrder (const RooArgSet &obs, RooArgSet &orderedObs) const
Interface method for function objects to indicate their preferred order of observables for scanning their values into a (multi-dimensional) histogram or RooDataSet.

void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Structure printing.

void printValue (std::ostream &os) const override
Print object value.

bool readFromStream (std::istream &is, bool compact, bool verbose=false) override
Read object contents from stream (dummy for now)

void selectComp (bool flag)

void setCachedValue (double value, bool notifyClients=true) final
Overwrite the value stored in this object's cache.

virtual bool setData (RooAbsData &, bool=true)

void setIntegratorConfig ()
Remove the specialized numeric integration configuration associated with this object.

void setIntegratorConfig (const RooNumIntConfig &config)
Set the given integrator configuration as default numeric integration configuration for this object.

void setParameterizeIntegral (const RooArgSet &paramVars)

void setPlotLabel (const char *label)
Set the label associated with this variable.

void setUnit (const char *unit)

RooAbsMomentsigma (RooRealVar &obs)

RooAbsMomentsigma (RooRealVar &obs, const RooArgSet &nset)

RooNumIntConfigspecialIntegratorConfig () const
Returns the specialized integrator configuration for this RooAbsReal.

RooNumIntConfigspecialIntegratorConfig (bool createOnTheFly)
Returns the specialized integrator configuration for this RooAbsReal.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void writeToStream (std::ostream &os, bool compact) const override
Write object contents to stream (dummy for now)

Public Member Functions inherited from RooAbsArg
RooAbsArg ()
Default constructor.

RooAbsArg (const char *name, const char *title)
Create an object with the specified name and descriptive title.

RooAbsArg (const RooAbsArg &other, const char *name=nullptr)
Copy constructor transfers all boolean and string properties of the original object.

~RooAbsArg () override
Destructor.

Take ownership of the contents of 'comps'.

Take ownership of the contents of 'comps'.

Take ownership of the contents of 'comps'.

template<typename... Args_t>
bool addOwnedComponents (std::unique_ptr< Args_t >... comps)

virtual void applyWeightSquared (bool flag)
Disables or enables the usage of squared weights.

void attachArgs (const RooAbsCollection &set)
Bind this node to objects in set.

void attachDataSet (const RooAbsData &set)
Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset.

void attachDataStore (const RooAbsDataStore &set)
Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset.

const std::set< std::string > & attributes () const

virtual bool canComputeBatchWithCuda () const

virtual bool checkObservables (const RooArgSet *nset) const
Overloadable function in which derived classes can implement consistency checks of the variables.

TObjectClone (const char *newname=nullptr) const override
Make a clone of an object using the Streamer facility.

virtual RooAbsArgcloneTree (const char *newname=nullptr) const
Clone tree expression of objects.

Int_t Compare (const TObject *other) const override
Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name.

std::size_t dataToken () const
Returns the token for retrieving results in the BatchMode. For internal use only.

Int_t defaultPrintContents (Option_t *opt) const override
Define default contents to print.

bool dependsOn (const RooAbsArg &server, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
Test whether we depend on (ie, are served by) the specified object.

bool dependsOn (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
Test whether we depend on (ie, are served by) any object in the specified collection.

bool dependsOn (TNamed const *namePtr, const RooAbsArg *ignoreArg=nullptr, bool valueOnly=false) const
Test whether we depend on (ie, are served by) an object with a specific name.

bool dependsOnValue (const RooAbsArg &server, const RooAbsArg *ignoreArg=nullptr) const
Check whether this object depends on values served from the object passed as server.

bool dependsOnValue (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=nullptr) const
Check whether this object depends on values from an element in the serverList.

bool getAttribute (const Text_t *name) const
Check if a named attribute is set. By default, all attributes are unset.

RooFit::OwningPtr< RooArgSetgetComponents () const
Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.

bool getObservables (const RooAbsCollection *depList, RooArgSet &outputSet, bool valueOnly=true) const
Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names the args in the supplied argset.

RooFit::OwningPtr< RooArgSetgetObservables (const RooAbsData &data) const
Return the observables of this pdf given the observables defined by data.

RooFit::OwningPtr< RooArgSetgetObservables (const RooAbsData *data) const
Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names of the variable list of the supplied data set (the dependents).

RooFit::OwningPtr< RooArgSetgetObservables (const RooArgSet &set, bool valueOnly=true) const
Given a set of possible observables, return the observables that this PDF depends on.

RooFit::OwningPtr< RooArgSetgetObservables (const RooArgSet *depList, bool valueOnly=true) const
Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names the args in the supplied argset.

RooFit::OwningPtr< RooArgSetgetParameters (const RooAbsData &data, bool stripDisconnected=true) const
Return the parameters of this p.d.f when used in conjunction with dataset 'data'.

RooFit::OwningPtr< RooArgSetgetParameters (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 the names of the variable list of the supplied data set (the dependents).

RooFit::OwningPtr< RooArgSetgetParameters (const RooArgSet &observables, bool stripDisconnected=true) const
Return the parameters of the p.d.f given the provided set of observables.

RooFit::OwningPtr< RooArgSetgetParameters (const RooArgSet *observables, 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 the names the args in the supplied argset.

virtual bool getParameters (const RooArgSet *observables, RooArgSet &outputSet, bool stripDisconnected=true) const
Fills a list with leaf nodes in the arg tree starting with ourself as top node that don't match any of the names the args in the supplied argset.

RooAbsProxygetProxy (Int_t index) const
Return the nth proxy from the proxy list.

const Text_tgetStringAttribute (const Text_t *key) const
Get string attribute mapped under key 'key'.

bool getTransientAttribute (const Text_t *name) const
Check if a named attribute is set.

RooFit::OwningPtr< RooArgSetgetVariables (bool stripDisconnected=true) const
Return RooArgSet with all variables (tree leaf nodes of expression tree)

void graphVizTree (const char *fileName, const char *delimiter="\n", bool useTitle=false, bool useLatex=false)
Create a GraphViz .dot file visualizing the expression tree headed by this RooAbsArg object.

void graphVizTree (std::ostream &os, const char *delimiter="\n", bool useTitle=false, bool useLatex=false)
Write the GraphViz representation of the expression tree headed by this RooAbsArg object to the given ostream.

bool hasClients () const

bool hasDataToken () const

virtual bool hasRange (const char *) const

virtual bool importWorkspaceHook (RooWorkspace &ws)

virtual bool inRange (const char *) const

virtual bool isCategory () const

bool isConstant () const
Check if the "Constant" attribute is set.

virtual bool isDerived () const
Does value or shape of this arg depend on any other arg?

virtual bool isReducerNode () const

bool IsSortable () const override

bool localNoDirtyInhibit () const

const TNamednamePtr () const
De-duplicated pointer to this object's name.

Int_t numProxies () const
Return the number of registered proxies.

bool observableOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg.

bool observableOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg.

RooAbsArgoperator= (const RooAbsArg &other)=delete

bool overlaps (const RooAbsArg &testArg, bool valueOnly=false) const
Test if any of the nodes of tree are shared with that of the given tree.

const RooArgSetownedComponents () const

void Print (Option_t *options=nullptr) const override
Print the object to the defaultPrintStream().

void printAddress (std::ostream &os) const override

void printArgs (std::ostream &os) const override
Print object arguments, ie its proxies.

void printClassName (std::ostream &os) const override
Print object class name.

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 printCompactTree (std::ostream &os, const char *indent="", const char *namePat=nullptr, RooAbsArg *client=nullptr)
Print tree structure of expression tree on given ostream.

virtual void printCompactTreeHook (std::ostream &os, const char *ind="")
Hook function interface for object to insert additional information when printed in the context of a tree structure.

void printComponentTree (const char *indent="", const char *namePat=nullptr, Int_t nLevel=999)
Print tree structure of expression tree on given ostream, only branch nodes are printed.

void printDirty (bool depth=true) const
Print information about current value dirty state information.

void printName (std::ostream &os) const override
Print object name.

void printTitle (std::ostream &os) const override
Print object title.

void printTree (std::ostream &os, TString indent="") const override
Print object tree structure.

bool recursiveCheckObservables (const RooArgSet *nset) const
Recursively call checkObservables on all nodes in the expression tree.

void removeStringAttribute (const Text_t *key)
Delete a string attribute with a given key.

void resetDataToken ()

void setAttribute (const Text_t *name, bool value=true)
Set (default) or clear a named boolean attribute of this object.

void setDataToken (std::size_t index)
Sets the token for retrieving results in the BatchMode. For internal use only.

void setLocalNoDirtyInhibit (bool flag) const

void SetName (const char *name) override
Set the name of the TNamed.

void SetNameTitle (const char *name, const char *title) override
Set all the TNamed parameters (name and title).

void setProhibitServerRedirect (bool flag)

void setStringAttribute (const Text_t *key, const Text_t *value)
Associate string 'value' to this object under key 'key'.

void setTransientAttribute (const Text_t *name, bool value=true)
Set (default) or clear a named boolean attribute of this object.

void setWorkspace (RooWorkspace &ws)

const std::map< std::string, std::string > & stringAttributes () const

const std::set< std::string > & transientAttributes () const

virtual void translate (RooFit::Detail::CodeSquashContext &ctx) const
This function defines a translation for each RooAbsReal based object that can be used to express the class as simple C++ code.

RooWorkspaceworkspace () const

TIteratorclientIterator () const R__DEPRECATED(6
Retrieve a client iterator.

TIterator Use clients () and begin()

TIterator Use end () or range-based loops.")

TIteratorvalueClientIterator () const R__DEPRECATED(6

TIterator Use valueClients () and begin()

TIterator Use end () or range-based loops.")

TIteratorshapeClientIterator () const R__DEPRECATED(6

TIterator Use shapeClients () and begin()

TIterator Use end () or range-based loops.")

TIteratorserverIterator () const R__DEPRECATED(6

TIterator Use servers () and begin()

TIterator Use end () or range-based loops.")

RooFIter valueClientMIterator () const R__DEPRECATED(6

RooFIter Use valueClients () and begin()

RooFIter Use end () or range-based loops.")

RooFIter shapeClientMIterator () const R__DEPRECATED(6

RooFIter Use shapeClients () and begin()

RooFIter Use end () or range-based loops.")

RooFIter serverMIterator () const R__DEPRECATED(6

RooFIter Use servers () and begin()

RooFIter Use end () or range-based loops.")

RooFit::OwningPtr< RooArgSetgetDependents (const RooArgSet &set) const

RooFit::OwningPtr< RooArgSetgetDependents (const RooAbsData *set) const

RooFit::OwningPtr< RooArgSetgetDependents (const RooArgSet *depList) const

bool dependentOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const

bool dependentOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const

bool checkDependents (const RooArgSet *nset) const

bool recursiveCheckDependents (const RooArgSet *nset) const

const RefCountList_tclients () const
List of all clients of this object.

const RefCountList_tvalueClients () const
List of all value clients of this object. Value clients receive value updates.

const RefCountList_tshapeClients () const
List of all shape clients of this object.

const RefCountList_tservers () const
List of all servers of this object.

RooAbsArgfindServer (const char *name) const
Return server of this with name name. Returns nullptr if not found.

RooAbsArgfindServer (const RooAbsArg &arg) const
Return server of this that has the same name as arg. Returns nullptr if not found.

RooAbsArgfindServer (Int_t index) const
Return i-th server from server list.

bool isValueServer (const RooAbsArg &arg) const
Check if this is serving values to arg.

bool isValueServer (const char *name) const
Check if this is serving values to an object with name name.

bool isShapeServer (const RooAbsArg &arg) const
Check if this is serving shape to arg.

bool isShapeServer (const char *name) const
Check if this is serving shape to an object with name name.

void leafNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool recurseNonDerived=false) const
Fill supplied list with all leaf nodes of the arg tree, starting with ourself as top node.

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.

void treeNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=nullptr, bool doBranch=true, bool doLeaf=true, bool valueOnly=false, bool recurseNonDerived=false) const
Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node.

virtual bool isFundamental () const
Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return true.

virtual bool isLValue () const
Is this argument an l-value, i.e., can it appear on the left-hand side of an assignment expression? LValues are also special since they can potentially be analytically integrated and generated.

bool redirectServers (const RooAbsCollection &newServerList, bool mustReplaceAll=false, bool nameChange=false, bool isRecursionStep=false)
Replace all direct servers of this object with the new servers in newServerList.

bool redirectServers (std::unordered_map< RooAbsArg *, RooAbsArg * > const &replacements)
Replace some servers of this object.

bool recursiveRedirectServers (const RooAbsCollection &newServerList, bool mustReplaceAll=false, bool nameChange=false, bool recurseInNewSet=true)
Recursively replace all servers with the new servers in newSet.

virtual void serverNameChangeHook (const RooAbsArg *, const RooAbsArg *)

void addServer (RooAbsArg &server, bool valueProp=true, bool shapeProp=false, std::size_t refCount=1)
Register another RooAbsArg as a server to us, ie, declare that we depend on it.

void addServerList (RooAbsCollection &serverList, bool valueProp=true, bool shapeProp=false)
Register a list of RooAbsArg as servers to us by calling addServer() for each arg in the list.

void replaceServer (RooAbsArg &oldServer, RooAbsArg &newServer, bool valueProp, bool shapeProp)
Replace 'oldServer' with 'newServer', specifying whether the new server has value or shape server properties.

void changeServer (RooAbsArg &server, bool valueProp, bool shapeProp)
Change dirty flag propagation mask for specified server.

void removeServer (RooAbsArg &server, bool force=false)
Unregister another RooAbsArg as a server to us, ie, declare that we no longer depend on its value and shape.

RooAbsArgfindNewServer (const RooAbsCollection &newSet, bool nameChange) const
Find the new server in the specified set that matches the old server.

virtual void optimizeCacheMode (const RooArgSet &observables)
Activate cache mode optimization with given definition of observables.

virtual void optimizeCacheMode (const RooArgSet &observables, RooArgSet &optNodes, RooLinkedList &processedNodes)
Activate cache mode optimization with given definition of observables.

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 with a dataset in a test statistic calculation.

bool findConstantNodes (const RooArgSet &observables, RooArgSet &cacheList, RooLinkedList &processedNodes)
Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached with a dataset in a test statistic calculation.

virtual void constOptimizeTestStatistic (ConstOpCode opcode, bool doAlsoTrackingOpt=true)
Interface function signaling a request to perform constant term optimization.

virtual CacheMode canNodeBeCached () const

virtual void setCacheAndTrackHints (RooArgSet &)

bool isShapeDirty () const

bool isValueDirty () const

bool isValueDirtyAndClear () const

bool isValueOrShapeDirtyAndClear () const

void registerCache (RooAbsCache &cache)
Register RooAbsCache with this object.

void unRegisterCache (RooAbsCache &cache)
Unregister a RooAbsCache. Called from the RooAbsCache destructor.

Int_t numCaches () const
Return number of registered caches.

RooAbsCachegetCache (Int_t index) const
Return registered cache object by index.

OperMode operMode () const
Query the operation mode of this node.

void setOperMode (OperMode mode, bool recurseADirty=true)
Set the operation mode of this node.

void setValueDirty ()
Mark the element dirty. This forces a re-evaluation when a value is requested.

void setShapeDirty ()
Notify that a shape-like property (e.g. binning) has changed.

const char * aggregateCacheUniqueSuffix () const

virtual const char * cacheUniqueSuffix () const

void wireAllCaches ()

RooExpensiveObjectCacheexpensiveObjectCache () const

virtual void setExpensiveObjectCache (RooExpensiveObjectCache &cache)

Public Member Functions inherited from TNamed
TNamed ()

TNamed (const char *name, const char *title)

TNamed (const TNamed &named)
TNamed copy ctor.

TNamed (const TString &name, const TString &title)

virtual ~TNamed ()
TNamed destructor.

void Clear (Option_t *option="") override
Set name and title to empty strings ("").

TObjectClone (const char *newname="") const override
Make a clone of an object using the Streamer facility.

Int_t Compare (const TObject *obj) const override
Compare two TNamed objects.

void Copy (TObject &named) const override
Copy this to obj.

virtual void FillBuffer (char *&buffer)
Encode TNamed into output buffer.

const char * GetName () const override
Returns name of object.

const char * GetTitle () const override
Returns title of object.

ULong_t Hash () const override
Return hash value for this object.

TClassIsA () const override

Bool_t IsSortable () const override

void ls (Option_t *option="") const override
List TNamed name and title.

TNamedoperator= (const TNamed &rhs)
TNamed assignment operator.

void Print (Option_t *option="") const override
Print TNamed name and title.

virtual void SetTitle (const char *title="")
Set the title of the TNamed.

virtual Int_t Sizeof () const
Return size of the TNamed part of the TObject.

void Streamer (TBuffer &) override
Stream an object of class TObject.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
TObject ()
TObject constructor.

TObject (const TObject &object)
TObject copy ctor.

virtual ~TObject ()
TObject destructor.

void AbstractMethod (const char *method) const
Use this method to implement an "abstract" method that you don't want to leave purely abstract.

Append graphics object to current pad.

virtual void Browse (TBrowser *b)
Browse object. May be overridden for another default action.

ULong_t CheckedHash ()
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char * ClassName () const
Returns name of class to which the object belongs.

virtual void Delete (Option_t *option="")
Delete this object.

virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
Computes distance from point (px,py) to the object.

virtual void Draw (Option_t *option="")
Default Draw method for all objects.

virtual void DrawClass () const
Draw class inheritance tree of the class to which this object belongs.

virtual TObjectDrawClone (Option_t *option="") const
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

virtual void Dump () const
Dump contents of object on stdout.

virtual void Error (const char *method, const char *msgfmt,...) const
Issue error message.

virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
Execute method on this object with the given parameter string, e.g.

virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
Execute method on this object with parameters stored in the TObjArray.

virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
Execute action corresponding to an event at (px,py).

virtual void Fatal (const char *method, const char *msgfmt,...) const
Issue fatal error message.

virtual TObjectFindObject (const char *name) const
Must be redefined in derived classes.

virtual TObjectFindObject (const TObject *obj) const
Must be redefined in derived classes.

virtual Option_tGetDrawOption () const
Get option used by the graphics system to draw this object.

virtual const char * GetIconName () const
Returns mime type name of object.

virtual char * GetObjectInfo (Int_t px, Int_t py) const
Returns string containing info about the object at position (px,py).

virtual Option_tGetOption () const

virtual UInt_t GetUniqueID () const
Return the unique object id.

virtual Bool_t HandleTimer (TTimer *timer)
Execute action in response of a timer timing out.

Bool_t HasInconsistentHash () const
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void Info (const char *method, const char *msgfmt,...) const
Issue info message.

virtual Bool_t InheritsFrom (const char *classname) const
Returns kTRUE if object inherits from class "classname".

virtual Bool_t InheritsFrom (const TClass *cl) const
Returns kTRUE if object inherits from TClass cl.

virtual void Inspect () const
Dump contents of this object in a graphics canvas.

void InvertBit (UInt_t f)

Bool_t IsDestructed () const
IsDestructed.

virtual Bool_t IsEqual (const TObject *obj) const
Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t IsFolder () const
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t IsOnHeap () const

R__ALWAYS_INLINE Bool_t IsZombie () const

void MayNotUse (const char *method) const
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t Notify ()
This method must be overridden to handle object notification (the base implementation is no-op).

void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
Use this method to declare a method obsolete.

void operator delete (void *ptr)
Operator delete.

void operator delete (void *ptr, void *vp)
Only called by placement new when throwing an exception.

void operator delete[] (void *ptr)
Operator delete [].

void operator delete[] (void *ptr, void *vp)
Only called by placement new[] when throwing an exception.

void * operator new (size_t sz)

void * operator new (size_t sz, void *vp)

void * operator new[] (size_t sz)

void * operator new[] (size_t sz, void *vp)

TObjectoperator= (const TObject &rhs)
TObject assignment operator.

virtual void Paint (Option_t *option="")
This method must be overridden if a class wants to paint itself.

virtual void Pop ()
Pop on object drawn in a pad to the top of the display list.

virtual Int_t Read (const char *name)
Read contents of object with specified name from the current directory.

virtual void RecursiveRemove (TObject *obj)
Recursively remove this object from a list.

void ResetBit (UInt_t f)

virtual void SaveAs (const char *filename="", Option_t *option="") const
Save this object in the file specified by filename.

virtual void SavePrimitive (std::ostream &out, Option_t *option="")
Save a primitive as a C++ statement(s) on output stream "out".

void SetBit (UInt_t f)

void SetBit (UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.

virtual void SetDrawOption (Option_t *option="")
Set drawing option for object.

virtual void SetUniqueID (UInt_t uid)
Set the unique object id.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void SysError (const char *method, const char *msgfmt,...) const
Issue system error message.

R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const

Int_t TestBits (UInt_t f) const

virtual void UseCurrentStyle ()
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void Warning (const char *method, const char *msgfmt,...) const
Issue warning message.

virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
Write this object to the current directory.

virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
Write this object to the current directory.

Public Member Functions inherited from RooPrintable
RooPrintable ()

virtual ~RooPrintable ()

virtual StyleOption defaultPrintStyle (Option_t *opt) const

virtual void printExtras (std::ostream &os) const
Interface to print extras of object.

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, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'.

void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

## Static Public Member Functions

static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

Static Public Member Functions inherited from RooAbsCachedPdf
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

Static Public Member Functions inherited from RooAbsPdf
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

static RooNumGenConfigdefaultGeneratorConfig ()
Returns the default numeric MC generator configuration for all RooAbsReals.

static int verboseEval ()
Return global level of verbosity for p.d.f. evaluations.

static void verboseEval (Int_t stat)
Change global level of verbosity for p.d.f. evaluations.

Static Public Member Functions inherited from RooAbsReal
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static void clearEvalErrorLog ()
Clear the stack of evaluation error messages.

static const char * DeclFileName ()

static RooNumIntConfigdefaultIntegratorConfig ()
Returns the default numeric integration configuration for all RooAbsReals.

static EvalErrorIter evalErrorIter ()

static ErrorLoggingMode evalErrorLoggingMode ()
Return current evaluation error logging mode.

static bool hideOffset ()

static void logEvalError (const RooAbsReal *originator, const char *origName, const char *message, const char *serverValueString=nullptr)
Interface to insert remote error logging messages received by RooRealMPFE into current error logging stream.

static Int_t numEvalErrorItems ()

static Int_t numEvalErrors ()
Return the number of logged evaluation errors since the last clearing.

static void printEvalErrors (std::ostream &os=std::cout, Int_t maxPerNode=10000000)
Print all outstanding logged evaluation error on the given ostream.

static void setEvalErrorLoggingMode (ErrorLoggingMode m)
Set evaluation error logging mode.

static void setHideOffset (bool flag)

Static Public Member Functions inherited from RooAbsArg
static void setDirtyInhibit (bool flag)
Control global dirty inhibit mode.

static void verboseDirty (bool flag)
Activate verbose messaging related to dirty flag propagation.

Static Public Member Functions inherited from TNamed
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

Static Public Member Functions inherited from TObject
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

static Longptr_t GetDtorOnly ()
Return destructor only flag.

static Bool_t GetObjectStat ()
Get status of object stat flag.

static void SetDtorOnly (void *obj)
Set destructor only flag.

static void SetObjectStat (Bool_t stat)
Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from RooPrintable
static TClassClass ()

static const char * Class_Name ()

static constexpr Version_t Class_Version ()

static const char * DeclFileName ()

static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
Return a reference to the current default stream to use in Print().

static void nameFieldLength (Int_t newLen)
Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.

## Protected Member Functions

RooFit::OwningPtr< RooArgSetactualObservables (const RooArgSet &nset) const override
Return the observables to be cached given the normalization set nset.

RooFit::OwningPtr< RooArgSetactualParameters (const RooArgSet &nset) const override
Return the parameters on which the cache depends given normalization set nset.

void calcParams ()
(Re)calculate effective parameters of this p.d.f.

PdfCacheElemcreateCache (const RooArgSet *nset) const override
Return specialized cache subclass for FFT calculations.

double evaluate () const override
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.

void fillCacheObject (PdfCacheElem &cache) const override
Fill the contents of the cache the FFT convolution output.

void fillCacheSlice (FFTCacheElem &cache, const RooArgSet &slicePosition) const
Fill a slice of cachePdf with the output of the FFT convolution calculation.

RooAbsGenContextgenContext (const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false) const override
Create appropriate generator context for this convolution.

TString histNameSuffix () const override
Suffix for cache histogram (added in addition to suffix for cache name)

const char * inputBaseName () const override
Return base name component for cache components in this case 'PDF1_CONV_PDF2'.

RooAbsArgpdfObservable (RooAbsArg &histObservable) const override
Return p.d.f.

std::vector< doublescanPdf (RooRealVar &obs, RooAbsPdf &pdf, const RooDataHist &hist, const RooArgSet &slicePos, Int_t &N, Int_t &N2, Int_t &zeroBin, double shift) const
Scan the values of 'pdf' in observable 'obs' using the bin values stored in 'hist' at slice position 'slicePos' N is filled with the number of bins defined in hist, N2 is filled with N plus the number of buffer bins The return value is an array of doubles of length N2 with the sampled values.

Protected Member Functions inherited from RooAbsCachedPdf
virtual const char * binningName () const

std::string cacheNameSuffix (const RooArgSet &nset) const
Construct string with unique suffix for cache objects based on observable names that define cache configuration.

void disableCache (bool flag)

void doEval (RooFit::EvalContext &) const override
Base function for computing multiple values of a RooAbsReal.

PdfCacheElemgetCache (const RooArgSet *nset, bool recalculate=true) const
Retrieve cache object associated with given choice of observables.

virtual const char * payloadUniqueSuffix () const

Protected Member Functions inherited from RooAbsPdf
RooAbsPdf (const RooAbsPdf &other, const char *name=nullptr)
Copy constructor.

virtual std::unique_ptr< RooAbsRealcreateNLLImpl (RooAbsData &data, const RooLinkedList &cmdList)
Protected implementation of the NLL creation routine.

virtual std::unique_ptr< RooFitResultfitToImpl (RooAbsData &data, const RooLinkedList &cmdList)
Protected implementation of the likelihood fitting routine.

bool isActiveNormSet (RooArgSet const *normSet) const
Checks if normSet is the currently active normalization set of this PDF, meaning is exactly the same object as the one the _normSet member points to (or both are nullptr).

double normalizeWithNaNPacking (double rawVal, double normVal) const

RooPlotplotOn (RooPlot *frame, PlotOpt o) const override
Plot oneself on 'frame'.

Int_trandomizeProtoOrder (Int_t nProto, Int_t nGen, bool resample=false) const
Return lookup table with randomized order for nProto prototype events.

bool redirectServersHook (const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep) override
The cache manager.

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 observables.

Protected Member Functions inherited from RooAbsReal
void attachToTree (TTree &t, Int_t bufSize=32000) override
Attach object to a branch of given TTree.

void attachToVStore (RooVectorDataStore &vstore) override

void copyCache (const RooAbsArg *source, bool valueOnly=false, bool setValDirty=true) override
Copy the cached value of another RooAbsArg to our cache.

RooFit::OwningPtr< RooAbsRealcreateIntObj (const RooArgSet &iset, const RooArgSet *nset, const RooNumIntConfig *cfg, const char *rangeName) const
Internal utility function for createIntegral() that creates the actual integral object.

void fillTreeBranch (TTree &t) override
Fill the tree branch that associated with this object with its current value.

void findInnerMostIntegration (const RooArgSet &allObs, RooArgSet &innerObs, const char *rangeName) const
Utility function for createIntObj() that aids in the construct of recursive integrals over functions with multiple observables with parameterized ranges.

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 observables, normalization observables and the integration range name.

bool isValid () const override
Check if current value is valid.

virtual bool isValidReal (double, bool printError=false) const
Interface function to check if given value is a valid value for this object. Returns true unless overridden.

void makeProjectionSet (const RooAbsArg *plotVar, const RooArgSet *allVars, RooArgSet &projectedVars, bool silent) const
Utility function for plotOn() that constructs the set of observables to project when plotting ourselves as function of 'plotVar'.

bool matchArgs (const RooArgSet &allDeps, RooArgSet &numDeps, const RooArgProxy &a) const
Utility function for use in getAnalyticalIntegral().

bool matchArgs (const RooArgSet &allDeps, RooArgSet &numDeps, const RooArgProxy &a, const RooArgProxy &b) const
Utility function for use in getAnalyticalIntegral().

bool matchArgs (const RooArgSet &allDeps, RooArgSet &numDeps, const RooArgProxy &a, const RooArgProxy &b, const RooArgProxy &c) const
Utility function for use in getAnalyticalIntegral().

bool matchArgs (const RooArgSet &allDeps, RooArgSet &numDeps, const RooArgProxy &a, const RooArgProxy &b, const RooArgProxy &c, const RooArgProxy &d) const
Utility function for use in getAnalyticalIntegral().

bool matchArgs (const RooArgSet &allDeps, RooArgSet &numDeps, const RooArgSet &set) const
Utility function for use in getAnalyticalIntegral().

bool matchArgsByName (const RooArgSet &allArgs, RooArgSet &matchedArgs, const TList &nameList) const
Check if allArgs contains matching elements for each name in nameList.

virtual RooPlotplotAsymOn (RooPlot *frame, const RooAbsCategoryLValue &asymCat, PlotOpt o) const

void plotOnCompSelect (RooArgSet *selNodes) const
Helper function for plotting of composite p.d.fs.

RooPlotplotOnWithErrorBand (RooPlot *frame, const RooFitResult &fr, double Z, const RooArgSet *params, const RooLinkedList &argList, bool method1) const
Plot function or PDF on frame with support for visualization of the uncertainty encoded in the given fit result fr.

bool plotSanityChecks (RooPlot *frame) const
Utility function for plotOn(), perform general sanity check on frame to ensure safe plotting operations.

bool redirectServersHook (const RooAbsCollection &newServerList, bool mustReplaceAll, bool nameChange, bool isRecursiveStep) override
Function that is called at the end of redirectServers().

virtual void selectNormalization (const RooArgSet *depSet=nullptr, bool force=false)
Interface function to force use of a given set of observables to interpret function value.

virtual void selectNormalizationRange (const char *rangeName=nullptr, bool force=false)
Interface function to force use of a given normalization range to interpret function value.

void setTreeBranchStatus (TTree &t, bool active) override
(De)Activate associated tree branch

void syncCache (const RooArgSet *set=nullptr) override

double traceEval (const RooArgSet *set) const
Calculate current value of object, with error tracing wrapper.

Protected Member Functions inherited from RooAbsArg
void attachToStore (RooAbsDataStore &store)
Attach this argument to the data store such that it reads data from there.

TString cleanBranchName () const
Construct a mangled name from the actual name that is free of any math symbols that might be interpreted by TTree.

void clearShapeDirty () const

void clearValueAndShapeDirty () const

void clearValueDirty () const

virtual void getObservablesHook (const RooArgSet *, RooArgSet *) const

virtual void getParametersHook (const RooArgSet *, RooArgSet *, bool) const

void graphVizAddConnections (std::set< std::pair< RooAbsArg *, RooAbsArg * > > &)
Utility function that inserts all point-to-point client-server connections between any two RooAbsArgs in the expression tree headed by this object in the linkSet argument.

bool inhibitDirty () const
Delete watch flag.

virtual void ioStreamerPass2 ()
Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.

virtual void operModeHook ()

virtual void optimizeDirtyHook (const RooArgSet *)

void printAttribList (std::ostream &os) const
Transient boolean attributes (not copied in ctor)

void registerProxy (RooArgProxy &proxy)
Register an RooArgProxy in the proxy list.

void registerProxy (RooListProxy &proxy)
Register an RooListProxy in the proxy list.

void registerProxy (RooSetProxy &proxy)
Register an RooSetProxy in the proxy list.

void setProxyNormSet (const RooArgSet *nset)
Forward a change in the cached normalization argset to all the registered proxies.

void setShapeDirty (const RooAbsArg *source)
Notify that a shape-like property (e.g. binning) has changed.

void setValueDirty (const RooAbsArg *source)
Force element to re-evaluate itself when a value is requested.

void unRegisterProxy (RooArgProxy &proxy)
Remove proxy from proxy list.

void unRegisterProxy (RooListProxy &proxy)
Remove proxy from proxy list.

void unRegisterProxy (RooSetProxy &proxy)
Remove proxy from proxy list.

Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
Interface to ErrorHandler (protected).

void MakeZombie ()

## Protected Attributes

double _bufFrac

BufStrat _bufStrat

RooSetProxy _cacheObs
Non-convolution observables that are also cached.

RooSetProxy _params
Effective parameters of this p.d.f.

RooRealProxy _pdf1
First input p.d.f.

RooRealProxy _pdf2
Second input p.d.f.

double _shift1

double _shift2

RooRealProxy _x
Convolution observable.

RooRealProxy _xprime
Input function representing value of convolution observable.

Protected Attributes inherited from RooAbsCachedPdf
std::map< Int_t, AnaIntConfig_anaIntMap
! Map for analytical integration codes

RooAICRegistry _anaReg
! Registry for analytical integration codes

RooObjCacheManager _cacheMgr

Int_t _ipOrder
The cache manager.

Protected Attributes inherited from RooAbsPdf
Int_t _errorCount = 0
Number of errors remaining to print.

Int_t _negCount = 0
Number of negative probabilities remaining to print.

RooAbsReal_norm = nullptr

RooObjCacheManager _normMgr

TString _normRange
Normalization range.

RooArgSet const * _normSet = nullptr
Normalization integral (owned by _normMgr)

double _rawValue = 0

bool _selectComp = false
Component selection flag for RooAbsPdf::plotCompOn.

std::unique_ptr< RooNumGenConfig_specGeneratorConfig
! MC generator configuration specific for this object

Int_t _traceCount = 0
Number of traces remaining to print.

Protected Attributes inherited from RooAbsReal
bool _forceNumInt = false
Force numerical integration if flag set.

TString _label
Plot label for objects value.

RooFit::UniqueId< RooArgSet >::Value_t _lastNormSetId = RooFit::UniqueId<RooArgSet>::nullval
Component selection flag for RooAbsPdf::plotCompOn.

Int_t _plotBins = 100
Number of plot bins.

double _plotMax = 0.0
Maximum of plot range.

double _plotMin = 0.0
Minimum of plot range.

bool _selectComp = true
A buffer for reading values from trees.

std::unique_ptr< RooNumIntConfig_specIntegratorConfig

TString _unit
Unit for objects value.

double _value = 0.0
Cache for current value of object.

Protected Attributes inherited from RooAbsArg
std::set< std::string > _boolAttrib

std::set< std::string > _boolAttribTransient

std::vector< RooAbsCache * > _cacheList

RefCountList_t _clientList

RefCountList_t _clientListShape

RefCountList_t _clientListValue

std::size_t _dataToken = std::numeric_limits<std::size_t>::max()
In which workspace do I live, if any.

bool _deleteWatch = false

RooExpensiveObjectCache_eocache {nullptr}
Prohibit server redirects – Debugging tool.

bool _fast = false

bool _isConstant = false
De-duplicated name pointer. This will be equal for all objects with the same name.

bool _localNoInhibitDirty = false
Cached isConstant status.

RooWorkspace_myws = nullptr
Prevent 'AlwaysDirty' mode for this node.

const TNamed_namePtr = nullptr
Pointer to global cache manager for any expensive components created by this object.

OperMode _operMode = Auto

RooArgSet_ownedComponents = nullptr

bool _prohibitServerRedirect = false
Set of owned component.

RooRefArray _proxyList

ProxyListCache _proxyListCache

RefCountList_t _serverList

bool _shapeDirty = true

std::map< std::string, std::string > _stringAttrib

bool _valueDirty = true

Protected Attributes inherited from TNamed
TString fName

TString fTitle

## Private Member Functions

void prepareFFTBinning (RooRealVar &convVar) const
Try to improve the binning and inform user if possible.

## Friends

class FFTCacheElem

class RooConvGenContext

Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }

Static Protected Member Functions inherited from RooAbsReal
static void globalSelectComp (bool flag)
Global switch controlling the activation of the selectComp() functionality.

Static Protected Member Functions inherited from RooAbsArg
static void ioStreamerPass2Finalize ()
Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.

Static Protected Attributes inherited from RooAbsPdf
static TString _normRangeOverride

static Int_t _verboseEval = 0

Static Protected Attributes inherited from RooAbsReal
static Int_t _evalErrorCount = 0

static std::map< const RooAbsArg *, std::pair< std::string, std::list< EvalError > > > _evalErrorList

static ErrorLoggingMode _evalErrorMode = RooAbsReal::PrintErrors

static bool _globalSelectComp = false

static bool _hideOffset = true
Offset hiding flag.

Static Protected Attributes inherited from RooAbsArg
static bool _inhibitDirty

static bool _verboseDirty
cache of the list of proxies. Avoids type casting.

Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength

#include <RooFFTConvPdf.h>

Inheritance diagram for RooFFTConvPdf:
[legend]

## ◆ BufStrat

Enumerator
Extend
Mirror
Flat

Definition at line 47 of file RooFFTConvPdf.h.

## ◆ RooFFTConvPdf() [1/4]

 RooFFTConvPdf::RooFFTConvPdf ( )
inline

Definition at line 28 of file RooFFTConvPdf.h.

## ◆ RooFFTConvPdf() [2/4]

 RooFFTConvPdf::RooFFTConvPdf ( const char * name, const char * title, RooRealVar & convVar, RooAbsPdf & pdf1, RooAbsPdf & pdf2, Int_t ipOrder = 2 )

Constructor for numerical (FFT) convolution of PDFs.

Parameters
 [in] name Name of this PDF [in] title Title for plotting this PDF [in] convVar Observable to convolve the PDFs in
Attention
Use a high number of bins (>= 1000) for good accuracy.
Parameters
 [in] pdf1 First PDF to be convolved [in] pdf2 Second PDF to be convolved [in] ipOrder Order for interpolation between bins (since FFT is discrete) The binning used for the FFT sampling is controlled by the binning named "cache" in the convolution observable convVar. If such a binning is not set, the same number of bins as for convVar will be used.

Definition at line 223 of file RooFFTConvPdf.cxx.

## ◆ RooFFTConvPdf() [3/4]

 RooFFTConvPdf::RooFFTConvPdf ( const char * name, const char * title, RooAbsReal & pdfConvVar, RooRealVar & convVar, RooAbsPdf & pdf1, RooAbsPdf & pdf2, Int_t ipOrder = 2 )

Constructor for numerical (FFT) convolution of PDFs.

Parameters
 [in] name Name of this PDF [in] title Title for plotting this PDF [in] convVar Observable to convolve the PDFs in
Attention
Use a high number of bins (>= 1000) for good accuracy.
Parameters
 [in] pdf1 First PDF to be convolved [in] pdf2 Second PDF to be convolved [in] ipOrder Order for interpolation between bins (since FFT is discrete) The binning used for the FFT sampling is controlled by the binning named "cache" in the convolution observable convVar. If such a binning is not set, the same number of bins as for convVar will be used. [in] pdfConvVar If the variable used for convolution is a PDF, itself, pass the PDF here, and pass the convolution variable to convVar. See also rf210_angularconv.C in the roofit tutorials

Definition at line 248 of file RooFFTConvPdf.cxx.

## ◆ RooFFTConvPdf() [4/4]

 RooFFTConvPdf::RooFFTConvPdf ( const RooFFTConvPdf & other, const char * name = nullptr )

Copy constructor.

Definition at line 272 of file RooFFTConvPdf.cxx.

## ◆ ~RooFFTConvPdf()

 RooFFTConvPdf::~RooFFTConvPdf ( )
override

Destructor.

Definition at line 292 of file RooFFTConvPdf.cxx.

## ◆ actualObservables()

 RooFit::OwningPtr< RooArgSet > RooFFTConvPdf::actualObservables ( const RooArgSet & nset ) const
overrideprotectedvirtual

Return the observables to be cached given the normalization set nset.

If the cache observable is in nset then this is

In case the cache observable is not in nset, then it is

• the convolution observable plus
• all member of nset that are observables of this p.d.f.

Implements RooAbsCachedPdf.

Definition at line 778 of file RooFFTConvPdf.cxx.

## ◆ actualParameters()

 RooFit::OwningPtr< RooArgSet > RooFFTConvPdf::actualParameters ( const RooArgSet & nset ) const
overrideprotectedvirtual

Return the parameters on which the cache depends given normalization set nset.

For this p.d.f these are the parameters of the input p.d.f. but never the convolution variable, in case it is not part of nset.

Implements RooAbsCachedPdf.

Definition at line 833 of file RooFFTConvPdf.cxx.

## ◆ bufferFraction()

 double RooFFTConvPdf::bufferFraction ( ) const
inline

Return value of buffer fraction applied in FFT calculation array beyond either end of the observable domain to reduce cyclical effects.

Definition at line 43 of file RooFFTConvPdf.h.

## ◆ bufferStrategy()

 BufStrat RooFFTConvPdf::bufferStrategy ( ) const
inline

Return the strategy currently used to fill the buffer: 'Extend' means is that the input p.d.f convolution observable range is widened to include the buffer range 'Flat' means that the buffer is filled with the p.d.f.

value at the boundary of the observable range 'Mirror' means that the buffer is filled with a mirror image of the p.d.f. around the convolution observable boundary

Definition at line 52 of file RooFFTConvPdf.h.

## ◆ cacheObservables()

 const RooArgSet & RooFFTConvPdf::cacheObservables ( ) const
inline

Definition at line 39 of file RooFFTConvPdf.h.

## ◆ calcParams()

 void RooFFTConvPdf::calcParams ( )
protected

(Re)calculate effective parameters of this p.d.f.

Definition at line 957 of file RooFFTConvPdf.cxx.

## ◆ Class()

 static TClass * RooFFTConvPdf::Class ( )
static
Returns
TClass describing this class

## ◆ Class_Name()

 static const char * RooFFTConvPdf::Class_Name ( )
static
Returns
Name of this class

## ◆ Class_Version()

 static constexpr Version_t RooFFTConvPdf::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 124 of file RooFFTConvPdf.h.

## ◆ clone()

 TObject * RooFFTConvPdf::clone ( const char * newname ) const
inlineoverridevirtual

Implements RooAbsArg.

Definition at line 34 of file RooFFTConvPdf.h.

## ◆ createCache()

 RooFFTConvPdf::PdfCacheElem * RooFFTConvPdf::createCache ( const RooArgSet * nset ) const
overrideprotectedvirtual

Return specialized cache subclass for FFT calculations.

Reimplemented from RooAbsCachedPdf.

Definition at line 342 of file RooFFTConvPdf.cxx.

## ◆ DeclFileName()

 static const char * RooFFTConvPdf::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 124 of file RooFFTConvPdf.h.

## ◆ evaluate()

 double RooFFTConvPdf::evaluate ( ) const
inlineoverrideprotectedvirtual

Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.

Implements RooAbsReal.

Definition at line 96 of file RooFFTConvPdf.h.

## ◆ fillCacheObject()

 void RooFFTConvPdf::fillCacheObject ( RooAbsCachedPdf::PdfCacheElem & cache ) const
overrideprotectedvirtual

Fill the contents of the cache the FFT convolution output.

Implements RooAbsCachedPdf.

Definition at line 479 of file RooFFTConvPdf.cxx.

## ◆ fillCacheSlice()

 void RooFFTConvPdf::fillCacheSlice ( FFTCacheElem & cache, const RooArgSet & slicePosition ) const
protected

Fill a slice of cachePdf with the output of the FFT convolution calculation.

Definition at line 559 of file RooFFTConvPdf.cxx.

## ◆ genContext()

 RooAbsGenContext * RooFFTConvPdf::genContext ( const RooArgSet & vars, const RooDataSet * prototype = nullptr, const RooArgSet * auxProto = nullptr, bool verbose = false ) const
overrideprotectedvirtual

Create appropriate generator context for this convolution.

If both input p.d.f.s support internal generation, if it is safe to use them and if no observables other than the convolution observable are requested for generation, use the specialized convolution generator context which implements a smearing strategy in the convolution observable. If not return the regular accept/reject generator context

Reimplemented from RooAbsPdf.

Definition at line 864 of file RooFFTConvPdf.cxx.

## ◆ getMaxVal()

 Int_t RooFFTConvPdf::getMaxVal ( const RooArgSet & vars ) const
inlineoverridevirtual

Advertise capability to determine maximum value of function for given set of observables.

If no direct generator method is provided, this information will assist the accept/reject generator to operate more efficiently as it can skip the initial trial sampling phase to empirically find the function maximum

Reimplemented from RooAbsReal.

Definition at line 61 of file RooFFTConvPdf.h.

## ◆ histNameSuffix()

 TString RooFFTConvPdf::histNameSuffix ( ) const
overrideprotectedvirtual

Suffix for cache histogram (added in addition to suffix for cache name)

Reimplemented from RooAbsCachedPdf.

Definition at line 448 of file RooFFTConvPdf.cxx.

## ◆ inputBaseName()

 const char * RooFFTConvPdf::inputBaseName ( ) const
overrideprotectedvirtual

Return base name component for cache components in this case 'PDF1_CONV_PDF2'.

Implements RooAbsCachedPdf.

Definition at line 327 of file RooFFTConvPdf.cxx.

## ◆ IsA()

 TClass * RooFFTConvPdf::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from RooAbsCachedPdf.

Definition at line 124 of file RooFFTConvPdf.h.

## ◆ maxVal()

 double RooFFTConvPdf::maxVal ( Int_t code ) const
inlineoverridevirtual

Return maximum value for set of observables identified by code assigned in getMaxVal.

Reimplemented from RooAbsReal.

Definition at line 62 of file RooFFTConvPdf.h.

## ◆ pdfObservable()

 RooAbsArg & RooFFTConvPdf::pdfObservable ( RooAbsArg & histObservable ) const
overrideprotectedvirtual

Return p.d.f.

observable (which can be a function) to substitute given p.d.f. observable. Substitutes x by xprime if xprime is set.

Reimplemented from RooAbsCachedPdf.

Definition at line 847 of file RooFFTConvPdf.cxx.

## ◆ prepareFFTBinning()

 void RooFFTConvPdf::prepareFFTBinning ( RooRealVar & convVar ) const
private

Try to improve the binning and inform user if possible.

With a 10% buffer fraction, 930 raw bins yield 1024 FFT bins, a sweet spot for the speed of FFTW.

Definition at line 302 of file RooFFTConvPdf.cxx.

## ◆ printMetaArgs()

 void RooFFTConvPdf::printMetaArgs ( std::ostream & os ) const
overridevirtual

Customized printing of arguments of a RooNumConvPdf to more intuitively reflect the contents of the product operator construction.

Reimplemented from RooAbsArg.

Definition at line 947 of file RooFFTConvPdf.cxx.

## ◆ scanPdf()

 std::vector< double > RooFFTConvPdf::scanPdf ( RooRealVar & obs, RooAbsPdf & pdf, const RooDataHist & hist, const RooArgSet & slicePos, Int_t & N, Int_t & N2, Int_t & zeroBin, double shift ) const
protected

Scan the values of 'pdf' in observable 'obs' using the bin values stored in 'hist' at slice position 'slicePos' N is filled with the number of bins defined in hist, N2 is filled with N plus the number of buffer bins The return value is an array of doubles of length N2 with the sampled values.

The caller takes ownership of the array

Definition at line 665 of file RooFFTConvPdf.cxx.

## ◆ setBufferFraction()

 void RooFFTConvPdf::setBufferFraction ( double frac )

Change the size of the buffer on either side of the observable range to frac times the size of the range of the convolution observable.

Definition at line 912 of file RooFFTConvPdf.cxx.

## ◆ setBufferStrategy()

 void RooFFTConvPdf::setBufferStrategy ( BufStrat bs )

Change strategy to fill the overflow buffer on either side of the convolution observable range.

• Extend means is that the input p.d.f convolution observable range is widened to include the buffer range
• Flat means that the buffer is filled with the p.d.f. value at the boundary of the observable range
• Mirror means that the buffer is filled with a mirror image of the p.d.f. around the convolution observable boundary

The default strategy is extend. If one of the input p.d.f.s is a RooAddPdf, it is configured so that the interpretation range of the fraction coefficients is kept at the nominal convolutions observable range (instead of interpreting coefficients in the widened range including the buffer).

Definition at line 936 of file RooFFTConvPdf.cxx.

## ◆ setCacheObservables()

 void RooFFTConvPdf::setCacheObservables ( const RooArgSet & obs )
inline

Definition at line 38 of file RooFFTConvPdf.h.

## ◆ setShift()

 void RooFFTConvPdf::setShift ( double val1, double val2 )
inline

Definition at line 37 of file RooFFTConvPdf.h.

## ◆ Streamer()

 void RooFFTConvPdf::Streamer ( TBuffer & R__b )
overridevirtual

Stream an object of class TObject.

Reimplemented from RooAbsCachedPdf.

## ◆ StreamerNVirtual()

 void RooFFTConvPdf::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )
inline

Definition at line 124 of file RooFFTConvPdf.h.

## ◆ FFTCacheElem

 friend class FFTCacheElem
friend

Definition at line 94 of file RooFFTConvPdf.h.

## ◆ RooConvGenContext

 friend class RooConvGenContext
friend

Definition at line 117 of file RooFFTConvPdf.h.

## ◆ _bufFrac

 double RooFFTConvPdf::_bufFrac
protected

Definition at line 108 of file RooFFTConvPdf.h.

## ◆ _bufStrat

 BufStrat RooFFTConvPdf::_bufStrat
protected

Definition at line 109 of file RooFFTConvPdf.h.

## ◆ _cacheObs

 RooSetProxy RooFFTConvPdf::_cacheObs
protected

Non-convolution observables that are also cached.

Definition at line 118 of file RooFFTConvPdf.h.

## ◆ _params

 RooSetProxy RooFFTConvPdf::_params
protected

Effective parameters of this p.d.f.

Definition at line 71 of file RooFFTConvPdf.h.

## ◆ _pdf1

 RooRealProxy RooFFTConvPdf::_pdf1
protected

First input p.d.f.

Definition at line 69 of file RooFFTConvPdf.h.

## ◆ _pdf2

 RooRealProxy RooFFTConvPdf::_pdf2
protected

Second input p.d.f.

Definition at line 70 of file RooFFTConvPdf.h.

## ◆ _shift1

 double RooFFTConvPdf::_shift1
protected

Definition at line 111 of file RooFFTConvPdf.h.

## ◆ _shift2

 double RooFFTConvPdf::_shift2
protected

Definition at line 112 of file RooFFTConvPdf.h.

## ◆ _x

 RooRealProxy RooFFTConvPdf::_x
protected

Convolution observable.

Definition at line 67 of file RooFFTConvPdf.h.

## ◆ _xprime

 RooRealProxy RooFFTConvPdf::_xprime
protected

Input function representing value of convolution observable.

Definition at line 68 of file RooFFTConvPdf.h.

Libraries for RooFFTConvPdf:

The documentation for this class was generated from the following files: