Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
RooEfficiency Class Reference

A PDF helper class to fit efficiencies parameterized by a supplied function F.

Given a dataset with a category C that determines if a given event is accepted or rejected for the efficiency to be measured, this class evaluates as F if C is 'accept' and as (1-F) if C is 'reject'. Values of F below 0 and above 1 are clipped. F may have an arbitrary number of dependents and parameters

Definition at line 24 of file RooEfficiency.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  CacheMode { Always = 0 , NotAdvised = 1 , Never = 2 }
enum  ConstOpCode { Activate = 0 , DeActivate = 1 , ConfigChange = 2 , ValueChange = 3 }
enum  ContentsOption {
  kName =1 , kClassName =2 , kValue =4 , kArgs =8 ,
  kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128
}
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  ErrorLoggingMode { PrintErrors , CollectErrors , CountErrors , Ignore }
enum  EStatusBits {
  kCanDelete = (1ULL << (0)) , kMustCleanup = (1ULL << (3)) , kIsReferenced = (1ULL << (4)) , kHasUUID = (1ULL << (5)) ,
  kCannotPick = (1ULL << (6)) , kNoContextMenu = (1ULL << (8)) , kInvalidObject = (1ULL << (13))
}
enum  ExtendMode { CanNotBeExtended , CanBeExtended , MustBeExtended }
enum  OperMode { Auto = 0 , AClean = 1 , ADirty = 2 }
using RefCountList_t = RooSTLRefCountList<RooAbsArg>
using RefCountListLegacyIterator_t = TIteratorToSTLInterface<RefCountList_t::Container_t>
enum  ScaleType { Raw , Relative , NumEvent , RelativeExpected }
enum  StyleOption {
  kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 ,
  kTreeStructure =5
}
using value_type = double

Public Member Functions

 RooEfficiency ()
 Default constructor.
 RooEfficiency (const char *name, const char *title, const RooAbsReal &effFunc, const RooAbsCategory &cat, const char *sigCatName)
 Construct an N+1 dimensional efficiency p.d.f from an N-dimensional efficiency function and a category cat with two states (0,1) that indicate if a given event should be counted as rejected or accepted respectively.
 RooEfficiency (const RooEfficiency &other, const char *name=nullptr)
 Copy constructor.
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
bool addOwnedComponents (const RooAbsCollection &comps)
 Take ownership of the contents of 'comps'.
bool addOwnedComponents (RooAbsCollection &&comps)
 Take ownership of the contents of 'comps'.
bool addOwnedComponents (RooArgList &&comps)
 Take ownership of the contents of 'comps'.
template<typename... Args_t>
bool addOwnedComponents (std::unique_ptr< Args_t >... comps)
double analyticalIntegral (Int_t code, const char *rangeName=nullptr) const override
 Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.
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 void AppendPad (Option_t *option="")
 Append graphics object to current pad.
virtual void applyWeightSquared (bool flag)
 Disables or enables the usage of squared weights.
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.
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 RooAbsGenContextautoGenContext (const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false, bool autoBinned=true, const char *binnedTag="") const
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 RooAbsGenContextbinnedGenContext (const RooArgSet &vars, bool verbose=false) const
 Return a binned generator context.
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
bool canBeExtended () const
 If true, PDF can provide extended likelihood term.
virtual bool canComputeBatchWithCuda () const
RooAbsCategory const & cat () const
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 bool checkObservables (const RooArgSet *nset) const
 Overloadable function in which derived classes can implement consistency checks of the variables.
template<typename... CmdArgs_t>
RooFit::OwningPtr< RooFitResultchi2FitTo (RooDataHist &data, CmdArgs_t const &... cmdArgs)
 Calls RooAbsReal::createChi2 and returns the fit result.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
TObjectClone (const char *newname=nullptr) const override
 Make a clone of an object using the Streamer facility.
TObjectclone (const char *newname=nullptr) const override
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::unique_ptr< RooAbsArgcompileForNormSet (RooArgSet const &normSet, RooFit::Detail::CompileContext &ctx) const override
void Copy (TObject &named) const override
 Copy this to obj.
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.
template<typename... CmdArgs_t>
RooFit::OwningPtr< RooAbsRealcreateChi2 (RooDataHist &data, CmdArgs_t const &... cmdArgs)
 Create a \( \chi^2 \) variable from a histogram and this function.
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.
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.
template<typename... CmdArgs_t>
RooFit::OwningPtr< RooAbsRealcreateNLL (RooAbsData &data, CmdArgs_t const &... cmdArgs)
 Construct representation of -log(L) of PDF with given dataset.
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.
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< 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< RooAbsRealcreateScanCdf (const RooArgSet &iset, const RooArgSet &nset, Int_t numScanBins, Int_t intOrder)
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.
std::size_t dataToken () const
 Returns the token for retrieving results in the BatchMode. For internal use only.
virtual double defaultErrorLevel () const
Int_t defaultPrintContents (Option_t *opt) const override
 Define default contents to print.
virtual StyleOption defaultPrintStyle (Option_t *opt) const
virtual void Delete (Option_t *option="")
 Delete this object.
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.
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 Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
virtual void doEval (RooFit::EvalContext &) const
 Base function for computing multiple values of a RooAbsReal.
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.
RooAbsReal const & effFunc () const
virtual void enableOffsetting (bool)
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).
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.
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
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.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
double findRoot (RooRealVar &x, double xmin, double xmax, double yval)
 Return value of x (in range xmin,xmax) at which function equals yval.
template<typename... CmdArgs_t>
RooFit::OwningPtr< RooFitResultfitTo (RooAbsData &data, CmdArgs_t const &... cmdArgs)
 Fit PDF to given dataset.
virtual void fixAddCoefNormalization (const RooArgSet &addNormSet=RooArgSet(), bool force=true)
 Fix the interpretation of the coefficient of any RooAddPdf component in the expression tree headed by 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 bool forceAnalyticalInt (const RooAbsArg &) const
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 RooAbsGenContextgenContext (const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool verbose=false) const
 Interface function to create a generator context from a p.d.f.
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.
std::unique_ptr< RooArgSetgetAllConstraints (const RooArgSet &observables, RooArgSet &constrainedParams, bool stripDisconnected=true) 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.
Int_t getAnalyticalIntegral (RooArgSet &allVars, RooArgSet &analVars, const char *rangeName=nullptr) const override
 Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.
virtual Int_t getAnalyticalIntegralWN (RooArgSet &allVars, RooArgSet &analVars, const RooArgSet *normSet, const char *rangeName=nullptr) const
 Variant of getAnalyticalIntegral that is also passed the normalization set that should be applied to the integrand of which the integral is requested.
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.
virtual std::unique_ptr< RooArgSetgetConstraints (const RooArgSet &, RooArgSet const &, RooArgSet &) const
virtual double getCorrection () const
 This function returns the penalty term.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
bool getForceNumInt () 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.
virtual const char * GetIconName () const
 Returns mime type name of object.
RooNumIntConfiggetIntegratorConfig ()
 Return the numeric integration configuration used for this object.
const RooNumIntConfiggetIntegratorConfig () const
 Return the numeric integration 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.
virtual Int_t getMaxVal (const RooArgSet &vars) const
 Advertise capability to determine maximum value of function for given set of observables.
const char * GetName () const override
 Returns name of object.
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.
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
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.
virtual Option_tGetOption () const
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.
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.
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'.
const char * GetTitle () const override
 Returns title of object.
TString getTitle (bool appendUnit=false) const
 Return this variable's title string.
bool getTransientAttribute (const Text_t *name) const
 Check if a named attribute is set.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
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.
double getVal (RooArgSet &&) const
 Calling RooAbsReal::getVal() with an r-value reference is a common performance trap, because this usually happens when implicitly constructing the RooArgSet to be used as the parameter (for example, in calls like pdf.getVal(x)).
double getValV (const RooArgSet *set=nullptr) const override
 Return current value, normalized by integrating over the observables in nset.
RooFit::OwningPtr< RooArgSetgetVariables (bool stripDisconnected=true) const
 Return RooArgSet with all variables (tree leaf nodes of expression tree).
virtual void gradient (double *) const
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.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
bool hasClients () const
bool hasDataToken () const
virtual bool hasGradient () const
ULong_t Hash () const override
 Return hash value for this object.
virtual bool hasHessian () const
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 bool hasRange (const char *) const
virtual void hessian (double *) const
virtual bool importWorkspaceHook (RooWorkspace &ws)
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 initGenerator (Int_t code)
 Interface for one-time initialization to setup the generator for the specified code.
virtual bool inRange (const char *) const
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
TClassIsA () const override
virtual bool isBinnedDistribution (const RooArgSet &) const
 Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.
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?
Bool_t IsDestructed () const
 IsDestructed.
virtual bool isDirectGenSafe (const RooAbsArg &arg) const
 Check if given observable can be safely generated using the pdfs internal generator mechanism (if that existsP).
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).
bool isIdentical (const RooAbsArg &other, bool assumeSameType=false) const override
virtual bool isOffsetting () const
Bool_t IsOnHeap () const
virtual bool isReducerNode () const
bool isSelectedComp () const
 If true, the current pdf is a selected component (for use in plotting).
bool IsSortable () const override
Bool_t IsZombie () const
bool localNoDirtyInhibit () const
void logEvalError (const char *message, const char *serverValueString=nullptr) const
 Log evaluation error message.
void ls (Option_t *option="") const override
 List TNamed name and title.
virtual double maxVal (Int_t code) const
 Return maximum value for set of observables identified by code assigned in getMaxVal.
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).
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.
bool mustBeExtended () const
 If true PDF must provide extended likelihood term.
const TNamednamePtr () const
 De-duplicated pointer to this object's name.
const char * normRange () const
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
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.
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
virtual double offset () const
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
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 *, size_t)
 Operator delete [] for sized deallocation.
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)
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.
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
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
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
 Helper calling plotOn(RooPlot*, RooLinkedList&) const.
RooPlotplotOn (RooPlot *frame, RooLinkedList &cmdList) const override
 Plot (project) PDF on specified frame.
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 void Pop ()
 Pop on object drawn in a pad to the top of the display list.
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.
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 Print (Option_t *options=nullptr) const override
 Print the object to the defaultPrintStream().
void printAddress (std::ostream &os) const override
 Print address of this RooAbsArg.
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.
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object.
virtual void printMetaArgs (std::ostream &) const
void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
 Print multi line detailed information of this RooAbsPdf.
void printName (std::ostream &os) const override
 Print object name.
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 printTitle (std::ostream &os) const override
 Print object title.
void printTree (std::ostream &os, TString indent="") const override
 Print object tree structure.
void printValue (std::ostream &os) const override
 Print value of p.d.f, also print normalization integral that was last used, if any.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
bool readFromStream (std::istream &is, bool compact, bool verbose=false) override
 Read object contents from stream (dummy for now).
bool recursiveCheckObservables (const RooArgSet *nset) const
 Recursively call checkObservables on all nodes in the expression tree.
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
void removeStringAttribute (const Text_t *key)
 Delete a string attribute with a given key.
void ResetBit (UInt_t f)
void resetDataToken ()
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'.
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 selectComp (bool flag)
virtual bool selfNormalized () const
 Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.
void setAttribute (const Text_t *name, bool value=true)
 Set (default) or clear a named boolean attribute of this object.
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
void setCachedValue (double value, bool notifyClients=true) final
 Overwrite the value stored in this object's cache.
virtual bool setData (RooAbsData &, bool=true)
void setDataToken (std::size_t index)
 Sets the token for retrieving results in the BatchMode. For internal use only.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
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 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 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 setNormRange (const char *rangeName)
void setNormRangeOverride (const char *rangeName)
void setParameterizeIntegral (const RooArgSet &paramVars)
void setPlotLabel (const char *label)
 Set the label associated with this variable.
void setProhibitServerRedirect (bool flag)
void setStringAttribute (const Text_t *key, const Text_t *value)
 Associate string 'value' to this object under key 'key'.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
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'.
void setTransientAttribute (const Text_t *name, bool value=true)
 Set (default) or clear a named boolean attribute of this object.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void setUnit (const char *unit)
void setWorkspace (RooWorkspace &ws)
std::string sigCatName () const
RooAbsMomentsigma (RooRealVar &obs)
RooAbsMomentsigma (RooRealVar &obs, const RooArgSet &nset)
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
RooNumGenConfigspecialGeneratorConfig () const
 Returns the specialized integrator configuration for this RooAbsReal.
RooNumGenConfigspecialGeneratorConfig (bool createOnTheFly)
 Returns the specialized integrator configuration for this RooAbsReal.
RooNumIntConfigspecialIntegratorConfig () const
 Returns the specialized integrator configuration for this RooAbsReal.
RooNumIntConfigspecialIntegratorConfig (bool createOnTheFly)
 Returns the specialized integrator configuration for this RooAbsReal.
void Streamer (TBuffer &) override
 Stream an object of class RooAbsArg.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
const std::map< std::string, std::string > & stringAttributes () const
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
const std::set< std::string > & transientAttributes () 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.
RooWorkspaceworkspace () const
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.
void writeToStream (std::ostream &os, bool compact) const override
 Write object contents to stream (dummy for now).
Client-Server Interface

These functions allow RooFit to figure out who is serving values to whom.

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?
virtual bool isLValue () const
 Is this argument an l-value, i.e., can it appear on the left-hand side of an assignment expression?
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 &newSet, 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.
Optimisation interface

These functions allow RooFit to optimise a computation graph, to keep track of cached values, and to invalidate caches.

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)

Static Public Member Functions

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 RooNumGenConfigdefaultGeneratorConfig ()
 Returns the default numeric MC generator configuration for all RooAbsReals.
static RooNumIntConfigdefaultIntegratorConfig ()
 Returns the default numeric integration configuration for all RooAbsReals.
static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
 Return a reference to the current default stream to use in Print().
static std::map< constRooAbsArg *, std::pair< std::string, std::list< RooAbsReal::EvalError > > >::iterator evalErrorIter ()
static ErrorLoggingMode evalErrorLoggingMode ()
 Return current evaluation error logging mode.
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
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 void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
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 setDirtyInhibit (bool flag)
 Control global dirty inhibit mode.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void setEvalErrorLoggingMode (ErrorLoggingMode m)
 Set evaluation error logging mode.
static void setHideOffset (bool flag)
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
static void verboseDirty (bool flag)
 Activate verbose messaging related to dirty flag propagation.
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.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions

void attachToStore (RooAbsDataStore &store)
 Attach this argument to the data store such that it reads data from there.
void attachToTree (TTree &t, Int_t bufSize=32000) override
 Attach object to a branch of given TTree.
void attachToVStore (RooVectorDataStore &vstore) override
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
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.
virtual std::unique_ptr< RooAbsRealcreateNLLImpl (RooAbsData &data, const RooLinkedList &cmdList)
 Protected implementation of the NLL creation routine.
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
double evaluate () const override
 Calculate the raw value of this p.d.f which is the effFunc value if cat==1 and it is (1-effFunc) if cat==0.
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.
virtual std::unique_ptr< RooFitResultfitToImpl (RooAbsData &data, const RooLinkedList &cmdList)
 Protected implementation of the likelihood fitting routine.
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
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.
virtual void ioStreamerPass2 ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.
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).
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'.
void MakeZombie ()
template<typename... Proxies>
bool matchArgs (const RooArgSet &allDeps, RooArgSet &analDeps, const RooArgProxy &a, const Proxies &... proxies) const
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 void operModeHook ()
virtual void optimizeDirtyHook (const RooArgSet *)
virtual RooPlotplotAsymOn (RooPlot *frame, const RooAbsCategoryLValue &asymCat, PlotOpt o) const
RooPlotplotOn (RooPlot *frame, PlotOpt o) const override
 Plot oneself on 'frame'.
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.
void printAttribList (std::ostream &os) const
 Print the attribute list.
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
 Hook function intercepting redirectServer calls.
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 SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
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 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 setTreeBranchStatus (TTree &t, bool active) override
 (De)Activate associated tree branch
void setValueDirty (const RooAbsArg *source)
 Force element to re-evaluate itself when a value is requested.
void syncCache (const RooArgSet *set=nullptr) override
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.
double traceEval (const RooArgSet *set) const
 Calculate current value of object, with error tracing wrapper.
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.

Static Protected Member Functions

static void globalSelectComp (bool flag)
 Global switch controlling the activation of the selectComp() functionality.
static void ioStreamerPass2Finalize ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass.
static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

std::set< std::string > _boolAttrib
std::set< std::string > _boolAttribTransient
 ! Transient boolean attributes (not copied in ctor)
std::vector< RooAbsCache * > _cacheList
 ! list of caches
RooCategoryProxy _cat
 Accept/reject categort.
RefCountList_t _clientList
RefCountList_t _clientListShape
RefCountList_t _clientListValue
std::size_t _dataToken = std::numeric_limits<std::size_t>::max()
 !
bool _deleteWatch = false
 ! Delete watch flag
RooRealProxy _effFunc
 Efficiency modeling function.
RooExpensiveObjectCache_eocache {nullptr}
 ! Pointer to global cache manager for expensive components.
Int_t _errorCount = 0
 Number of errors remaining to print.
bool _fast = false
bool _forceNumInt = false
 Force numerical integration if flag set.
bool _isConstant = false
 ! Cached isConstant status
TString _label
 Plot label for objects value.
RooFit::UniqueId< RooArgSet >::Value_t _lastNormSetId = RooFit::UniqueId<RooArgSet>::nullval
 !
bool _localNoInhibitDirty = false
 ! Prevent 'AlwaysDirty' mode for this node
RooWorkspace_myws = nullptr
 ! In which workspace do I live, if any
const TNamed_namePtr = nullptr
 ! De-duplicated name pointer, equal for all objects with the same name.
Int_t _negCount = 0
 Number of negative probabilities remaining to print.
RooAbsReal_norm = nullptr
 ! Normalization integral (owned by _normMgr)
RooObjCacheManager _normMgr
 ! The cache manager
TString _normRange
 Normalization range.
RooArgSet const * _normSet = nullptr
 ! Normalization set with for above integral
OperMode _operMode = Auto
RooArgSet_ownedComponents = nullptr
 ! Set of owned component
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 _prohibitServerRedirect = false
 ! Prohibit server redirects – Debugging tool
RooRefArray _proxyList
ProxyListCache _proxyListCache
 ! cache of the list of proxies. Avoids type casting.
double _rawValue = 0
bool _selectComp = false
 Component selection flag for RooAbsPdf::plotCompOn.
RefCountList_t _serverList
bool _shapeDirty = true
TString _sigCatName
 Name of accept state of accept/reject category.
std::unique_ptr< RooNumGenConfig_specGeneratorConfig
 ! MC generator configuration specific for this object
std::unique_ptr< RooNumIntConfig_specIntegratorConfig
std::map< std::string, std::string > _stringAttrib
Int_t _traceCount = 0
 Number of traces remaining to print.
TreeReadBuffer * _treeReadBuffer = nullptr
 ! A buffer for reading values from trees
TString _unit
 Unit for objects value.
double _value = 0.0
 Cache for current value of object.
bool _valueDirty = true
TString fName
TString fTitle

Static Protected Attributes

static bool _globalSelectComp = false
static bool _hideOffset = true
 Offset hiding flag.
static bool _inhibitDirty
static Int_t _nameLength
static TString _normRangeOverride
static bool _verboseDirty
static Int_t _verboseEval = 0

Private Member Functions

double _DEBUG_getVal (const RooArgSet *normalisationSet) const
 Debug version of getVal(), which is slow and does error checking.
void addParameters (RooAbsCollection &params, const RooArgSet *nset=nullptr, bool stripDisconnected=true) const
 Add all parameters of the function and its daughters to params.
bool callRedirectServersHook (RooAbsCollection const &newSet, bool mustReplaceAll, bool nameChange, bool isRecursionStep)
 Private helper function for RooAbsArg::redirectServers().
std::unique_ptr< RooFitResultchi2FitToImpl (RooDataHist &data, const RooLinkedList &cmdList)
std::unique_ptr< RooAbsRealcreateChi2Impl (RooDataHist &data, const RooLinkedList &cmdList)
std::unique_ptr< RooDataSetgenerate (RooAbsGenContext &context, const RooArgSet &whatVars, const RooDataSet *prototype, double nEvents, bool verbose, bool randProtoOrder, bool resampleProto, bool skipInit=false, bool extended=false) const
 Internal method.
void logBatchComputationErrors (std::span< const double > &outputs, std::size_t begin) const
 Scan through outputs and fix+log all nans and negative values.
RefCountListLegacyIterator_tmakeLegacyIterator (const RefCountList_t &list) const
virtual RooPlotparamOn (RooPlot *frame, const RooArgSet &params, bool showConstants=false, const char *label="", double xmin=0.65, double xmax=0.99, double ymax=0.95, const RooCmdArg *formatCmd=nullptr)
 Add a text box with the current parameter values and their errors to the frame.
void setActiveNormSet (RooArgSet const *normSet) const
 Setter for the _normSet member, which should never be set directly.
void substituteServer (RooAbsArg *oldServer, RooAbsArg *newServer)
 Private helper function for RooAbsArg::redirectServers().
bool traceEvalPdf (double value) const
 Check that passed value is positive and not 'not-a-number'.

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes

RooFit::UniqueId< RooArgSet >::Value_t _normSetId = RooFit::UniqueId<RooArgSet>::nullval
 ! Unique ID of the currently-active normalization set
UInt_t fBits
 bit field status word
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable

#include <RooEfficiency.h>

Inheritance diagram for RooEfficiency:
RooAbsPdf RooAbsReal RooAbsArg TNamed RooPrintable TObject

Member Typedef Documentation

◆ RefCountList_t

using RooAbsArg::RefCountList_t = RooSTLRefCountList<RooAbsArg>
inherited

Definition at line 78 of file RooAbsArg.h.

◆ RefCountListLegacyIterator_t

using RooAbsArg::RefCountListLegacyIterator_t = TIteratorToSTLInterface<RefCountList_t::Container_t>
inherited

Definition at line 79 of file RooAbsArg.h.

◆ value_type

using RooAbsReal::value_type = double
inherited

Definition at line 65 of file RooAbsReal.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ CacheMode

enum RooAbsArg::CacheMode
inherited
Enumerator
Always 
NotAdvised 
Never 

Definition at line 317 of file RooAbsArg.h.

◆ ConstOpCode

enum RooAbsArg::ConstOpCode
inherited
Enumerator
Activate 
DeActivate 
ConfigChange 
ValueChange 

Definition at line 311 of file RooAbsArg.h.

◆ ContentsOption

Enumerator
kName 
kClassName 
kValue 
kArgs 
kExtras 
kAddress 
kTitle 
kCollectionHeader 

Definition at line 33 of file RooPrintable.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ ErrorLoggingMode

Enumerator
PrintErrors 
CollectErrors 
CountErrors 
Ignore 

Definition at line 314 of file RooAbsReal.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

◆ ExtendMode

enum RooAbsPdf::ExtendMode
inherited
Enumerator
CanNotBeExtended 
CanBeExtended 
MustBeExtended 

Definition at line 208 of file RooAbsPdf.h.

◆ OperMode

enum RooAbsArg::OperMode
inherited
Enumerator
Auto 
AClean 
ADirty 

Definition at line 322 of file RooAbsArg.h.

◆ ScaleType

enum RooAbsReal::ScaleType
inherited
Enumerator
Raw 
Relative 
NumEvent 
RelativeExpected 

Definition at line 273 of file RooAbsReal.h.

◆ StyleOption

enum RooPrintable::StyleOption
inherited
Enumerator
kInline 
kSingleLine 
kStandard 
kVerbose 
kTreeStructure 

Definition at line 34 of file RooPrintable.h.

Constructor & Destructor Documentation

◆ RooEfficiency() [1/3]

RooEfficiency::RooEfficiency ( )
inline

Default constructor.

Definition at line 28 of file RooEfficiency.h.

◆ RooEfficiency() [2/3]

RooEfficiency::RooEfficiency ( const char * name,
const char * title,
const RooAbsReal & effFunc,
const RooAbsCategory & cat,
const char * sigCatName )

Construct an N+1 dimensional efficiency p.d.f from an N-dimensional efficiency function and a category cat with two states (0,1) that indicate if a given event should be counted as rejected or accepted respectively.

Definition at line 48 of file RooEfficiency.cxx.

◆ RooEfficiency() [3/3]

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

Copy constructor.

Definition at line 61 of file RooEfficiency.cxx.

Member Function Documentation

◆ _DEBUG_getVal()

double RooAbsReal::_DEBUG_getVal ( const RooArgSet * normalisationSet) const
privateinherited

Debug version of getVal(), which is slow and does error checking.

Definition at line 4187 of file RooAbsReal.cxx.

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ addOwnedComponents() [1/4]

bool RooAbsArg::addOwnedComponents ( const RooAbsCollection & comps)
inherited

Take ownership of the contents of 'comps'.

Definition at line 2010 of file RooAbsArg.cxx.

◆ addOwnedComponents() [2/4]

bool RooAbsArg::addOwnedComponents ( RooAbsCollection && comps)
inherited

Take ownership of the contents of 'comps'.

Different from the overload that takes the RooArgSet by const&, this version can also take an owning RooArgSet without error, because the ownership will not be ambiguous afterwards.

Definition at line 2022 of file RooAbsArg.cxx.

◆ addOwnedComponents() [3/4]

bool RooAbsArg::addOwnedComponents ( RooArgList && comps)
inherited

Take ownership of the contents of 'comps'.

Different from the overload that takes the RooArgSet by const&, this version can also take an owning RooArgSet without error, because the ownership will not be ambiguous afterwards.

Definition at line 2032 of file RooAbsArg.cxx.

◆ addOwnedComponents() [4/4]

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

Definition at line 482 of file RooAbsArg.h.

◆ addParameters()

void RooAbsArg::addParameters ( RooAbsCollection & params,
const RooArgSet * nset = nullptr,
bool stripDisconnected = true ) const
privateinherited

Add all parameters of the function and its daughters to params.

Parameters
[in]paramsCollection that stores all parameters. Add all new parameters to this.
[in]nsetNormalisation set (optional). If a value depends on this set, it's not a parameter.
[in]stripDisconnectedPassed on to getParametersHook().

Definition at line 544 of file RooAbsArg.cxx.

◆ addServer()

void RooAbsArg::addServer ( RooAbsArg & server,
bool valueProp = true,
bool shapeProp = false,
std::size_t refCount = 1 )
inherited

Register another RooAbsArg as a server to us, ie, declare that we depend on it.

Parameters
serverThe server to be registered.
valuePropIn addition to the basic client-server relationship, declare dependence on the server's value.
shapePropIn addition to the basic client-server relationship, declare dependence on the server's shape.
refCountOptionally add with higher reference count (if multiple components depend on it)

Definition at line 307 of file RooAbsArg.cxx.

◆ addServerList()

void RooAbsArg::addServerList ( RooAbsCollection & serverList,
bool valueProp = true,
bool shapeProp = false )
inherited

Register a list of RooAbsArg as servers to us by calling addServer() for each arg in the list.

Definition at line 344 of file RooAbsArg.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ aggregateCacheUniqueSuffix()

const char * RooAbsArg::aggregateCacheUniqueSuffix ( ) const
inherited

Definition at line 2072 of file RooAbsArg.cxx.

◆ analyticalIntegral()

double RooEfficiency::analyticalIntegral ( Int_t code,
const char * rangeName = nullptr ) const
overridevirtual

Implements the actual analytical integral(s) advertised by getAnalyticalIntegral.

This functions will only be called with codes returned by getAnalyticalIntegral, except code zero.

Reimplemented from RooAbsReal.

Definition at line 84 of file RooEfficiency.cxx.

◆ analyticalIntegralWN()

double RooAbsPdf::analyticalIntegralWN ( Int_t code,
const RooArgSet * normSet,
const char * rangeName = nullptr ) const
overridevirtualinherited

Analytical integral with normalization (see RooAbsReal::analyticalIntegralWN() for further information).

This function applies the normalization specified by normSet to the integral returned by RooAbsReal::analyticalIntegral(). The passthrough scenario (code=0) is also changed to return a normalized answer.

Reimplemented from RooAbsReal.

Reimplemented in RooAddModel, RooAddPdf, RooBinSamplingPdf, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooProdPdf, RooProjectedPdf, RooRealSumPdf, RooSimultaneous, and RooWrapperPdf.

Definition at line 345 of file RooAbsPdf.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ applyWeightSquared()

void RooAbsArg::applyWeightSquared ( bool flag)
virtualinherited

Disables or enables the usage of squared weights.

Needs to be overloaded in the likelihood classes for which this is relevant.

Reimplemented in ROOT::Experimental::XRooFit::ProgressMonitor.

Definition at line 2244 of file RooAbsArg.cxx.

◆ asTF()

TF1 * RooAbsReal::asTF ( const RooArgList & obs,
const RooArgList & pars = RooArgList(),
const RooArgSet & nset = RooArgSet() ) const
inherited

Return a ROOT TF1,2,3 object bound to this RooAbsReal with given definition of observables and parameters.

Definition at line 3801 of file RooAbsReal.cxx.

◆ attachArgs()

void RooAbsArg::attachArgs ( const RooAbsCollection & set)
inherited

Bind this node to objects in set.

Search the set for objects that have the same name as our servers, and attach ourselves to those. After this operation, this node is computing its values based on the new servers. This can be used to e.g. read values from

Definition at line 1490 of file RooAbsArg.cxx.

◆ attachDataSet()

void RooAbsArg::attachDataSet ( const RooAbsData & set)
inherited

Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset.

Definition at line 1503 of file RooAbsArg.cxx.

◆ attachDataStore()

void RooAbsArg::attachDataStore ( const RooAbsDataStore & set)
inherited

Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset.

Definition at line 1511 of file RooAbsArg.cxx.

◆ attachToStore()

void RooAbsArg::attachToStore ( RooAbsDataStore & store)
protectedinherited

Attach this argument to the data store such that it reads data from there.

Definition at line 2054 of file RooAbsArg.cxx.

◆ attachToTree()

void RooAbsReal::attachToTree ( TTree & t,
Int_t bufSize = 32000 )
overrideprotectedvirtualinherited

Attach object to a branch of given TTree.

By default it will register the internal value cache RooAbsReal::_value as branch buffer for a double tree branch with the same name as this object. If no double branch is found with the name of this object, this method looks for a Float_t Int_t, UChar_t and UInt_t, etc branch. If any of these are found, a TreeReadBuffer that branch is created, and saved in _treeReadBuffer. TreeReadBuffer::operator double() can be used to convert the values. This is used by copyCache().

Implements RooAbsArg.

Reimplemented in RooRealVar.

Definition at line 3014 of file RooAbsReal.cxx.

◆ attachToVStore()

void RooAbsReal::attachToVStore ( RooVectorDataStore & vstore)
overrideprotectedvirtualinherited

Implements RooAbsArg.

Reimplemented in RooRealVar.

Definition at line 2998 of file RooAbsReal.cxx.

◆ attributes()

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

Definition at line 258 of file RooAbsArg.h.

◆ autoGenContext()

RooAbsGenContext * RooAbsPdf::autoGenContext ( const RooArgSet & vars,
const RooDataSet * prototype = nullptr,
const RooArgSet * auxProto = nullptr,
bool verbose = false,
bool autoBinned = true,
const char * binnedTag = "" ) const
virtualinherited

Reimplemented in RooSimultaneous.

Definition at line 1127 of file RooAbsPdf.cxx.

◆ binBoundaries()

std::list< double > * RooAbsReal::binBoundaries ( RooAbsRealLValue & obs,
double xlo,
double xhi ) const
virtualinherited

Retrieve bin boundaries if this distribution is binned in obs.

Parameters
[in]obsObservable to retrieve boundaries for.
[in]xloBeginning of range.
[in]xhiEnd of range.
Returns
The caller owns the returned std::list.

Reimplemented in ParamHistFunc, PdfWrapper, PiecewiseInterpolation, RooAddition, RooAddPdf, RooBinSamplingPdf, RooBinWidthFunction, RooFormulaVar, RooHistFunc, RooHistPdf, RooLagrangianMorphFunc, RooLinearCombination, RooMomentMorphFunc, RooParamHistFunc, RooProdPdf, RooProduct, RooRealSumFunc, RooRealSumPdf, and RooWrapperPdf.

Definition at line 3454 of file RooAbsReal.cxx.

◆ bindVars()

RooFit::OwningPtr< RooAbsFunc > RooAbsReal::bindVars ( const RooArgSet & vars,
const RooArgSet * nset = nullptr,
bool clipInvalid = false ) const
inherited

Create an interface adaptor f(vars) that binds us to the specified variables (in arbitrary order).

For example, calling bindVars({x1,x3}) on an object F(x1,x2,x3,x4) returns an object f(x1,x3) that is evaluated using the current values of x2 and x4. The caller takes ownership of the returned adaptor.

Definition at line 2966 of file RooAbsReal.cxx.

◆ binnedGenContext()

RooAbsGenContext * RooAbsPdf::binnedGenContext ( const RooArgSet & vars,
bool verbose = false ) const
virtualinherited

Return a binned generator context.

Definition at line 1108 of file RooAbsPdf.cxx.

◆ branchNodeServerList()

void RooAbsArg::branchNodeServerList ( RooAbsCollection * list,
const RooAbsArg * arg = nullptr,
bool recurseNonDerived = false ) const
inherited

Fill supplied list with all branch nodes of the arg tree starting with ourself as top node.

A branch node is node that has one or more servers declared.

Definition at line 451 of file RooAbsArg.cxx.

◆ Browse()

◆ cacheUniqueSuffix()

virtual const char * RooAbsArg::cacheUniqueSuffix ( ) const
inlinevirtualinherited

Definition at line 434 of file RooAbsArg.h.

◆ callRedirectServersHook()

bool RooAbsArg::callRedirectServersHook ( RooAbsCollection const & newSet,
bool mustReplaceAll,
bool nameChange,
bool isRecursionStep )
privateinherited

Private helper function for RooAbsArg::redirectServers().

Definition at line 988 of file RooAbsArg.cxx.

◆ canBeExtended()

bool RooAbsPdf::canBeExtended ( ) const
inlineinherited

If true, PDF can provide extended likelihood term.

Definition at line 214 of file RooAbsPdf.h.

◆ canComputeBatchWithCuda()

◆ canNodeBeCached()

virtual CacheMode RooAbsArg::canNodeBeCached ( ) const
inlinevirtualinherited

Reimplemented in RooAddPdf, RooLagrangianMorphFunc, RooProdPdf, RooProduct, RooRealSumFunc, and RooRealSumPdf.

Definition at line 346 of file RooAbsArg.h.

◆ cat()

RooAbsCategory const & RooEfficiency::cat ( ) const
inline

Definition at line 37 of file RooEfficiency.h.

◆ changeServer()

void RooAbsArg::changeServer ( RooAbsArg & server,
bool valueProp,
bool shapeProp )
inherited

Change dirty flag propagation mask for specified server.

Definition at line 412 of file RooAbsArg.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

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

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ checkObservables()

bool RooAbsArg::checkObservables ( const RooArgSet * nset) const
virtualinherited

Overloadable function in which derived classes can implement consistency checks of the variables.

If this function returns true, indicating an error, the fitter or generator will abort.

Reimplemented in RooAddModel, RooAddPdf, RooLagrangianMorphFunc, RooRealSumFunc, and RooRealSumPdf.

Definition at line 687 of file RooAbsArg.cxx.

◆ chi2FitTo()

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooFitResult > RooAbsReal::chi2FitTo ( RooDataHist & data,
CmdArgs_t const &... cmdArgs )
inlineinherited

Calls RooAbsReal::createChi2 and returns the fit result.

PyROOT

The RooAbsReal::chi2FitTo() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Perform a \( \chi^2 \) fit to given histogram. By default the fit is executed through the MINUIT commands MIGRAD, HESSE in succession

The following named arguments are supported:

Type of CmdArg Effect on \( \chi^2 \)
DataError() Choose between:
  • RooAbsData::Expected: Expected Poisson error ( \( \sqrt{n_\text{expected}} \) from the PDF).
  • RooAbsData::SumW2: The observed error from the square root of the sum of weights squared, i.e., symmetric errors calculated with the standard deviation of a Poisson distribution.
  • RooAbsData::Poisson: Asymmetric errors from the central 68 % interval around a Poisson distribution with mean \( n_\text{observed} \). If for a given bin \( n_\text{expected} \) is lower than the \( n_\text{observed} \), the lower uncertainty is taken (e.g., the difference between the mean and the 16 % quantile). If \( n_\text{expected} \) is higher than \( n_\text{observed} \), the higher uncertainty is taken (e.g., the difference between the 84 % quantile and the mean).
  • RooAbsData::Auto (default): RooAbsData::Expected for unweighted data, RooAbsData::SumW2 for weighted data.
Extended(bool flag) Only applicable when fitting a RooAbsPdf. Scale the normalized pdf by the number of events predicted by the model instead of scaling by the total data weight. This imposes a constraint on the predicted number of events analogous to the extended term in a likelihood fit.
  • If you don't pass this command, an extended fit will be done by default if the pdf makes a prediction on the number of events (in RooFit jargon, "if the pdf can be extended").
  • Passing Extended(true) when the the pdf makes no prediction on the expected number of events will result in error messages, and the chi2 will fall back to the total data weight to scale the normalized pdf.
  • There are cases where the fit must be done in extended mode. This happens for example when you have a RooAddPdf where the coefficients represent component yields. If the fit is not extended, these coefficients will not be well-defined, as the RooAddPdf always normalizes itself. If you pass Extended(false) in such a case, an error will be printed and you'll most likely get garbage results.
Range(const char* name) Fit only data inside range with given name
Range(double lo, double hi) Fit only data inside given range. A range named "fit" is created on the fly on all observables. Multiple comma separated range names can be specified.
NumCPU(int num) Parallelize NLL calculation on num CPUs
IntegrateBins() Integrate PDF within each bin. This sets the desired precision.
Verbose() Verbose output of GOF framework
SumCoefRange() Set the range in which to interpret the coefficients of RooAddPdf components
SplitRange() Fit ranges used in different categories get named after the category. Using Range("range"), SplitRange() as switches, different ranges could be set like this:
myVariable.setRange("range_pi0", 135, 210);
myVariable.setRange("range_gamma", 50, 210);
ConditionalObservables(Args_t &&... argsOrArgSet)

Define projected observables. Arguments can either be multiple RooRealVar or a single RooArgSet containing them.

Options to control flow of fit procedure
InitialHesse(bool flag) Flag controls if HESSE before MIGRAD as well, off by default
Hesse(bool flag) Flag controls if HESSE is run after MIGRAD, on by default
Minos(bool flag) Flag controls if MINOS is run after HESSE, on by default
Minos(const RooArgSet& set) Only run MINOS on given subset of arguments
Save(bool flag) Flag controls if RooFitResult object is produced and returned, off by default
Strategy(Int_t flag)

Set Minuit strategy (0 through 2, default is 1)

Options to control informational output
Verbose(bool flag) Flag controls if verbose output is printed (NLL, parameter changes during fit
Timer(bool flag) Time CPU and wall clock consumption of fit steps, off by default
PrintLevel(Int_t level) Set Minuit print level (-1 through 3, default is 1). At -1 all RooFit informational messages are suppressed as well
Warnings(bool flag) Enable or disable MINUIT warnings (enabled by default)
PrintEvalErrors(Int_t numErr) Control number of p.d.f evaluation errors printed per likelihood evaluation. A negative value suppress output completely, a zero value will only print the error count per p.d.f component, a positive value is will print details of each error up to numErr messages per p.d.f component.

Definition at line 184 of file RooAbsReal.h.

◆ chi2FitToImpl()

std::unique_ptr< RooFitResult > RooAbsReal::chi2FitToImpl ( RooDataHist & data,
const RooLinkedList & cmdList )
privateinherited

Definition at line 4014 of file RooAbsReal.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 50 of file RooEfficiency.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ cleanBranchName()

TString RooAbsArg::cleanBranchName ( ) const
protectedinherited

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

Definition at line 1845 of file RooAbsArg.cxx.

◆ Clear()

void TNamed::Clear ( Option_t * option = "")
overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

◆ clearEvalErrorLog()

void RooAbsReal::clearEvalErrorLog ( )
staticinherited

Clear the stack of evaluation error messages.

Definition at line 3436 of file RooAbsReal.cxx.

◆ clearShapeDirty()

void RooAbsArg::clearShapeDirty ( ) const
inlineprotectedinherited

Definition at line 542 of file RooAbsArg.h.

◆ clearValueAndShapeDirty()

void RooAbsArg::clearValueAndShapeDirty ( ) const
inlineprotectedinherited

Definition at line 535 of file RooAbsArg.h.

◆ clearValueDirty()

void RooAbsArg::clearValueDirty ( ) const
inlineprotectedinherited

Definition at line 541 of file RooAbsArg.h.

◆ clients()

const RefCountList_t & RooAbsArg::clients ( ) const
inlineinherited

List of all clients of this object.

Definition at line 137 of file RooAbsArg.h.

◆ Clone()

TObject * RooAbsArg::Clone ( const char * newname = nullptr) const
inlineoverridevirtualinherited

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented from TObject.

Definition at line 88 of file RooAbsArg.h.

◆ clone()

TObject * RooEfficiency::clone ( const char * newname = nullptr) const
inlineoverridevirtual

Implements RooAbsArg.

Definition at line 32 of file RooEfficiency.h.

◆ cloneTree()

RooAbsArg * RooAbsArg::cloneTree ( const char * newname = nullptr) const
virtualinherited

Clone tree expression of objects.

All tree nodes will be owned by the head node return by cloneTree()

Definition at line 2040 of file RooAbsArg.cxx.

◆ Compare()

Int_t RooAbsArg::Compare ( const TObject * other) const
overridevirtualinherited

Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name.

Reimplemented from TObject.

Definition at line 1519 of file RooAbsArg.cxx.

◆ compileForNormSet()

std::unique_ptr< RooAbsArg > RooAbsPdf::compileForNormSet ( RooArgSet const & normSet,
RooFit::Detail::CompileContext & ctx ) const
overridevirtualinherited

Reimplemented from RooAbsArg.

Reimplemented in RooAddPdf, RooProdPdf, RooProjectedPdf, RooRealSumPdf, and RooSimultaneous.

Definition at line 2777 of file RooAbsPdf.cxx.

◆ constOptimizeTestStatistic()

void RooAbsArg::constOptimizeTestStatistic ( ConstOpCode opcode,
bool doAlsoTrackingOpt = true )
virtualinherited

Interface function signaling a request to perform constant term optimization.

This default implementation takes no action other than to forward the calls to all servers

Reimplemented in ROOT::Experimental::XRooFit::ProgressMonitor.

Definition at line 1719 of file RooAbsArg.cxx.

◆ Copy()

void TNamed::Copy ( TObject & named) const
overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

◆ copyCache()

void RooAbsReal::copyCache ( const RooAbsArg * source,
bool valueOnly = false,
bool setValDirty = true )
overrideprotectedvirtualinherited

Copy the cached value of another RooAbsArg to our cache.

Warning: This function just copies the cached values of source, it is the callers responsibility to make sure the cache is clean.

Implements RooAbsArg.

Reimplemented in RooAbsRealLValue, and RooRealVar.

Definition at line 2983 of file RooAbsReal.cxx.

◆ createCdf() [1/2]

RooFit::OwningPtr< RooAbsReal > RooAbsPdf::createCdf ( const RooArgSet & iset,
const RooArgSet & nset = RooArgSet() )
inherited

Create a cumulative distribution function of this p.d.f in terms of the observables listed in iset.

If no nset argument is given the c.d.f normalization is constructed over the integrated observables, so that its maximum value is precisely 1. It is also possible to choose a different normalization for multi-dimensional p.d.f.s: eg. for a pdf f(x,y,z) one can construct a partial cdf c(x,y) that only when integrated itself over z results in a maximum value of 1. To construct such a cdf pass z as argument to the optional nset argument

Definition at line 2468 of file RooAbsPdf.cxx.

◆ createCdf() [2/2]

RooFit::OwningPtr< RooAbsReal > RooAbsPdf::createCdf ( 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 = {} )
inherited

Create an object that represents the integral of the function over one or more observables listed in iset.

PyROOT

The RooAbsPdf::createCdf() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

The actual integration calculation is only performed when the return object is evaluated. The name of the integral object is automatically constructed from the name of the input function, the variables it integrates and the range integrates over

The following named arguments are accepted

Type of CmdArg Effect on CDF
SupNormSet(const RooArgSet&) Observables over which should be normalized in addition to the integration observables
ScanNumCdf() Apply scanning technique if cdf integral involves numeric integration [ default ]
ScanAllCdf() Always apply scanning technique
ScanNoCdf() Never apply scanning technique
ScanParameters(Int_t nbins, Int_t intOrder) Parameters for scanning technique of making CDF: number of sampled bins and order of interpolation applied on numeric cdf

Definition at line 2490 of file RooAbsPdf.cxx.

◆ createChi2()

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooAbsReal > RooAbsReal::createChi2 ( RooDataHist & data,
CmdArgs_t const &... cmdArgs )
inlineinherited

Create a \( \chi^2 \) variable from a histogram and this function.

PyROOT

The RooAbsReal::createChi2() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

See also RooAbsReal::chi2FitTo for the list of possible command arguments to this function.

It calculates:

\begin{align*} \chi^2 &= \sum_{\mathrm{bins}} \left( \frac{N_\mathrm{PDF,bin} - N_\mathrm{Data,bin}}{\Delta_\mathrm{bin}} \right)^2 N_\mathrm{PDF,bin} &= \begin{cases} \mathrm{pdf}(\text{bin centre}) \cdot V_\mathrm{bin} \cdot N_\mathrm{Data,tot} &\text{normal PDF} \mathrm{pdf}(\text{bin centre}) \cdot V_\mathrm{bin} \cdot N_\mathrm{Data,expected} &\text{extended PDF} \end{cases} \Delta_\mathrm{bin} &= \begin{cases} \sqrt{N_\mathrm{PDF,bin}} &\text{if } \mathtt{DataError == RooAbsData::Expected} \mathtt{data{\rightarrow}weightError()} &\text{otherwise} \end{cases} \end{align*}

If the dataset doesn't have user-defined errors, errors are assumed to be \( \sqrt{N} \). In extended PDF mode, N_tot (total number of data events) is substituted with N_expected, the expected number of events that the PDF predicts.

Note
If the dataset has errors stored, empty bins will prevent the calculation of \( \chi^2 \), because those have zero error. This leads to messages like:
[#0] ERROR:Eval -- RooChi2Var::RooChi2Var(chi2_GenPdf_data_hist) INFINITY ERROR: bin 2 has zero error
In this case, one can use the expected errors of the PDF instead of the data errors:
friend class RooChi2Var
Definition RooAbsPdf.h:343
RooCmdArg DataError(Int_t)
Parameters
dataHistogram with data
arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8ordered arguments
Returns
\( \chi^2 \) variable

Definition at line 190 of file RooAbsReal.h.

◆ createChi2Impl()

std::unique_ptr< RooAbsReal > RooAbsReal::createChi2Impl ( RooDataHist & data,
const RooLinkedList & cmdList )
privateinherited

Definition at line 4062 of file RooAbsReal.cxx.

◆ createExpectedEventsFunc()

std::unique_ptr< RooAbsReal > RooAbsPdf::createExpectedEventsFunc ( const RooArgSet * nset) const
virtualinherited

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.

This is used to build the computation graph for the final likelihood.

Reimplemented in RooAddPdf, RooBinSamplingPdf, RooExtendedTerm, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooProdPdf, and RooRealSumPdf.

Definition at line 2798 of file RooAbsPdf.cxx.

◆ createFundamental()

RooFit::OwningPtr< RooAbsArg > RooAbsReal::createFundamental ( const char * newname = nullptr) const
overridevirtualinherited

Create a RooRealVar fundamental object with our properties.

The new object will be created without any fit limits.

Implements RooAbsArg.

Definition at line 3116 of file RooAbsReal.cxx.

◆ createHistogram() [1/3]

TH1 * RooAbsReal::createHistogram ( 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
inherited

Create and fill a ROOT histogram TH1, TH2 or TH3 with the values of this function.

PyROOT

The RooAbsReal::createHistogram() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Parameters
[in]nameName of the ROOT histogram
[in]xvarObservable to be std::mapped on x axis of ROOT histogram
[in]arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8Arguments according to list below
Returns
TH1 *, one of TH{1,2,3}. The caller takes ownership.
Effect on histogram creation
IntrinsicBinning() Apply binning defined by function or pdf (as advertised via binBoundaries() method)
Binning(const char* name) Apply binning with given name to x axis of histogram
Binning(RooAbsBinning& binning) Apply specified binning to x axis of histogram
Binning(int nbins, [double lo, double hi]) Apply specified binning to x axis of histogram
ConditionalObservables(Args_t &&... argsOrArgSet) Do not normalise PDF over following observables when projecting PDF into histogram.
Scaling(bool) Apply density-correction scaling (multiply by bin volume), default is true
Extended(bool)

Plot event yield instead of probability density (for extended pdfs only)

YVar(const RooAbsRealLValue& var,...) Observable to be std::mapped on y axis of ROOT histogram. The YVar() and ZVar() arguments can be supplied with optional Binning() arguments to control the binning of the Y and Z axes, e.g.
createHistogram("histo",x,Binning(-1,1,20), YVar(y,Binning(-1,1,30)), ZVar(z,Binning("zbinning")))
TH1 * createHistogram(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 w...
Double_t y[n]
Definition legend1.C:17
Double_t x[n]
Definition legend1.C:17
ZVar(const RooAbsRealLValue& var,...) Observable to be std::mapped on z axis of ROOT histogram

Definition at line 1268 of file RooAbsReal.cxx.

◆ createHistogram() [2/3]

TH1 * RooAbsReal::createHistogram ( const char * name,
const RooAbsRealLValue & xvar,
RooLinkedList & argList ) const
inherited

Internal method implementing createHistogram.

Definition at line 1280 of file RooAbsReal.cxx.

◆ createHistogram() [3/3]

TH1 * RooAbsReal::createHistogram ( RooStringView varNameList,
Int_t xbins = 0,
Int_t ybins = 0,
Int_t zbins = 0 ) const
inherited

Create and fill a ROOT histogram TH1, TH2 or TH3 with the values of this function for the variables with given names.

Parameters
[in]varNameListList of variables to use for x, y, z axis, separated by ':'
[in]xbinsNumber of bins for first variable
[in]ybinsNumber of bins for second variable
[in]zbinsNumber of bins for third variable
Returns
TH1*, which is one of TH[1-3]. The histogram is owned by the caller.

For a greater degree of control use RooAbsReal::createHistogram(const char *, const RooAbsRealLValue&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&) const

Definition at line 1177 of file RooAbsReal.cxx.

◆ createIntegral() [1/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( const RooArgSet & iset,
const char * rangeName ) const
inlineinherited

Create integral over observables in iset in range named rangeName.

Definition at line 204 of file RooAbsReal.h.

◆ createIntegral() [2/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( const RooArgSet & iset,
const RooArgSet & nset,
const char * rangeName = nullptr ) const
inlineinherited

Create integral over observables in iset in range named rangeName with integrand normalized over observables in nset.

Definition at line 208 of file RooAbsReal.h.

◆ createIntegral() [3/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( const RooArgSet & iset,
const RooArgSet & nset,
const RooNumIntConfig & cfg,
const char * rangeName = nullptr ) const
inlineinherited

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.

Definition at line 213 of file RooAbsReal.h.

◆ createIntegral() [4/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( const RooArgSet & iset,
const RooArgSet * nset = nullptr,
const RooNumIntConfig * cfg = nullptr,
const char * rangeName = nullptr ) const
virtualinherited

Create an object that represents the integral of the function over one or more observables listed in iset.

The actual integration calculation is only performed when the return object is evaluated. The name of the integral object is automatically constructed from the name of the input function, the variables it integrates and the range integrates over. If nset is specified the integrand is request to be normalized over nset (only meaningful when the integrand is a pdf). If rangename is specified the integral is performed over the named range, otherwise it is performed over the domain of each integrated observable. If cfg is specified it will be used to configure any numeric integration aspect of the integral. It will not force the integral to be performed numerically, which is decided automatically by RooRealIntegral.

Reimplemented in RooAbsRealLValue, RooBinSamplingPdf, and RooRealIntegral.

Definition at line 550 of file RooAbsReal.cxx.

◆ createIntegral() [5/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( 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
inherited

Create an object that represents the integral of the function over one or more observables listed in iset.

PyROOT

The RooAbsReal::createIntegral() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

The actual integration calculation is only performed when the returned object is evaluated. The name of the integral object is automatically constructed from the name of the input function, the variables it integrates and the range integrates over.

Note
The integral over a PDF is usually not normalised (i.e., it is usually not 1 when integrating the PDF over the full range). In fact, this integral is used to compute the normalisation of each PDF. See the rf110 tutorial for details on PDF normalisation.

The following named arguments are accepted

Effect on integral creation
NormSet(const RooArgSet&) Specify normalization set, mostly useful when working with PDFs
NumIntConfig(const RooNumIntConfig&) Use given configuration for any numeric integration, if necessary
Range(const char* name) Integrate only over given range. Multiple ranges may be specified by passing multiple Range() arguments

Definition at line 511 of file RooAbsReal.cxx.

◆ createIntegral() [6/6]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntegral ( const RooArgSet & iset,
const RooNumIntConfig & cfg,
const char * rangeName = nullptr ) const
inlineinherited

Create integral over observables in iset in range named rangeName using specified configuration for any numeric integration.

Definition at line 217 of file RooAbsReal.h.

◆ createIntObj()

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntObj ( const RooArgSet & iset,
const RooArgSet * nset,
const RooNumIntConfig * cfg,
const char * rangeName ) const
protectedinherited

Internal utility function for createIntegral() that creates the actual integral object.

Definition at line 587 of file RooAbsReal.cxx.

◆ createIntRI()

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createIntRI ( const RooArgSet & iset,
const RooArgSet & nset = {} )
inherited

Utility function for createRunningIntegral.

It creates an object implementing the standard (analytical) integration technique for calculating the running integral.

Definition at line 3717 of file RooAbsReal.cxx.

◆ createNLL()

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooAbsReal > RooAbsPdf::createNLL ( RooAbsData & data,
CmdArgs_t const &... cmdArgs )
inlineinherited

Construct representation of -log(L) of PDF with given dataset.

PyROOT

The RooAbsPdf::createNLL() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

If dataset is unbinned, an unbinned likelihood is constructed. If the dataset is binned, a binned likelihood is constructed.

Parameters
dataReference to a RooAbsData object representing the dataset.
cmdArgsVariadic template arguments representing optional command arguments. You can pass either an arbitrary number of RooCmdArg instances or a single RooLinkedList that points to the RooCmdArg objects.
Returns
An owning pointer to the created RooAbsReal NLL object.
Template Parameters
CmdArgs_tTemplate types for optional command arguments. Can either be an arbitrary number of RooCmdArg or a single RooLinkedList.
Note
This front-end function should not be re-implemented in derived PDF types. If you mean to customize the NLL creation routine, you need to override the virtual RooAbsPdf::createNLLImpl() method.

The following named arguments are supported:

Type of CmdArg Effect on NLL
ConditionalObservables(Args_t &&... argsOrArgSet) Do not normalize PDF over listed observables. Arguments can either be multiple RooRealVar or a single RooArgSet containing them.
Extended(bool flag) Add extended likelihood term, off by default.
Range(const char* name) Fit only data inside range with given name. Multiple comma-separated range names can be specified. In this case, the unnormalized PDF \(f(x)\) is normalized by the integral over all ranges \(r_i\):

\[ p(x) = \frac{f(x)}{\sum_i \int_{r_i} f(x) dx}. \]

Range(double lo, double hi) Fit only data inside given range. A range named "fit" is created on the fly on all observables.
SumCoefRange(const char* name) Set the range in which to interpret the coefficients of RooAddPdf components
NumCPU(int num, int istrat) Parallelize NLL calculation on num CPUs. (Currently, this setting is ignored with the cpu Backend.)
Strategy Effect
0 = RooFit::BulkPartition - default Divide events in N equal chunks
1 = RooFit::Interleave Process event iN in process N. Recommended for binned data with a substantial number of zero-bins, which will be distributed across processes more equitably in this strategy
2 = RooFit::SimComponents Process each component likelihood of a RooSimultaneous fully in a single process and distribute components over processes. This approach can be beneficial if normalization calculation time dominates the total computation time of a component (since the normalization calculation must be performed in each process in strategies 0 and 1. However beware that if the RooSimultaneous components do not share many parameters this strategy is inefficient: as most minuit-induced likelihood calculations involve changing a single parameter, only 1 of the N processes will be active most of the time if RooSimultaneous components do not share many parameters
3 = RooFit::Hybrid Follow strategy 0 for all RooSimultaneous components, except those with less than 30 dataset entries, for which strategy 2 is followed.
EvalBackend(std::string const&) Choose a likelihood evaluation backend:
Backend Description
cpu - default New vectorized evaluation mode, using faster math functions and auto-vectorisation (currently on a single thread). Since ROOT 6.23, this is the default if EvalBackend() is not passed, succeeding the legacy backend. If all RooAbsArg objects in the model support vectorized evaluation, likelihood computations are 2 to 10 times faster than with the legacy backend (each on a single thread).
  • unless your dataset is so small that the vectorization is not worth it. The relative difference of the single log-likelihoods with respect to the legacy mode is usually better than \(10^{-12}\), and for fit parameters it's usually better than \(10^{-6}\). In past ROOT releases, this backend could be activated with the now deprecated BatchMode() option.
cuda Evaluate the likelihood on a GPU that supports CUDA. This backend re-uses code from the cpu backend, but compiled in CUDA kernels. Hence, the results are expected to be identical, modulo some numerical differences that can arise from the different order in which the GPU is summing the log probabilities. This backend can drastically speed up the fit if all RooAbsArg object in the model support it.
legacy The original likelihood evaluation method. Evaluates the PDF for each single data entry at a time before summing the negative log probabilities. It supports multi-threading, but you might need more than 20 threads to maybe see about 10% performance gain over the default cpu-backend (that runs currently only on a single thread).
codegen Experimental - Generates and compiles minimal C++ code for the NLL on-the-fly and wraps it in the returned RooAbsReal. Also generates and compiles the code for the gradient using Automatic Differentiation (AD) with Clad. This analytic gradient is passed to the minimizer, which can result in significant speedups for many-parameter fits, even compared to the cpu backend. However, if one of the RooAbsArg objects in the model does not support the code generation, this backend can't be used.
codegen_no_grad Experimental - Same as codegen, but doesn't generate and compile the gradient code and use the regular numerical differentiation instead. This is expected to be slower, but useful for debugging problems with the analytic gradient.
SplitRange(bool flag) Use separate fit ranges in a simultaneous fit. Actual range name for each subsample is assumed to be rangeName_indexState, where indexState is the state of the master index category of the simultaneous fit. Using Range("range"), SplitRange() as switches, different ranges could be set like this:
myVariable.setRange("range_pi0", 135, 210);
myVariable.setRange("range_gamma", 50, 210);
Constrain(const RooArgSet&pars) For p.d.f.s that contain internal parameter constraint terms (that is usually product PDFs, where one term of the product depends on parameters but not on the observable(s),), only apply constraints to the given subset of parameters.
ExternalConstraints(const RooArgSet& ) Include given external constraints to likelihood by multiplying them with the original likelihood.
GlobalObservables(const RooArgSet&) Define the set of normalization observables to be used for the constraint terms. If none are specified the constrained parameters are used.
GlobalObservablesSource(const char* sourceName) Which source to prioritize for global observable values. Can be either:
  • data: to take the values from the dataset, falling back to the pdf value if a given global observable is not available. If no GlobalObservables or GlobalObservablesTag command argument is given, the set of global observables will be automatically defined to be the set stored in the data.
  • model: to take all values from the pdf and completely ignore the set of global observables stored in the data (not even using it to automatically define the set of global observables if the GlobalObservables or GlobalObservablesTag command arguments are not given). The default option is data.
GlobalObservablesTag(const char* tagName) Define the set of normalization observables to be used for the constraint terms by a string attribute associated with pdf observables that match the given tagName.
Verbose(bool flag) Controls RooFit informational messages in likelihood construction
CloneData(bool flag) Use clone of dataset in NLL (default is true).
Warning
Deprecated option that is ignored. It is up to the implementation of the NLL creation method if the data is cloned or not.
Offset(std::string const& mode) Likelihood offsetting mode. Can be either:
Mode Description
none - default No offsetting.
initial Offset likelihood by initial value (so that starting value of FCN in minuit is zero). This can improve numeric stability in simultaneous fits with components with large likelihood values.
bin Offset likelihood bin-by-bin with a template histogram model based on the obersved data. This results in per-bin values that are all in the same order of magnitude, which reduces precision loss in the sum, which can drastically improve numeric stability. Furthermore, \(2\cdot \text{NLL}\) defined like this is approximately chi-square distributed, allowing for goodness-of-fit tests.
IntegrateBins(double precision) In binned fits, integrate the PDF over the bins instead of using the probability density at the bin centre. This can reduce the bias observed when fitting functions with high curvature to binned data.
  • precision > 0: Activate bin integration everywhere. Use precision between 0.01 and 1.E-6, depending on binning. Note that a low precision such as 0.01 might yield identical results to 1.E-4, since the integrator might reach 1.E-4 already in its first integration step. If lower precision is desired (more speed), a RooBinSamplingPdf has to be created manually, and its integrator has to be manipulated directly.
  • precision = 0: Activate bin integration only for continuous PDFs fit to a RooDataHist.
  • precision < 0: Deactivate.
    See also
    RooBinSamplingPdf
ModularL(bool flag) Enable or disable modular likelihoods, which will become the default in a future release. This does not change any user-facing code, but only enables a different likelihood class in the back-end. Note that this should be set to true for parallel minimization of likelihoods! Note that it is currently not recommended to use Modular likelihoods without any parallelization enabled in the minimization, since some features such as offsetting might not yet work in this case.

Definition at line 155 of file RooAbsPdf.h.

◆ createNLLImpl()

std::unique_ptr< RooAbsReal > RooAbsPdf::createNLLImpl ( RooAbsData & data,
const RooLinkedList & cmdList )
protectedvirtualinherited

Protected implementation of the NLL creation routine.

This virtual function can be overridden in case you want to change the NLL creation logic for custom PDFs.

Note
Never call this function directly. Instead, call RooAbsPdf::createNLL().

Definition at line 933 of file RooAbsPdf.cxx.

◆ createPlotProjection() [1/2]

const RooAbsReal * RooAbsReal::createPlotProjection ( const RooArgSet & dependentVars,
const RooArgSet * projectedVars,
RooArgSet *& cloneSet,
const char * rangeName = nullptr,
const RooArgSet * condObs = nullptr ) const
inherited

Utility function for plotOn() that creates a projection of a function or p.d.f to be plotted on a RooPlot.

Create a new object \( G \) that represents the normalized projection:

\[ G[x,p] = \frac{\int F[x,y,p] \; \mathrm{d}\{y\}} {\int F[x,y,p] \; \mathrm{d}\{x\} \, \mathrm{d}\{y\}} \]

where \( F[x,y,p] \) is the function we represent, and \( \{ p \} \) are the remaining variables ("parameters").

Parameters
[in]dependentVarsDependent variables over which to normalise, \( \{x\} \).
[in]projectedVarsVariables to project out, \( \{ y \} \).
[out]cloneSetWill be set to a RooArgSet*, which will contain a clone of *this plus its projection integral object. The latter will also be returned. The caller takes ownership of this set.
[in]rangeNameOptional range for projection integrals
[in]condObsConditional observables, which are not integrated for normalisation, even if they are in dependentVars or projectedVars.
Returns
A pointer to the newly created object, or zero in case of an error. The caller is responsible for deleting the cloneSet (which includes the returned projection object).

Definition at line 813 of file RooAbsReal.cxx.

◆ createPlotProjection() [2/2]

const RooAbsReal * RooAbsReal::createPlotProjection ( const RooArgSet & depVars,
const RooArgSet & projVars,
RooArgSet *& cloneSet ) const
inherited

Utility function for plotOn() that creates a projection of a function or p.d.f to be plotted on a RooPlot.

createPlotProjection()

Definition at line 784 of file RooAbsReal.cxx.

◆ createProfile()

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createProfile ( const RooArgSet & paramsOfInterest)
virtualinherited

Create a RooProfileLL object that eliminates all nuisance parameters in the present function.

The nuisance parameters are defined as all parameters of the function except the stated paramsOfInterest

Reimplemented in RooProfileLL.

Definition at line 468 of file RooAbsReal.cxx.

◆ createProjection()

RooAbsPdf * RooAbsPdf::createProjection ( const RooArgSet & iset)
virtualinherited

Return a p.d.f that represent a projection of this p.d.f integrated over given observables.

Reimplemented in RooProjectedPdf.

Definition at line 2446 of file RooAbsPdf.cxx.

◆ createRunningIntegral() [1/2]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createRunningIntegral ( const RooArgSet & iset,
const RooArgSet & nset = {} )
inherited

Calls createRunningIntegral(const RooArgSet&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&, const RooCmdArg&).

Definition at line 3596 of file RooAbsReal.cxx.

◆ createRunningIntegral() [2/2]

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createRunningIntegral ( 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 = {} )
inherited

Create an object that represents the running integral of the function over one or more observables listed in iset, i.e.

PyROOT

The RooAbsReal::createRunningIntegral() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

\[ \int_{x_\mathrm{lo}}^x f(x') \, \mathrm{d}x' \]

The actual integration calculation is only performed when the return object is evaluated. The name of the integral object is automatically constructed from the name of the input function, the variables it integrates and the range integrates over. The default strategy to calculate the running integrals is

  • If the integrand (this object) supports analytical integration, construct an integral object that calculate the running integrals value by calculating the analytical integral each time the running integral object is evaluated
  • If the integrand (this object) requires numeric integration to construct the running integral create an object of class RooNumRunningInt which first samples the entire function and integrates the sampled function numerically. This method has superior performance as there is no need to perform a full (numeric) integration for each evaluation of the running integral object, but only when one of its parameters has changed.

The choice of strategy can be changed with the ScanAll() argument, which forces the use of the scanning technique implemented in RooNumRunningInt for all use cases, and with the ScanNone() argument which forces the 'integrate each evaluation' technique for all use cases. The sampling granularity for the scanning technique can be controlled with the ScanParameters technique which allows to specify the number of samples to be taken, and to which order the resulting running integral should be interpolated. The default values are 1000 samples and 2nd order interpolation.

The following named arguments are accepted

Effect on integral creation
SupNormSet(const RooArgSet&) Observables over which should be normalized in addition to the integration observables
ScanParameters(Int_t nbins, Int_t intOrder) Parameters for scanning technique of making CDF: number of sampled bins and order of interpolation applied on numeric cdf
ScanNum() Apply scanning technique if cdf integral involves numeric integration
ScanAll() Always apply scanning technique
ScanNone() Never apply scanning technique

Definition at line 3640 of file RooAbsReal.cxx.

◆ createScanCdf()

RooFit::OwningPtr< RooAbsReal > RooAbsPdf::createScanCdf ( const RooArgSet & iset,
const RooArgSet & nset,
Int_t numScanBins,
Int_t intOrder )
inherited

Definition at line 2545 of file RooAbsPdf.cxx.

◆ createScanRI()

RooFit::OwningPtr< RooAbsReal > RooAbsReal::createScanRI ( const RooArgSet & iset,
const RooArgSet & nset,
Int_t numScanBins,
Int_t intOrder )
inherited

Utility function for createRunningIntegral that construct an object implementing the numeric scanning technique for calculating the running integral.

Definition at line 3700 of file RooAbsReal.cxx.

◆ dataToken()

std::size_t RooAbsArg::dataToken ( ) const
inlineinherited

Returns the token for retrieving results in the BatchMode. For internal use only.

Definition at line 635 of file RooAbsArg.h.

◆ DeclFileName()

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

Definition at line 50 of file RooEfficiency.h.

◆ defaultErrorLevel()

virtual double RooAbsReal::defaultErrorLevel ( ) const
inlinevirtualinherited

◆ defaultGeneratorConfig()

RooNumGenConfig * RooAbsPdf::defaultGeneratorConfig ( )
staticinherited

Returns the default numeric MC generator configuration for all RooAbsReals.

Definition at line 2611 of file RooAbsPdf.cxx.

◆ defaultIntegratorConfig()

RooNumIntConfig * RooAbsReal::defaultIntegratorConfig ( )
staticinherited

Returns the default numeric integration configuration for all RooAbsReals.

Definition at line 3182 of file RooAbsReal.cxx.

◆ defaultPrintContents()

Int_t RooAbsArg::defaultPrintContents ( Option_t * opt) const
overridevirtualinherited

Define default contents to print.

Reimplemented from RooPrintable.

Reimplemented in RooRealVar.

Definition at line 1379 of file RooAbsArg.cxx.

◆ defaultPrintStream()

ostream & RooPrintable::defaultPrintStream ( std::ostream * os = nullptr)
staticinherited

Return a reference to the current default stream to use in Print().

Use the optional parameter to specify a new default stream (a reference to the old one is still returned). This method allows subclasses to provide an inline implementation of Print() without pulling in iostream.h.

Definition at line 268 of file RooPrintable.cxx.

◆ defaultPrintStyle()

RooPrintable::StyleOption RooPrintable::defaultPrintStyle ( Option_t * opt) const
virtualinherited

Reimplemented in RooAbsGenContext, RooFitResult, RooNumGenConfig, and RooNumIntConfig.

Definition at line 237 of file RooPrintable.cxx.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ dependsOn() [1/3]

bool RooAbsArg::dependsOn ( const RooAbsArg & server,
const RooAbsArg * ignoreArg = nullptr,
bool valueOnly = false ) const
inlineinherited

Test whether we depend on (ie, are served by) the specified object.

Note that RooAbsArg objects are considered equivalent if they have the same name.

Definition at line 122 of file RooAbsArg.h.

◆ dependsOn() [2/3]

bool RooAbsArg::dependsOn ( const RooAbsCollection & serverList,
const RooAbsArg * ignoreArg = nullptr,
bool valueOnly = false ) const
inherited

Test whether we depend on (ie, are served by) any object in the specified collection.

Uses the dependsOn(RooAbsArg&) member function.

Definition at line 717 of file RooAbsArg.cxx.

◆ dependsOn() [3/3]

bool RooAbsArg::dependsOn ( TNamed const * namePtr,
const RooAbsArg * ignoreArg = nullptr,
bool valueOnly = false ) const
inherited

Test whether we depend on (ie, are served by) an object with a specific name.

Definition at line 731 of file RooAbsArg.cxx.

◆ dependsOnValue() [1/2]

bool RooAbsArg::dependsOnValue ( const RooAbsArg & server,
const RooAbsArg * ignoreArg = nullptr ) const
inlineinherited

Check whether this object depends on values served from the object passed as server.

Parameters
serverTest if server serves values to this.
ignoreArgIgnore values served by this object.
Returns
True if values are served.

Definition at line 113 of file RooAbsArg.h.

◆ dependsOnValue() [2/2]

bool RooAbsArg::dependsOnValue ( const RooAbsCollection & serverList,
const RooAbsArg * ignoreArg = nullptr ) const
inlineinherited

Check whether this object depends on values from an element in the serverList.

Parameters
serverListTest if one of the elements in this list serves values to this.
ignoreArgIgnore values served by this object.
Returns
True if values are served.

Definition at line 104 of file RooAbsArg.h.

◆ derivative() [1/2]

RooDerivative * RooAbsReal::derivative ( RooRealVar & obs,
const RooArgSet & normSet,
Int_t order,
double eps = 0.001 )
inherited

Return function representing first, second or third order derivative of this function.

Definition at line 3887 of file RooAbsReal.cxx.

◆ derivative() [2/2]

RooDerivative * RooAbsReal::derivative ( RooRealVar & obs,
Int_t order = 1,
double eps = 0.001 )
inherited

Return function representing first, second or third order derivative of this function.

Definition at line 3877 of file RooAbsReal.cxx.

◆ DistancetoPrimitive()

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ doEval()

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ effFunc()

RooAbsReal const & RooEfficiency::effFunc ( ) const
inline

Definition at line 38 of file RooEfficiency.h.

◆ enableOffsetting()

void RooAbsReal::enableOffsetting ( bool flag)
virtualinherited

Definition at line 4237 of file RooAbsReal.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ evalErrorIter()

EvalErrorData::ErrorList::iterator RooAbsReal::evalErrorIter ( )
staticinherited

Definition at line 179 of file RooAbsReal.cxx.

◆ evalErrorLoggingMode()

RooAbsReal::ErrorLoggingMode RooAbsReal::evalErrorLoggingMode ( )
staticinherited

Return current evaluation error logging mode.

Definition at line 4070 of file RooAbsReal.cxx.

◆ evaluate()

double RooEfficiency::evaluate ( ) const
overrideprotectedvirtual

Calculate the raw value of this p.d.f which is the effFunc value if cat==1 and it is (1-effFunc) if cat==0.

Implements RooAbsReal.

Definition at line 73 of file RooEfficiency.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ expectedEvents() [1/2]

double RooAbsPdf::expectedEvents ( const RooArgSet & nset) const
inlineinherited

Return expected number of events to be used in calculation of extended likelihood.

This function should not be overridden, as it just redirects to the actual virtual function but takes a RooArgSet reference instead of pointer.

See also
expectedEvents(const RooArgSet*) const

Definition at line 228 of file RooAbsPdf.h.

◆ expectedEvents() [2/2]

double RooAbsPdf::expectedEvents ( const RooArgSet * nset) const
virtualinherited

Return expected number of events to be used in calculation of extended likelihood.

Return expected number of events from this p.d.f for use in extended likelihood calculations.

This default implementation returns zero

Reimplemented in RooAddModel, RooAddPdf, RooBinSamplingPdf, RooExtendedTerm, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooProdPdf, RooProjectedPdf, RooRealSumPdf, RooSimultaneous, and xRooProjectedPdf.

Definition at line 2398 of file RooAbsPdf.cxx.

◆ expensiveObjectCache()

RooExpensiveObjectCache & RooAbsArg::expensiveObjectCache ( ) const
inherited

Definition at line 2063 of file RooAbsArg.cxx.

◆ extendedTerm() [1/3]

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

Definition at line 722 of file RooAbsPdf.cxx.

◆ extendedTerm() [2/3]

double RooAbsPdf::extendedTerm ( double sumEntries,
RooArgSet const * nset,
double sumEntriesW2 = 0.0,
bool doOffset = false ) const
inherited

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.

For successful operation, the PDF implementation must indicate that it is extendable by overloading canBeExtended(), and must implement the expectedEvents() function.

Parameters
[in]sumEntriesThe number of observed events.
[in]nsetThe normalization set when asking the pdf for the expected number of events.
[in]sumEntriesW2The number of observed events when weighting with squared weights. If non-zero, the weight-squared error correction is applied to the extended term.
[in]doOffsetOffset the extended term by a counterterm where the expected number of events equals the observed number of events. This constant shift results in a term closer to zero that is approximately chi-square distributed. It is useful to do this also when summing multiple NLL terms to avoid numeric precision loss that happens if you sum multiple terms of different orders of magnitude.

The weight-squared error correction works as follows: adjust poisson such that estimate of \(N_\mathrm{expect}\) stays at the same value, but has a different variance, rescale both the observed and expected count of the Poisson with a factor \( \sum w_{i} / \sum w_{i}^2 \) (the effective weight of the Poisson term), i.e., change \(\mathrm{Poisson}(N_\mathrm{observed} = \sum w_{i} | N_\mathrm{expect} )\) to \( \mathrm{Poisson}(\sum w_{i} \cdot \sum w_{i} / \sum w_{i}^2 | N_\mathrm{expect} \cdot \sum w_{i} / \sum w_{i}^2 ) \), weighted by the effective weight \( \sum w_{i}^2 / \sum w_{i} \) in the likelihood. Since here we compute the likelihood with the weight square, we need to multiply by the square of the effective weight:

  • \( W_\mathrm{expect} = N_\mathrm{expect} \cdot \sum w_{i} / \sum w_{i}^2 \) : effective expected entries
  • \( W_\mathrm{observed} = \sum w_{i} \cdot \sum w_{i} / \sum w_{i}^2 \) : effective observed entries

The extended term for the likelihood weighted by the square of the weight will be then:

\( \left(\sum w_{i}^2 / \sum w_{i}\right)^2 \cdot W_\mathrm{expect} - (\sum w_{i}^2 / \sum w_{i})^2 \cdot W_\mathrm{observed} \cdot \log{W_\mathrm{expect}} \)

aund this is using the previous expressions for \( W_\mathrm{expect} \) and \( W_\mathrm{observed} \):

\( \sum w_{i}^2 / \sum w_{i} \cdot N_\mathrm{expect} - \sum w_{i}^2 \cdot \log{W_\mathrm{expect}} \)

Since the weights are constants in the likelihood we can use \(\log{N_\mathrm{expect}}\) instead of \(\log{W_\mathrm{expect}}\).

See also RooAbsPdf::extendedTerm(RooAbsData const& data, bool weightSquared, bool doOffset), which takes a dataset to extract \(N_\mathrm{observed}\) and the normalization set.

Definition at line 717 of file RooAbsPdf.cxx.

◆ extendedTerm() [3/3]

double RooAbsPdf::extendedTerm ( RooAbsData const & data,
bool weightSquared,
bool doOffset = false ) const
inherited

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.

This function is a wrapper around RooAbsPdf::extendedTerm(double, RooArgSet const *, double, bool) const, where the number of observed events and observables to be used as the normalization set for the pdf is extracted from a RooAbsData.

For successful operation, the PDF implementation must indicate that it is extendable by overloading canBeExtended(), and must implement the expectedEvents() function.

Parameters
[in]dataThe RooAbsData to retrieve the set of observables and number of expected events.
[in]weightSquaredIf set to true, the extended term will be scaled by the ratio of squared event weights over event weights: \( \sum w_{i}^2 / \sum w_{i} \). Intended to be used by fits with the SumW2Error() option that can be passed to RooAbsPdf::fitTo() (see the documentation of said function to learn more about the interpretation of fits with squared weights).
[in]doOffsetSee RooAbsPdf::extendedTerm(double, RooArgSet const*, double, bool) const.

Definition at line 785 of file RooAbsPdf.cxx.

◆ extendMode()

virtual ExtendMode RooAbsPdf::extendMode ( ) const
inlinevirtualinherited

Returns ability of PDF to provide extended likelihood terms.

Possible answers are in the enumerator RooAbsPdf::ExtendMode. This default implementation always returns CanNotBeExtended.

Reimplemented in RooAddModel, RooAddPdf, RooBinSamplingPdf, RooExtendedTerm, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooProdPdf, RooProjectedPdf, RooRealSumPdf, RooSimultaneous, and xRooProjectedPdf.

Definition at line 212 of file RooAbsPdf.h.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ fillDataHist()

RooDataHist * RooAbsReal::fillDataHist ( RooDataHist * hist,
const RooArgSet * normSet,
double scaleFactor,
bool correctForBinSize = false,
bool showProgress = false ) const
inherited

Fill a RooDataHist with values sampled from this function at the bin centers.

If extendedMode is true, the p.d.f. values is multiplied by the number of expected events in each bin

An optional scaling by a given scaleFactor can be performed. Returns a pointer to the input RooDataHist, or zero in case of an error.

If correctForBinSize is true the RooDataHist is filled with the functions density (function value times the bin volume) rather than function value.

If showProgress is true a process indicator is printed on stdout in steps of one percent, which is mostly useful for the sampling of expensive functions such as likelihoods

Definition at line 1118 of file RooAbsReal.cxx.

◆ fillHistogram()

TH1 * RooAbsReal::fillHistogram ( TH1 * hist,
const RooArgList & plotVars,
double scaleFactor = 1,
const RooArgSet * projectedVars = nullptr,
bool scaleForDensity = true,
const RooArgSet * condObs = nullptr,
bool setError = true ) const
inherited

Fill the ROOT histogram 'hist' with values sampled from this function at the bin centers.

Our value is calculated by first integrating out any variables in projectedVars and then scaling the result by scaleFactor. Returns a pointer to the input histogram, or zero in case of an error. The input histogram can be any TH1 subclass, and therefore of arbitrary dimension. Variables are matched with the (x,y,...) dimensions of the input histogram according to the order in which they appear in the input plotVars list. If scaleForDensity is true the histogram is filled with a the functions density rather than the functions value (i.e. the value at the bin center is multiplied with bin volume)

Definition at line 944 of file RooAbsReal.cxx.

◆ fillTreeBranch()

void RooAbsReal::fillTreeBranch ( TTree & t)
overrideprotectedvirtualinherited

Fill the tree branch that associated with this object with its current value.

Implements RooAbsArg.

Reimplemented in RooRealVar.

Definition at line 3085 of file RooAbsReal.cxx.

◆ findConstantNodes() [1/2]

bool RooAbsArg::findConstantNodes ( const RooArgSet & observables,
RooArgSet & cacheList )
inherited

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.

Definition at line 1633 of file RooAbsArg.cxx.

◆ findConstantNodes() [2/2]

bool RooAbsArg::findConstantNodes ( const RooArgSet & observables,
RooArgSet & cacheList,
RooLinkedList & processedNodes )
inherited

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.

Definition at line 1649 of file RooAbsArg.cxx.

◆ findInnerMostIntegration()

void RooAbsReal::findInnerMostIntegration ( const RooArgSet & allObs,
RooArgSet & innerObs,
const char * rangeName ) const
protectedinherited

Utility function for createIntObj() that aids in the construct of recursive integrals over functions with multiple observables with parameterized ranges.

This function finds in a given set allObs over which integration is requested the largeset subset of observables that can be integrated simultaneously. This subset consists of observables with fixed ranges and observables with parameterized ranges whose parameterization does not depend on any observable that is also integrated.

Definition at line 698 of file RooAbsReal.cxx.

◆ findNewServer()

RooAbsArg * RooAbsArg::findNewServer ( const RooAbsCollection & newSet,
bool nameChange ) const
inherited

Find the new server in the specified set that matches the old server.

Parameters
[in]newSetSearch this set by name for a new server.
[in]nameChangeIf true, search for an item with the bool attribute "ORIGNAME:<oldName>" set. Use <object>.setAttribute("ORIGNAME:<oldName>") to set this attribute.
Returns
Pointer to the new server or nullptr if there's no unique match.

Definition at line 1053 of file RooAbsArg.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ findRoot()

double RooAbsReal::findRoot ( RooRealVar & x,
double xmin,
double xmax,
double yval )
inherited

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

(Calculation is performed with Brent root finding algorithm)

Definition at line 3939 of file RooAbsReal.cxx.

◆ findServer() [1/3]

RooAbsArg * RooAbsArg::findServer ( const char * name) const
inlineinherited

Return server of this with name name. Returns nullptr if not found.

Definition at line 147 of file RooAbsArg.h.

◆ findServer() [2/3]

RooAbsArg * RooAbsArg::findServer ( const RooAbsArg & arg) const
inlineinherited

Return server of this that has the same name as arg. Returns nullptr if not found.

Definition at line 153 of file RooAbsArg.h.

◆ findServer() [3/3]

RooAbsArg * RooAbsArg::findServer ( Int_t index) const
inlineinherited

Return i-th server from server list.

Definition at line 155 of file RooAbsArg.h.

◆ fitTo()

template<typename... CmdArgs_t>
RooFit::OwningPtr< RooFitResult > RooAbsPdf::fitTo ( RooAbsData & data,
CmdArgs_t const &... cmdArgs )
inlineinherited

Fit PDF to given dataset.

PyROOT

The RooAbsPdf::fitTo() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

If dataset is unbinned, an unbinned maximum likelihood is performed. If the dataset is binned, a binned maximum likelihood is performed. By default the fit is executed through the MINUIT commands MIGRAD, HESSE in succession.

Parameters
dataReference to a RooAbsData object representing the dataset.
cmdArgsVariadic template arguments representing optional command arguments. You can pass either an arbitrary number of RooCmdArg instances or a single RooLinkedList that points to the RooCmdArg objects.
Returns
An owning pointer to the created RooAbsReal NLL object.
RooFitResult with fit status and parameters if option Save() is used, nullptr otherwise. The user takes ownership of the fit result.
Template Parameters
CmdArgs_tTemplate types for optional command arguments. Can either be an arbitrary number of RooCmdArg or a single RooLinkedList.
Note
This front-end function should not be re-implemented in derived PDF types. If you mean to customize the likelihood fitting routine, you need to override the virtual RooAbsPdf::fitToImpl() method.

The following named arguments are supported:

Type of CmdArg Options to control construction of -log(L)
All command arguments that can also be passed to the NLL creation method.
See also
RooAbsPdf::createNLL()
Options to control flow of fit procedure
Minimizer("<type>", "<algo>")

Choose minimization package and optionally the algorithm to use. Default is MINUIT/MIGRAD through the RooMinimizer interface, but others can be specified (through RooMinimizer interface).

Type Algorithm
Minuit migrad, simplex, minimize (=migrad+simplex), migradimproved (=migrad+improve)
Minuit2 migrad, simplex, minimize, scan
GSLMultiMin conjugatefr, conjugatepr, bfgs, bfgs2, steepestdescent
GSLSimAn -

InitialHesse(bool flag) Flag controls if HESSE before MIGRAD as well, off by default
Hesse(bool flag) Flag controls if HESSE is run after MIGRAD, on by default
Minos(bool flag) Flag controls if MINOS is run after HESSE, off by default
Minos(const RooArgSet& set) Only run MINOS on given subset of arguments
Save(bool flag) Flag controls if RooFitResult object is produced and returned, off by default
Strategy(Int_t flag) Set Minuit strategy (0 to 2, default is 1)
MaxCalls(int n) Change maximum number of likelihood function calls from MINUIT (if n <= 0, the default of 500 * #parameters is used)
EvalErrorWall(bool flag=true) When parameters are in disallowed regions (e.g. PDF is negative), return very high value to fitter to force it out of that region. This can, however, mean that the fitter gets lost in this region. If this happens, try switching it off.
RecoverFromUndefinedRegions(double strength)

When PDF is invalid (e.g. parameter in undefined region), try to direct minimiser away from that region. strength controls the magnitude of the penalty term. Leaving out this argument defaults to 10. Switch off with strength = 0..

SumW2Error(bool flag) Apply correction to errors and covariance matrix. This uses two covariance matrices, one with the weights, the other with squared weights, to obtain the correct errors for weighted likelihood fits. If this option is activated, the corrected covariance matrix is calculated as \( V_\mathrm{corr} = V C^{-1} V \), where \( V \) is the original covariance matrix and \( C \) is the inverse of the covariance matrix calculated using the squared weights. This allows to switch between two interpretations of errors:
SumW2Error Interpretation
true

The errors reflect the uncertainty of the Monte Carlo simulation. Use this if you want to know how much accuracy you can get from the available Monte Carlo statistics.

Example: Simulation with 1000 events, the average weight is 0.1. The errors are as big as if one fitted to 1000 events.

false

The errors reflect the errors of a dataset, which is as big as the sum of weights. Use this if you want to know what statistical errors you would get if you had a dataset with as many events as the (weighted) Monte Carlo simulation represents.

Example (Data as above): The errors are as big as if one fitted to 100 events.

Note
If the SumW2Error correction is enabled, the covariance matrix quality stored in the RooFitResult object will be the minimum of the original covariance matrix quality and the quality of the covariance matrix calculated with the squared weights.
AsymptoticError() Use the asymptotically correct approach to estimate errors in the presence of weights. This is slower but more accurate than SumW2Error. See also https://arxiv.org/abs/1911.01303). This option even correctly implements the case of extended likelihood fits (see this writeup on extended weighted fits that complements the paper linked before).
PrefitDataFraction(double fraction) Runs a prefit on a small dataset of size fraction*(actual data size). This can speed up fits by finding good starting values for the parameters for the actual fit.
Warning
Prefitting may give bad results when used in binned analysis.
Options to control informational output
Verbose(bool flag) Flag controls if verbose output is printed (NLL, parameter changes during fit).
Timer(bool flag) Time CPU and wall clock consumption of fit steps, off by default.
PrintLevel(Int_t level) Set Minuit print level (-1 to 3, default is 1). At -1 all RooFit informational messages are suppressed as well. See RooMinimizer::PrintLevel for the meaning of the levels.
Warnings(bool flag) Enable or disable MINUIT warnings (enabled by default)
PrintEvalErrors(Int_t numErr) Control number of p.d.f evaluation errors printed per likelihood evaluation. A negative value suppresses output completely, a zero value will only print the error count per p.d.f component, a positive value will print details of each error up to numErr messages per p.d.f component.
Parallelize(Int_t nWorkers) Control global parallelization settings. Arguments 1 and above enable the use of RooFit's parallel minimization backend and uses the number given as the number of workers to use in the parallelization. -1 also enables RooFit's parallel minimization backend, and sets the number of workers to the number of available processes. 0 disables this feature. In case parallelization is requested, this option implies ModularL(true) in the internal call to the NLL creation method.
ParallelGradientOptions(bool enable=true, int orderStrategy=0, int chainFactor=1) Experimental - Control gradient parallelization settings. The first argument only disables or enables gradient parallelization, this is on by default. The second argument determines the internal partial derivative calculation ordering strategy. The third argument determines the number of partial derivatives that are executed per task package on each worker.
ParallelDescentOptions(bool enable=false, int splitStrategy=0, int numSplits=4) Experimental - Control settings related to the parallelization of likelihoods outside of the gradient calculation but in the minimization, most prominently in the linesearch step. The first argument this disables or enables likelihood parallelization. The second argument determines whether to split the task batches per event or per likelihood component. And the third argument how many events or respectively components to include in each batch.
TimingAnalysis(bool flag) Experimental - Log timings. This feature logs timings with NewStyle likelihoods on multiple processes simultaneously and outputs the timings at the end of a run to json log files, which can be analyzed with the RooFit::MultiProcess::HeatmapAnalyzer. Only works with simultaneous likelihoods.

Definition at line 149 of file RooAbsPdf.h.

◆ fitToImpl()

std::unique_ptr< RooFitResult > RooAbsPdf::fitToImpl ( RooAbsData & data,
const RooLinkedList & cmdList )
protectedvirtualinherited

Protected implementation of the likelihood fitting routine.

This virtual function can be overridden in case you want to change the likelihood fitting logic for custom PDFs.

Note
Never call this function directly. Instead, call RooAbsPdf::fitTo().

Definition at line 1063 of file RooAbsPdf.cxx.

◆ fixAddCoefNormalization()

void RooAbsReal::fixAddCoefNormalization ( const RooArgSet & addNormSet = RooArgSet(),
bool force = true )
virtualinherited

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

If the force flag is false, the normalization choice is only fixed for those RooAddPdf components that have the default 'automatic' interpretation of coefficients (i.e. the interpretation is defined by the observables passed to getVal()). If force is true, also RooAddPdf that already have a fixed interpretation are changed to a new fixed interpretation.

Definition at line 3544 of file RooAbsReal.cxx.

◆ fixAddCoefRange()

void RooAbsReal::fixAddCoefRange ( const char * rangeName = nullptr,
bool force = true )
virtualinherited

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

If the force flag is false, the normalization range choice is only fixed for those RooAddPdf components that currently use the default full domain to interpret their coefficients. If force is true, also RooAddPdf that already have a fixed interpretation range are changed to a new fixed interpretation range.

Definition at line 3565 of file RooAbsReal.cxx.

◆ forceAnalyticalInt()

◆ forceNumInt()

virtual void RooAbsReal::forceNumInt ( bool flag = true)
inlinevirtualinherited

Definition at line 175 of file RooAbsReal.h.

◆ functor()

RooFunctor * RooAbsReal::functor ( const RooArgList & obs,
const RooArgList & pars = RooArgList(),
const RooArgSet & nset = RooArgSet() ) const
inherited

Return a RooFunctor object bound to this RooAbsReal with given definition of observables and parameters.

Definition at line 3777 of file RooAbsReal.cxx.

◆ genContext()

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

Interface function to create a generator context from a p.d.f.

This default implementation returns a 'standard' context that works for any p.d.f

Reimplemented in RooAbsAnaConvPdf, RooAddModel, RooAddPdf, RooEffProd, RooFFTConvPdf, RooNumConvPdf, RooProdPdf, and RooSimultaneous.

Definition at line 1118 of file RooAbsPdf.cxx.

◆ generate() [1/6]

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generate ( const RooArgSet & whatVars,
const RooCmdArg & arg1 = {},
const RooCmdArg & arg2 = {},
const RooCmdArg & arg3 = {},
const RooCmdArg & arg4 = {},
const RooCmdArg & arg5 = {},
const RooCmdArg & arg6 = {} )
inherited

Generate a new dataset containing the specified variables with events sampled from our distribution.

PyROOT

The RooAbsPdf::generate() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Generate the specified number of events or expectedEvents() if not specified.

Parameters
[in]whatVarsChoose variables in which to generate events. Variables not listed here will remain constant and not be used for event generation.
[in]arg1,arg2,arg3,arg4,arg5,arg6Optional RooCmdArg() to change behaviour of generate().
Returns
RooDataSet *, owned by caller.

Any variables of this PDF that are not in whatVars will use their current values and be treated as fixed parameters. Returns zero in case of an error.

Type of CmdArg Effect on generate
Name(const char* name) Name of the output dataset
Verbose(bool flag) Print informational messages during event generation
NumEvents(int nevt) Generate specified number of events
Extended() If no number of events to be generated is given, use expected number of events from extended likelihood term. This evidently only works for extended PDFs.
GenBinned(const char* tag) Use binned generation for all component pdfs that have 'setAttribute(tag)' set
AutoBinned(bool flag) Automatically deploy binned generation for binned distributions (e.g. RooHistPdf, sums and products of RooHistPdfs etc)
Note
Datasets that are generated in binned mode are returned as weighted unbinned datasets. This means that for each bin, there will be one event in the dataset with a weight corresponding to the (possibly randomised) bin content.
AllBinned() As above, but for all components.
Note
The notion of components is only meaningful for simultaneous PDFs as binned generation is always executed at the top-level node for a regular PDF, so for those it only mattes that the top-level node is tagged.
ProtoData(const RooAbsData& data, bool randOrder) Use specified dataset as prototype dataset. If randOrder in ProtoData() is set to true, the order of the events in the dataset will be read in a random order if the requested number of events to be generated does not match the number of events in the prototype dataset.
Note
If ProtoData() is used, the specified existing dataset as a prototype: the new dataset will contain the same number of events as the prototype (unless otherwise specified), and any prototype variables not in whatVars will be copied into the new dataset for each generated event and also used to set our PDF parameters. The user can specify a number of events to generate that will override the default. The result is a copy of the prototype dataset with only variables in whatVars randomized. Variables in whatVars that are not in the prototype will be added as new columns to the generated dataset.

Accessing the underlying event generator

Depending on the fit model (if it is difficult to sample), it may be necessary to change generator settings. For the default generator (RooFoamGenerator), the number of samples or cells could be increased by e.g. using myPdf->specialGeneratorConfig()->getConfigSection("RooFoamGenerator").setRealValue("nSample",1e4);

The foam generator e.g. has the following config options:

  • nCell[123N]D
  • nSample
  • chatLevel
    See also
    rf902_numgenconfig.C

Definition at line 1201 of file RooAbsPdf.cxx.

◆ generate() [2/6]

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generate ( const RooArgSet & whatVars,
const RooDataSet & prototype,
Int_t nEvents = 0,
bool verbose = false,
bool randProtoOrder = false,
bool resampleProto = false ) const
inherited

Generate a new dataset using a prototype dataset as a model, with values of the variables in whatVars sampled from our distribution.

Parameters
[in]whatVarsGenerate for these variables.
[in]prototypeUse this dataset as a prototype: the new dataset will contain the same number of events as the prototype (by default), and any prototype variables not in whatVars will be copied into the new dataset for each generated event and also used to set our PDF parameters. The user can specify a number of events to generate that will override the default. The result is a copy of the prototype dataset with only variables in whatVars randomized. Variables in whatVars that are not in the prototype will be added as new columns to the generated dataset.
[in]nEventsNumber of events to generate. Defaults to 0, which means number of event in prototype dataset.
[in]verboseShow which generator strategies are being used.
[in]randProtoOrderRandomise order of retrieval of events from proto dataset.
[in]resampleProtoResample from the proto dataset.
Returns
The new dataset. Returns zero in case of an error. The caller takes ownership of the returned dataset.

Definition at line 1460 of file RooAbsPdf.cxx.

◆ generate() [3/6]

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generate ( const RooArgSet & whatVars,
double nEvents = 0,
bool verbose = false,
bool autoBinned = true,
const char * binnedTag = "",
bool expectedData = false,
bool extended = false ) const
inherited

Generate a new dataset containing the specified variables with events sampled from our distribution.

Parameters
[in]whatVarsGenerate a dataset with the variables (and categories) in this set. Any variables of this PDF that are not in whatVars will use their current values and be treated as fixed parameters.
[in]nEventsGenerate the specified number of events or else try to use expectedEvents() if nEvents <= 0 (default).
[in]verboseShow which generator strategies are being used.
[in]autoBinnedIf original distribution is binned, return bin centers and randomise weights instead of generating single events.
[in]binnedTag
[in]expectedDataCall setExpectedData on the genContext.
[in]extendedRandomise number of events generated according to Poisson(nEvents). Only useful if PDF is extended.
Returns
New dataset. Returns zero in case of an error. The caller takes ownership of the returned dataset.

Definition at line 1376 of file RooAbsPdf.cxx.

◆ generate() [4/6]

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generate ( const RooArgSet & whatVars,
Int_t nEvents,
const RooCmdArg & arg1,
const RooCmdArg & arg2 = {},
const RooCmdArg & arg3 = {},
const RooCmdArg & arg4 = {},
const RooCmdArg & arg5 = {} )
inlineinherited

See RooAbsPdf::generate(const RooArgSet&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&).

Parameters
[in]whatVarsSet of observables to generate for each event according to this model.
[in]nEventsHow many events to generate
arg1,arg2,arg3,arg4,arg5Optional command arguments.

Definition at line 49 of file RooAbsPdf.h.

◆ generate() [5/6]

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generate ( RooAbsPdf::GenSpec & spec) const
inherited

Generate according to GenSpec obtained from prepareMultiGen().

If many identical generation requests are needed, e.g.

in toy MC studies, it is more efficient to use the prepareMultiGen()/generate() combination than calling the standard generate() multiple times as initialization overhead is only incurred once.

Definition at line 1339 of file RooAbsPdf.cxx.

◆ generate() [6/6]

std::unique_ptr< RooDataSet > RooAbsPdf::generate ( RooAbsGenContext & context,
const RooArgSet & whatVars,
const RooDataSet * prototype,
double nEvents,
bool verbose,
bool randProtoOrder,
bool resampleProto,
bool skipInit = false,
bool extended = false ) const
privateinherited

Internal method.

Definition at line 1404 of file RooAbsPdf.cxx.

◆ generateBinned() [1/3]

RooFit::OwningPtr< RooDataHist > RooAbsPdf::generateBinned ( const RooArgSet & whatVars,
const RooCmdArg & arg1 = {},
const RooCmdArg & arg2 = {},
const RooCmdArg & arg3 = {},
const RooCmdArg & arg4 = {},
const RooCmdArg & arg5 = {},
const RooCmdArg & arg6 = {} ) const
virtualinherited

Generate a new dataset containing the specified variables with events sampled from our distribution.

PyROOT

The RooAbsPdf::generateBinned() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Parameters
[in]whatVarsChoose variables in which to generate events. Variables not listed here will remain constant and not be used for event generation
[in]arg1,arg2,arg3,arg4,arg5,arg6Optional RooCmdArg to change behaviour of generateBinned()
Returns
RooDataHist *, to be managed by caller.

Generate the specified number of events or expectedEvents() if not specified.

Any variables of this PDF that are not in whatVars will use their current values and be treated as fixed parameters. Returns zero in case of an error. The caller takes ownership of the returned dataset.

The following named arguments are supported

Type of CmdArg Effect on generation
Name(const char* name) Name of the output dataset
Verbose(bool flag) Print informational messages during event generation
NumEvents(int nevt) Generate specified number of events
Extended() The actual number of events generated will be sampled from a Poisson distribution with mu=nevt. This can be much faster for peaked PDFs, but the number of events is not exactly what was requested.
ExpectedData() Return a binned dataset without statistical fluctuations (also aliased as Asimov())

Definition at line 1589 of file RooAbsPdf.cxx.

◆ generateBinned() [2/3]

RooFit::OwningPtr< RooDataHist > RooAbsPdf::generateBinned ( const RooArgSet & whatVars,
double nEvents,
bool expectedData = false,
bool extended = false ) const
virtualinherited

Generate a new dataset containing the specified variables with events sampled from our distribution.

Parameters
[in]whatVarsVariables that values should be generated for.
[in]nEventsHow many events to generate. If nEvents <=0, use the value returned by expectedEvents() as target.
[in]expectedDataIf set to true (false by default), the returned histogram returns the 'expected' data sample, i.e. no statistical fluctuations are present.
[in]extendedFor each bin, generate Poisson(x, mu) events, where mu is chosen such that on average, one would obtain nEvents events. This means that the true number of events will fluctuate around the desired value, but the generation happens a lot faster. Especially if the PDF is sharply peaked, the multinomial event generation necessary to generate exactly nEvents events can be very slow.

The binning used for generation of events is the currently set binning for the variables. It can e.g. be changed using

x.setBins(15);
x.setRange(-5., 5.);
pdf.generateBinned(RooArgSet(x), 1000);
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition RooArgSet.h:24

Any variables of this PDF that are not in whatVars will use their current values and be treated as fixed parameters.

Returns
RooDataHist* owned by the caller. Returns nullptr in case of an error.

Definition at line 1671 of file RooAbsPdf.cxx.

◆ generateBinned() [3/3]

virtual RooFit::OwningPtr< RooDataHist > RooAbsPdf::generateBinned ( const RooArgSet & whatVars,
double nEvents,
const RooCmdArg & arg1,
const RooCmdArg & arg2 = {},
const RooCmdArg & arg3 = {},
const RooCmdArg & arg4 = {},
const RooCmdArg & arg5 = {} ) const
inlinevirtualinherited

As RooAbsPdf::generateBinned(const RooArgSet&, const RooCmdArg&,const RooCmdArg&, const RooCmdArg&,const RooCmdArg&, const RooCmdArg&,const RooCmdArg&) const.

Parameters
[in]whatVarsset
[in]nEventsHow many events to generate
arg1,arg2,arg3,arg4,arg5ordered arguments

Definition at line 102 of file RooAbsPdf.h.

◆ generateEvent()

void RooAbsPdf::generateEvent ( Int_t code)
virtualinherited

Interface for generation of an event using the algorithm corresponding to the specified code.

The meaning of each code is defined by the getGenerator() implementation. The default implementation does nothing.

Reimplemented in RooAddModel, RooBCPEffDecay, RooBCPGenDecay, RooBDecay, RooBinSamplingPdf, RooBMixDecay, RooDecay, RooGamma, RooGaussian, RooGaussModel, RooGExpModel, RooJohnson, RooLandau, RooLognormal, RooMultiVarGaussian, RooNonCPEigenDecay, RooPoisson, RooProdPdf, RooTruthModel, and RooUniform.

Definition at line 1535 of file RooAbsPdf.cxx.

◆ generateSimGlobal()

RooFit::OwningPtr< RooDataSet > RooAbsPdf::generateSimGlobal ( const RooArgSet & whatVars,
Int_t nEvents )
virtualinherited

Special generator interface for generation of 'global observables' – for RooStats tools.

Reimplemented in RooSimultaneous.

Definition at line 1790 of file RooAbsPdf.cxx.

◆ getAllConstraints()

std::unique_ptr< RooArgSet > RooAbsPdf::getAllConstraints ( const RooArgSet & observables,
RooArgSet & constrainedParams,
bool stripDisconnected = true ) const
inherited

This helper function finds and collects all constraints terms of all component p.d.f.s and returns a RooArgSet with all those terms.

Definition at line 2563 of file RooAbsPdf.cxx.

◆ getAnalyticalIntegral()

int RooEfficiency::getAnalyticalIntegral ( RooArgSet & allVars,
RooArgSet & analVars,
const char * rangeName = nullptr ) const
overridevirtual

Interface function getAnalyticalIntergral advertises the analytical integrals that are supported.

'integSet' is the set of dependents for which integration is requested. The function should copy the subset of dependents it can analytically integrate to anaIntSet and return a unique identification code for this integration configuration. If no integration can be performed, zero should be returned.

Reimplemented from RooAbsReal.

Definition at line 79 of file RooEfficiency.cxx.

◆ getAnalyticalIntegralWN()

Int_t RooAbsReal::getAnalyticalIntegralWN ( RooArgSet & allDeps,
RooArgSet & analDeps,
const RooArgSet * normSet,
const char * rangeName = nullptr ) const
virtualinherited

Variant of getAnalyticalIntegral that is also passed the normalization set that should be applied to the integrand of which the integral is requested.

For certain operator p.d.f it is useful to overload this function rather than analyticalIntegralWN() as the additional normalization information may be useful in determining a more efficient decomposition of the requested integral.

Reimplemented in ParamHistFunc, PiecewiseInterpolation, RooAbsAnaConvPdf, RooAbsCachedPdf, RooAbsCachedReal, RooAddModel, RooAddPdf, RooBinSamplingPdf, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooLagrangianMorphFunc, RooParamHistFunc, RooProdPdf, RooProduct, RooProjectedPdf, RooRealSumFunc, RooRealSumPdf, RooSimultaneous, and RooWrapperPdf.

Definition at line 348 of file RooAbsReal.cxx.

◆ getAttribute()

bool RooAbsArg::getAttribute ( const Text_t * name) const
inherited

Check if a named attribute is set. By default, all attributes are unset.

Definition at line 243 of file RooAbsArg.cxx.

◆ getCache()

RooAbsCache * RooAbsArg::getCache ( Int_t index) const
inherited

Return registered cache object by index.

Definition at line 1902 of file RooAbsArg.cxx.

◆ getComponents()

RooFit::OwningPtr< RooArgSet > RooAbsArg::getComponents ( ) const
inherited

Create a RooArgSet with all components (branch nodes) of the expression tree headed by this object.

Definition at line 675 of file RooAbsArg.cxx.

◆ getConstraints()

virtual std::unique_ptr< RooArgSet > RooAbsPdf::getConstraints ( const RooArgSet & ,
RooArgSet const & ,
RooArgSet &  ) const
inlinevirtualinherited

Reimplemented in RooProdPdf.

Definition at line 161 of file RooAbsPdf.h.

◆ getCorrection()

double RooAbsPdf::getCorrection ( ) const
virtualinherited

This function returns the penalty term.

Penalty terms modify the likelihood,during model parameter estimation.This penalty term is usually

Reimplemented in RooFit::Detail::RooNormalizedPdf, and RooMultiPdf.

Definition at line 613 of file RooAbsPdf.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ getForceNumInt()

bool RooAbsReal::getForceNumInt ( ) const
inlineinherited

Definition at line 180 of file RooAbsReal.h.

◆ getGenerator()

Int_t RooAbsPdf::getGenerator ( const RooArgSet & directVars,
RooArgSet & generateVars,
bool staticInitOK = true ) const
virtualinherited

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.

A code of zero indicates that we cannot generate any of the directVars (in this case, nothing should be added to generatedVars). Any non-zero codes will be passed to our generateEvent() implementation, but otherwise its value is arbitrary. The default implementation of this method returns zero. Subclasses will usually implement this method using the matchArgs() methods to advertise the algorithms they provide.

Reimplemented in RooAddModel, RooBCPEffDecay, RooBCPGenDecay, RooBDecay, RooBinSamplingPdf, RooBMixDecay, RooDecay, RooGamma, RooGaussian, RooGaussModel, RooGExpModel, RooJohnson, RooLandau, RooLognormal, RooMultiVarGaussian, RooNonCPEigenDecay, RooPoisson, RooProdPdf, RooTruthModel, and RooUniform.

Definition at line 1513 of file RooAbsPdf.cxx.

◆ getGeneratorConfig()

const RooNumGenConfig * RooAbsPdf::getGeneratorConfig ( ) const
inherited

Return the numeric MC generator configuration used for this object.

If a specialized configuration was associated with this object, that configuration is returned, otherwise the default configuration for all RooAbsReals is returned

Definition at line 2649 of file RooAbsPdf.cxx.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ getIntegratorConfig() [1/2]

RooNumIntConfig * RooAbsReal::getIntegratorConfig ( )
inherited

Return the numeric integration configuration used for this object.

If a specialized configuration was associated with this object, that configuration is returned, otherwise the default configuration for all RooAbsReals is returned

Definition at line 3231 of file RooAbsReal.cxx.

◆ getIntegratorConfig() [2/2]

const RooNumIntConfig * RooAbsReal::getIntegratorConfig ( ) const
inherited

Return the numeric integration configuration used for this object.

If a specialized configuration was associated with this object, that configuration is returned, otherwise the default configuration for all RooAbsReals is returned

Definition at line 3219 of file RooAbsReal.cxx.

◆ getLogProbabilities()

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

Definition at line 663 of file RooAbsPdf.cxx.

◆ getLogVal()

double RooAbsPdf::getLogVal ( const RooArgSet * set = nullptr) const
virtualinherited

Return the log of the current value with given normalization An error message is printed if the argument of the log is negative.

Reimplemented in RooHistConstraint, RooLegacyExpPoly, and RooMultiPdf.

Definition at line 605 of file RooAbsPdf.cxx.

◆ getMaxVal()

Int_t RooAbsReal::getMaxVal ( const RooArgSet & vars) const
virtualinherited

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 in RooBinSamplingPdf, RooCBShape, RooCrystalBall, RooFFTConvPdf, RooHistFunc, RooHistPdf, RooKeysPdf, RooLegendre, RooSpHarmonic, RooStudentT, and RooWrapperPdf.

Definition at line 3282 of file RooAbsReal.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ getNorm() [1/2]

double RooAbsPdf::getNorm ( const RooArgSet & nset) const
inlineinherited

Get normalisation term needed to normalise the raw values returned by getVal().

Note that getVal(normalisationVariables) will automatically apply the normalisation term returned here.

Parameters
nsetSet of variables to normalise over.

Definition at line 191 of file RooAbsPdf.h.

◆ getNorm() [2/2]

double RooAbsPdf::getNorm ( const RooArgSet * nset = nullptr) const
virtualinherited

Get normalisation term needed to normalise the raw values returned by getVal().

Note that getVal(normalisationVariables) will automatically apply the normalisation term returned here.

Parameters
nsetSet of variables to normalise over.

Reimplemented in RooResolutionModel.

Definition at line 400 of file RooAbsPdf.cxx.

◆ getNormIntegral()

const RooAbsReal * RooAbsPdf::getNormIntegral ( const RooArgSet & nset) const
inlineinherited

Definition at line 251 of file RooAbsPdf.h.

◆ getNormObj()

const RooAbsReal * RooAbsPdf::getNormObj ( const RooArgSet * set,
const RooArgSet * iset,
const TNamed * rangeName = nullptr ) const
virtualinherited

Return pointer to RooAbsReal object that implements calculation of integral over observables iset in range rangeName, optionally taking the integrand normalized over observables nset.

Definition at line 424 of file RooAbsPdf.cxx.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ getObservables() [1/5]

bool RooAbsArg::getObservables ( const RooAbsCollection * dataList,
RooArgSet & outputSet,
bool valueOnly = true ) const
inherited

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.

Returns true only if something went wrong. The complement of this function is getParameters().

Parameters
[in]dataListSet of leaf nodes to match.
[out]outputSetOutput set.
[in]valueOnlyIf this parameter is true, we only match leaves that depend on the value of any arg in dataList.

Definition at line 644 of file RooAbsArg.cxx.

◆ getObservables() [2/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getObservables ( const RooAbsData & data) const
inherited

Return the observables of this pdf given the observables defined by data.

Definition at line 602 of file RooAbsArg.cxx.

◆ getObservables() [3/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getObservables ( const RooAbsData * set) const
inherited

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

The caller of this function is responsible for deleting the returned argset. The complement of this function is getParameters().

Definition at line 613 of file RooAbsArg.cxx.

◆ getObservables() [4/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getObservables ( const RooArgSet & set,
bool valueOnly = true ) const
inherited

Given a set of possible observables, return the observables that this PDF depends on.

Definition at line 596 of file RooAbsArg.cxx.

◆ getObservables() [5/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getObservables ( const RooArgSet * dataList,
bool valueOnly = true ) const
inherited

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.

The caller of this function is responsible for deleting the returned argset. The complement of this function is getParameters().

Definition at line 627 of file RooAbsArg.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ getParameters() [1/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getParameters ( const RooAbsData & data,
bool stripDisconnected = true ) const
inherited

Return the parameters of this p.d.f when used in conjunction with dataset 'data'.

Definition at line 515 of file RooAbsArg.cxx.

◆ getParameters() [2/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getParameters ( const RooAbsData * set,
bool stripDisconnected = true ) const
inherited

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

The caller of this function is responsible for deleting the returned argset. The complement of this function is getObservables()

Definition at line 509 of file RooAbsArg.cxx.

◆ getParameters() [3/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getParameters ( const RooArgSet & observables,
bool stripDisconnected = true ) const
inherited

Return the parameters of the p.d.f given the provided set of observables.

Definition at line 521 of file RooAbsArg.cxx.

◆ getParameters() [4/5]

RooFit::OwningPtr< RooArgSet > RooAbsArg::getParameters ( const RooArgSet * observables,
bool stripDisconnected = true ) const
inherited

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.

The caller of this function is responsible for deleting the returned argset. The complement of this function is getObservables().

Definition at line 532 of file RooAbsArg.cxx.

◆ getParameters() [5/5]

bool RooAbsArg::getParameters ( const RooArgSet * observables,
RooArgSet & outputSet,
bool stripDisconnected = true ) const
virtualinherited

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.

Returns true only if something went wrong. The complement of this function is getObservables().

Parameters
[in]observablesSet of leaves to ignore because they are observables and not parameters.
[out]outputSetOutput set.
[in]stripDisconnectedAllow pdf to strip parameters from list before adding it.

Reimplemented in RooStats::HistFactory::RooBarlowBeestonLL, and ROOT::Experimental::XRooFit::ProgressMonitor.

Definition at line 583 of file RooAbsArg.cxx.

◆ getParametersHook()

virtual void RooAbsArg::getParametersHook ( const RooArgSet * ,
RooArgSet * ,
bool  ) const
inlineprotectedvirtualinherited

Reimplemented in RooMultiPdf, and RooMultiReal.

Definition at line 533 of file RooAbsArg.h.

◆ getPlotLabel()

const char * RooAbsReal::getPlotLabel ( ) const
inherited

Get the label associated with the variable.

Definition at line 403 of file RooAbsReal.cxx.

◆ getPropagatedError()

double RooAbsReal::getPropagatedError ( const RooFitResult & fr,
const RooArgSet & nset = {} ) const
inherited

Propagates parameter uncertainties to an uncertainty estimate for this RooAbsReal.

Estimates the uncertainty \(\sigma_f(x;\theta)\) on a function \(f(x;\theta)\) represented by this RooAbsReal. Here, \(\theta\) is a vector of parameters with uncertainties \(\sigma_\theta\), and \(x\) are usually observables. The uncertainty is estimated by linearly propagating the parameter uncertainties using the correlation matrix from a fit result.

The square of the uncertainty on \(f(x;\theta)\) is calculated as follows:

\[ \sigma_f(x)^2 = \Delta f_i(x) \cdot \mathrm{Corr}_{i, j} \cdot \Delta f_j(x), \]

where \( \Delta f_i(x) = \frac{1}{2} \left(f(x;\theta_i + \sigma_{\theta_i}) - f(x; \theta_i - \sigma_{\theta_i}) \right) \) is the vector of function variations when changing the parameters one at a time, and \( \mathrm{Corr}_{i,j} = \left(\sigma_{\theta_i} \sigma_{\theta_j}\right)^{-1} \cdot \mathrm{Cov}_{i,j} \) is the correlation matrix from the fit result.

Definition at line 2432 of file RooAbsReal.cxx.

◆ getProxy()

RooAbsProxy * RooAbsArg::getProxy ( Int_t index) const
inherited

Return the nth proxy from the proxy list.

Definition at line 1271 of file RooAbsArg.cxx.

◆ getStringAttribute()

const Text_t * RooAbsArg::getStringAttribute ( const Text_t * key) const
inherited

Get string attribute mapped under key 'key'.

Returns null pointer if no attribute exists under that key

Definition at line 269 of file RooAbsArg.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ getTitle()

TString RooAbsReal::getTitle ( bool appendUnit = false) const
inherited

Return this variable's title string.

If appendUnit is true and this variable has units, also append a string " (<unit>)".

Definition at line 282 of file RooAbsReal.cxx.

◆ getTransientAttribute()

bool RooAbsArg::getTransientAttribute ( const Text_t * name) const
inherited

Check if a named attribute is set.

By default, all attributes are unset.

Definition at line 295 of file RooAbsArg.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ getUnit()

const Text_t * RooAbsReal::getUnit ( ) const
inlineinherited

Definition at line 149 of file RooAbsReal.h.

◆ getVal() [1/3]

double RooAbsReal::getVal ( const RooArgSet & normalisationSet) const
inlineinherited

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

Definition at line 130 of file RooAbsReal.h.

◆ getVal() [2/3]

double RooAbsReal::getVal ( const RooArgSet * normalisationSet = nullptr) const
inlineinherited

Evaluate object.

Returns either cached value or triggers a recalculation. The recalculation happens by calling getValV(), which in the end calls the virtual evaluate() functions of the respective PDFs.

Parameters
[in]normalisationSetgetValV() reacts differently depending on the value of the normalisation set. If the set is nullptr, an unnormalised value is returned.
Note
The normalisation is arbitrary, because it is up to the implementation of the PDF to e.g. leave out normalisation constants for speed reasons. The range of the variables is also ignored.

To normalise the result properly, a RooArgSet has to be passed, which contains the variables to normalise over. These are integrated over their current ranges to compute the normalisation constant, and the unnormalised result is divided by this value.

Definition at line 107 of file RooAbsReal.h.

◆ getVal() [3/3]

double RooAbsReal::getVal ( RooArgSet && ) const
inherited

Calling RooAbsReal::getVal() with an r-value reference is a common performance trap, because this usually happens when implicitly constructing the RooArgSet to be used as the parameter (for example, in calls like pdf.getVal(x)).

Creating the RooArgSet can cause quite some overhead, especially when the evaluated object is just a simple variable. Even worse, many RooFit objects internally cache information using the uniqueId() of the normalization set as the key. So by constructing normalization sets in place, RooFits caching logic is broken.

To avoid these kind of problems, getVal() will just throw an error when it's called with an r-value reference. This also catches the cases where one uses it in Python, implicitly creating the normalization set from a Python list or set.

Definition at line 4265 of file RooAbsReal.cxx.

◆ getValV()

double RooAbsPdf::getValV ( const RooArgSet * nset = nullptr) const
overridevirtualinherited

Return current value, normalized by integrating over the observables in nset.

If nset is 0, the unnormalized value is returned. All elements of nset must be lvalues.

Unnormalized values are not cached. Doing so would be complicated as _norm->getVal() could spoil the cache and interfere with returning the cached return value. Since unnormalized calls are typically done in integration calls, there is no performance hit.

Reimplemented from RooAbsReal.

Reimplemented in RooAddPdf, RooFit::Detail::RooNormalizedPdf, RooMomentMorph, and RooResolutionModel.

Definition at line 300 of file RooAbsPdf.cxx.

◆ getVariables()

RooFit::OwningPtr< RooArgSet > RooAbsArg::getVariables ( bool stripDisconnected = true) const
inherited

Return RooArgSet with all variables (tree leaf nodes of expression tree).

Definition at line 1909 of file RooAbsArg.cxx.

◆ globalSelectComp()

void RooAbsReal::globalSelectComp ( bool flag)
staticprotectedinherited

Global switch controlling the activation of the selectComp() functionality.

Definition at line 2952 of file RooAbsReal.cxx.

◆ gradient()

virtual void RooAbsReal::gradient ( double * ) const
inlinevirtualinherited

Definition at line 386 of file RooAbsReal.h.

◆ graphVizAddConnections()

void RooAbsArg::graphVizAddConnections ( std::set< std::pair< RooAbsArg *, RooAbsArg * > > & linkSet)
protectedinherited

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.

Definition at line 2000 of file RooAbsArg.cxx.

◆ graphVizTree() [1/2]

void RooAbsArg::graphVizTree ( const char * fileName,
const char * delimiter = "\n",
bool useTitle = false,
bool useLatex = false )
inherited

Create a GraphViz .dot file visualizing the expression tree headed by this RooAbsArg object.

Use the GraphViz tool suite to make e.g. a gif or ps file from the .dot file. If a node derives from RooAbsReal, its current (unnormalised) value is printed as well.

Based on concept developed by Kyle Cranmer.

Definition at line 1922 of file RooAbsArg.cxx.

◆ graphVizTree() [2/2]

void RooAbsArg::graphVizTree ( std::ostream & os,
const char * delimiter = "\n",
bool useTitle = false,
bool useLatex = false )
inherited

Write the GraphViz representation of the expression tree headed by this RooAbsArg object to the given ostream.

If a node derives from RooAbsReal, its current (unnormalised) value is printed as well.

Based on concept developed by Kyle Cranmer.

Definition at line 1940 of file RooAbsArg.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ hasClients()

bool RooAbsArg::hasClients ( ) const
inlineinherited

Definition at line 128 of file RooAbsArg.h.

◆ hasDataToken()

bool RooAbsArg::hasDataToken ( ) const
inlineinherited

Definition at line 636 of file RooAbsArg.h.

◆ hasGradient()

virtual bool RooAbsReal::hasGradient ( ) const
inlinevirtualinherited

Definition at line 384 of file RooAbsReal.h.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
Error("WriteTObject","The current directory (%s) is not associated with a file. The object (%s) has not been written.", GetName(), objname)
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
Mother of all ROOT objects.
Definition TObject.h:42
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ hasHessian()

virtual bool RooAbsReal::hasHessian ( ) const
inlinevirtualinherited

Definition at line 385 of file RooAbsReal.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

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

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ hasRange()

virtual bool RooAbsArg::hasRange ( const char * ) const
inlinevirtualinherited

Reimplemented in RooAbsRealLValue, RooCategory, and RooSuperCategory.

Definition at line 305 of file RooAbsArg.h.

◆ hessian()

virtual void RooAbsReal::hessian ( double * ) const
inlinevirtualinherited

Definition at line 389 of file RooAbsReal.h.

◆ hideOffset()

bool RooAbsReal::hideOffset ( )
staticinherited

Definition at line 189 of file RooAbsReal.cxx.

◆ importWorkspaceHook()

virtual bool RooAbsArg::importWorkspaceHook ( RooWorkspace & ws)
inlinevirtualinherited

Reimplemented in RooHistFunc, and RooHistPdf.

Definition at line 507 of file RooAbsArg.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ inhibitDirty()

bool RooAbsArg::inhibitDirty ( ) const
protectedinherited

Definition at line 100 of file RooAbsArg.cxx.

◆ initGenerator()

void RooAbsPdf::initGenerator ( Int_t code)
virtualinherited

Interface for one-time initialization to setup the generator for the specified code.

Reimplemented in RooBCPEffDecay, RooBCPGenDecay, RooBinSamplingPdf, RooBMixDecay, RooMultiVarGaussian, RooNonCPEigenDecay, RooProdPdf, and RooProjectedPdf.

Definition at line 1523 of file RooAbsPdf.cxx.

◆ inRange()

virtual bool RooAbsArg::inRange ( const char * ) const
inlinevirtualinherited

Reimplemented in RooAbsRealLValue, RooCategory, and RooSuperCategory.

Definition at line 300 of file RooAbsArg.h.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ integralNameSuffix()

TString RooAbsReal::integralNameSuffix ( const RooArgSet & iset,
const RooArgSet * nset = nullptr,
const char * rangeName = nullptr,
bool omitEmpty = false ) const
protectedinherited

Construct string with unique suffix name to give to integral object that encodes integrated observables, normalization observables and the integration range name.

Definition at line 752 of file RooAbsReal.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ ioStreamerPass2()

void RooAbsArg::ioStreamerPass2 ( )
protectedvirtualinherited

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

A second pass is typically needed when evolving data member of RooAbsArg-derived classes that are container classes with references to other members, which may not yet be 'live' in the first ioStreamer() evolution pass.

Classes may overload this function, but must call the base method in the overloaded call to ensure base evolution is handled properly

Reimplemented in RooHistFunc, and RooProduct.

Definition at line 2145 of file RooAbsArg.cxx.

◆ ioStreamerPass2Finalize()

void RooAbsArg::ioStreamerPass2Finalize ( )
staticprotectedinherited

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

This static finalize method is called after ioStreamerPass2() is called on each directly listed object in the workspace. It's purpose is to complete schema evolution of any objects in the workspace that are not directly listed as content elements (e.g. analytical convolution tokens )

Definition at line 2169 of file RooAbsArg.cxx.

◆ IsA()

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

Reimplemented from RooAbsPdf.

Definition at line 50 of file RooEfficiency.h.

◆ isActiveNormSet()

bool RooAbsPdf::isActiveNormSet ( RooArgSet const * normSet) const
inlineprotectedinherited

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

Definition at line 295 of file RooAbsPdf.h.

◆ isBinnedDistribution()

virtual bool RooAbsReal::isBinnedDistribution ( const RooArgSet & ) const
inlinevirtualinherited

Tests if the distribution is binned. Unless overridden by derived classes, this always returns false.

Reimplemented in ParamHistFunc, PdfWrapper, PiecewiseInterpolation, RooAddition, RooAddPdf, RooBinSamplingPdf, RooBinWidthFunction, RooHistFunc, RooHistPdf, RooLagrangianMorphFunc, RooMomentMorphFunc, RooParamHistFunc, RooProdPdf, RooProduct, RooRealSumFunc, RooRealSumPdf, and RooWrapperPdf.

Definition at line 343 of file RooAbsReal.h.

◆ isCategory()

virtual bool RooAbsArg::isCategory ( ) const
inlinevirtualinherited

Reimplemented in RooAbsCategory.

Definition at line 521 of file RooAbsArg.h.

◆ isConstant()

bool RooAbsArg::isConstant ( ) const
inlineinherited

Check if the "Constant" attribute is set.

Definition at line 283 of file RooAbsArg.h.

◆ isDerived()

virtual bool RooAbsArg::isDerived ( ) const
inlinevirtualinherited

Does value or shape of this arg depend on any other arg?

Reimplemented in RooCategory, RooConstVar, and RooRealVar.

Definition at line 97 of file RooAbsArg.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ isDirectGenSafe()

bool RooAbsPdf::isDirectGenSafe ( const RooAbsArg & arg) const
virtualinherited

Check if given observable can be safely generated using the pdfs internal generator mechanism (if that existsP).

Observables on which a PDF depends via more than route are not safe for use with internal generators because they introduce correlations not known to the internal generator

Reimplemented in RooAbsAnaConvPdf, RooAddModel, RooBinSamplingPdf, and RooProdPdf.

Definition at line 1548 of file RooAbsPdf.cxx.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

◆ isFundamental()

virtual bool RooAbsArg::isFundamental ( ) const
inlinevirtualinherited

Is this object a fundamental type that can be added to a dataset?

Fundamental-type subclasses override this method to return true. Note that this test is subtlely different from the dynamic isDerived() test, e.g. a constant is not derived but is also not fundamental.

Reimplemented in RooCategory, RooErrorVar, RooRealVar, and RooStringVar.

Definition at line 175 of file RooAbsArg.h.

◆ isIdentical()

bool RooAbsReal::isIdentical ( const RooAbsArg & other,
bool assumeSameType = false ) const
overridevirtualinherited

Implements RooAbsArg.

Definition at line 267 of file RooAbsReal.cxx.

◆ isLValue()

virtual bool RooAbsArg::isLValue ( ) const
inlinevirtualinherited

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.

Reimplemented in RooAbsCategoryLValue, and RooAbsRealLValue.

Definition at line 185 of file RooAbsArg.h.

◆ isOffsetting()

virtual bool RooAbsReal::isOffsetting ( ) const
inlinevirtualinherited

Definition at line 367 of file RooAbsReal.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ isReducerNode()

virtual bool RooAbsArg::isReducerNode ( ) const
inlinevirtualinherited

Definition at line 514 of file RooAbsArg.h.

◆ isSelectedComp()

bool RooAbsReal::isSelectedComp ( ) const
inherited

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

Definition at line 2942 of file RooAbsReal.cxx.

◆ isShapeDirty()

bool RooAbsArg::isShapeDirty ( ) const
inlineinherited

Definition at line 350 of file RooAbsArg.h.

◆ isShapeServer() [1/2]

bool RooAbsArg::isShapeServer ( const char * name) const
inlineinherited

Check if this is serving shape to an object with name name.

Definition at line 163 of file RooAbsArg.h.

◆ isShapeServer() [2/2]

bool RooAbsArg::isShapeServer ( const RooAbsArg & arg) const
inlineinherited

Check if this is serving shape to arg.

Definition at line 161 of file RooAbsArg.h.

◆ IsSortable()

bool RooAbsArg::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Definition at line 290 of file RooAbsArg.h.

◆ isValid()

bool RooAbsReal::isValid ( ) const
inlineoverrideprotectedvirtualinherited

Check if current value is valid.

Reimplemented from RooAbsArg.

Reimplemented in RooRealIntegral.

Definition at line 445 of file RooAbsReal.h.

◆ isValidReal()

virtual bool RooAbsReal::isValidReal ( double ,
bool printError = false ) const
inlineprotectedvirtualinherited

Interface function to check if given value is a valid value for this object. Returns true unless overridden.

Reimplemented in RooAbsRealLValue, RooFormulaVar, RooGenericPdf, and RooRealIntegral.

Definition at line 447 of file RooAbsReal.h.

◆ isValueDirty()

bool RooAbsArg::isValueDirty ( ) const
inlineinherited

Definition at line 356 of file RooAbsArg.h.

◆ isValueDirtyAndClear()

bool RooAbsArg::isValueDirtyAndClear ( ) const
inlineinherited

Definition at line 372 of file RooAbsArg.h.

◆ isValueOrShapeDirtyAndClear()

bool RooAbsArg::isValueOrShapeDirtyAndClear ( ) const
inlineinherited

Definition at line 390 of file RooAbsArg.h.

◆ isValueServer() [1/2]

bool RooAbsArg::isValueServer ( const char * name) const
inlineinherited

Check if this is serving values to an object with name name.

Definition at line 159 of file RooAbsArg.h.

◆ isValueServer() [2/2]

bool RooAbsArg::isValueServer ( const RooAbsArg & arg) const
inlineinherited

Check if this is serving values to arg.

Definition at line 157 of file RooAbsArg.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ leafNodeServerList()

void RooAbsArg::leafNodeServerList ( RooAbsCollection * list,
const RooAbsArg * arg = nullptr,
bool recurseNonDerived = false ) const
inherited

Fill supplied list with all leaf nodes of the arg tree, starting with ourself as top node.

A leaf node is node that has no servers declared.

Definition at line 443 of file RooAbsArg.cxx.

◆ localNoDirtyInhibit()

bool RooAbsArg::localNoDirtyInhibit ( ) const
inlineinherited

Definition at line 632 of file RooAbsArg.h.

◆ logBatchComputationErrors()

void RooAbsPdf::logBatchComputationErrors ( std::span< const double > & outputs,
std::size_t begin ) const
privateinherited

Scan through outputs and fix+log all nans and negative values.

Parameters
[in,out]outputsArray to be scanned & fixed.
[in]beginBegin of event range. Only needed to print the correct event number where the error occurred.

Definition at line 646 of file RooAbsPdf.cxx.

◆ logEvalError() [1/2]

void RooAbsReal::logEvalError ( const char * message,
const char * serverValueString = nullptr ) const
inherited

Log evaluation error message.

Evaluation errors may be routed through a different protocol than generic RooFit warning message (which go straight through RooMsgService) because evaluation errors can occur in very large numbers in the use of likelihood evaluations. In logEvalError mode, controlled by global method enableEvalErrorLogging() messages reported through this function are not printed but all stored in a list, along with server values at the time of reporting. Error messages logged in this way can be printed in a structured way, eliminating duplicates and with the ability to truncate the list by printEvalErrors. This is the standard mode of error logging during MINUIT operations. If enableEvalErrorLogging() is false, all errors reported through this method are passed for immediate printing through RooMsgService. A string with server names and values is constructed automatically for error logging purposes, unless a custom string with similar information is passed as argument.

Definition at line 3358 of file RooAbsReal.cxx.

◆ logEvalError() [2/2]

void RooAbsReal::logEvalError ( const RooAbsReal * originator,
const char * origName,
const char * message,
const char * serverValueString = nullptr )
staticinherited

Interface to insert remote error logging messages received by RooRealMPFE into current error logging stream.

Definition at line 3302 of file RooAbsReal.cxx.

◆ ls()

void TNamed::ls ( Option_t * option = "") const
overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

◆ makeLegacyIterator()

RooAbsArg::RefCountListLegacyIterator_t * RooAbsArg::makeLegacyIterator ( const RefCountList_t & list) const
privateinherited

Definition at line 2185 of file RooAbsArg.cxx.

◆ makeProjectionSet()

void RooAbsReal::makeProjectionSet ( const RooAbsArg * plotVar,
const RooArgSet * allVars,
RooArgSet & projectedVars,
bool silent ) const
protectedinherited

Utility function for plotOn() that constructs the set of observables to project when plotting ourselves as function of 'plotVar'.

'allVars' is the list of variables that must be projected, but may contain variables that we do not depend on. If 'silent' is cleared, warnings about inconsistent input parameters will be printed.

Definition at line 2889 of file RooAbsReal.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ matchArgs() [1/2]

template<typename... Proxies>
bool RooAbsReal::matchArgs ( const RooArgSet & allDeps,
RooArgSet & analDeps,
const RooArgProxy & a,
const Proxies &... proxies ) const
inlineprotectedinherited

Definition at line 425 of file RooAbsReal.h.

◆ matchArgs() [2/2]

bool RooAbsReal::matchArgs ( const RooArgSet & allDeps,
RooArgSet & analDeps,
const RooArgSet & refset ) const
protectedinherited

Utility function for use in getAnalyticalIntegral().

If the contents of 'refset' occur in set 'allDeps' then the arguments held in 'refset' are copied from allDeps to analDeps.

Definition at line 3131 of file RooAbsReal.cxx.

◆ matchArgsByName()

bool RooAbsReal::matchArgsByName ( const RooArgSet & allArgs,
RooArgSet & matchedArgs,
const TList & nameList ) const
protectedinherited

Check if allArgs contains matching elements for each name in nameList.

If it does, add the corresponding args from allArgs to matchedArgs and return true. Otherwise return false and do not change matchedArgs.

Definition at line 3151 of file RooAbsReal.cxx.

◆ maxVal()

double RooAbsReal::maxVal ( Int_t code) const
virtualinherited

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

Reimplemented in RooBinSamplingPdf, RooCBShape, RooCrystalBall, RooFFTConvPdf, RooHistFunc, RooHistPdf, RooKeysPdf, RooLegendre, RooSpHarmonic, RooStudentT, and RooWrapperPdf.

Definition at line 3291 of file RooAbsReal.cxx.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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

Definition at line 1160 of file TObject.cxx.

◆ mean() [1/2]

RooAbsMoment * RooAbsReal::mean ( RooRealVar & obs)
inlineinherited

Definition at line 356 of file RooAbsReal.h.

◆ mean() [2/2]

RooAbsMoment * RooAbsReal::mean ( RooRealVar & obs,
const RooArgSet & nset )
inlineinherited

Definition at line 357 of file RooAbsReal.h.

◆ minTrialSamples()

virtual Int_t RooAbsReal::minTrialSamples ( const RooArgSet & ) const
inlinevirtualinherited

Reimplemented in RooBinSamplingPdf, and RooWrapperPdf.

Definition at line 238 of file RooAbsReal.h.

◆ moment() [1/2]

RooAbsMoment * RooAbsReal::moment ( RooRealVar & obs,
const RooArgSet & normObs,
Int_t order,
bool central,
bool takeRoot,
bool intNormObs )
inherited

Return function representing moment of p.d.f (normalized w.r.t given observables) of given order.

Parameters
[in]obsObservable to calculate the moments for
[in]normObsNormalise w.r.t. these observables
[in]orderOrder of the moment
[in]centralIf true, the central moment is given by \( \langle (x- \langle x \rangle )^2 \rangle \)
[in]takeRootCalculate the square root
[in]intNormObsIf true, the moment of the function integrated over all normalization observables is returned.

Definition at line 3922 of file RooAbsReal.cxx.

◆ moment() [2/2]

RooAbsMoment * RooAbsReal::moment ( RooRealVar & obs,
Int_t order,
bool central,
bool takeRoot )
inherited

Return function representing moment of function of given order.

Parameters
[in]obsObservable to calculate the moments for
[in]orderOrder of the moment
[in]centralIf true, the central moment is given by \( \langle (x- \langle x \rangle )^2 \rangle \)
[in]takeRootCalculate the square root

Definition at line 3903 of file RooAbsReal.cxx.

◆ mustBeExtended()

bool RooAbsPdf::mustBeExtended ( ) const
inlineinherited

If true PDF must provide extended likelihood term.

Definition at line 218 of file RooAbsPdf.h.

◆ nameFieldLength()

void RooPrintable::nameFieldLength ( Int_t newLen)
staticinherited

Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.

Definition at line 59 of file RooPrintable.cxx.

◆ namePtr()

const TNamed * RooAbsArg::namePtr ( ) const
inlineinherited

De-duplicated pointer to this object's name.

This can be used for fast name comparisons. like if (namePtr() == other.namePtr()).

Note
TNamed::GetName() will return a pointer that's different for each object, but namePtr() always points to a unique instance.

Definition at line 502 of file RooAbsArg.h.

◆ normRange()

const char * RooAbsPdf::normRange ( ) const
inlineinherited

Definition at line 246 of file RooAbsPdf.h.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

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

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ numCaches()

Int_t RooAbsArg::numCaches ( ) const
inherited

Return number of registered caches.

Definition at line 1895 of file RooAbsArg.cxx.

◆ numEvalErrorItems()

Int_t RooAbsReal::numEvalErrorItems ( )
staticinherited

Definition at line 174 of file RooAbsReal.cxx.

◆ numEvalErrors()

Int_t RooAbsReal::numEvalErrors ( )
staticinherited

Return the number of logged evaluation errors since the last clearing.

Definition at line 3518 of file RooAbsReal.cxx.

◆ numProxies()

Int_t RooAbsArg::numProxies ( ) const
inherited

Return the number of registered proxies.

Definition at line 1281 of file RooAbsArg.cxx.

◆ observableOverlaps() [1/2]

bool RooAbsArg::observableOverlaps ( const RooAbsData * dset,
const RooAbsArg & testArg ) const
inherited

Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg.

Definition at line 775 of file RooAbsArg.cxx.

◆ observableOverlaps() [2/2]

bool RooAbsArg::observableOverlaps ( const RooArgSet * depList,
const RooAbsArg & testArg ) const
inherited

Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg.

Definition at line 783 of file RooAbsArg.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ offset()

virtual double RooAbsReal::offset ( ) const
inlinevirtualinherited

Definition at line 368 of file RooAbsReal.h.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 192 of file TObject.h.

◆ operator==() [1/2]

bool RooAbsReal::operator== ( const RooAbsArg & other) const
overridevirtualinherited

Equality operator when comparing to another RooAbsArg.

Only functional when the other arg is a RooAbsReal

Implements RooAbsArg.

Definition at line 258 of file RooAbsReal.cxx.

◆ operator==() [2/2]

bool RooAbsReal::operator== ( double value) const
inherited

Equality operator comparing to a double.

Definition at line 247 of file RooAbsReal.cxx.

◆ operMode()

OperMode RooAbsArg::operMode ( ) const
inlineinherited

Query the operation mode of this node.

Definition at line 419 of file RooAbsArg.h.

◆ operModeHook()

virtual void RooAbsArg::operModeHook ( )
inlineprotectedvirtualinherited

Reimplemented in RooCachedReal.

Definition at line 526 of file RooAbsArg.h.

◆ optimizeCacheMode() [1/2]

void RooAbsArg::optimizeCacheMode ( const RooArgSet & observables)
virtualinherited

Activate cache mode optimization with given definition of observables.

The cache operation mode of all objects in the expression tree will modified such that all nodes that depend directly or indirectly on any of the listed observables will be set to ADirty, as they are expected to change every time. This save change tracking overhead for nodes that are a priori known to change every time

Definition at line 1556 of file RooAbsArg.cxx.

◆ optimizeCacheMode() [2/2]

void RooAbsArg::optimizeCacheMode ( const RooArgSet & observables,
RooArgSet & optimizedNodes,
RooLinkedList & processedNodes )
virtualinherited

Activate cache mode optimization with given definition of observables.

The cache operation mode of all objects in the expression tree will modified such that all nodes that depend directly or indirectly on any of the listed observables will be set to ADirty, as they are expected to change every time. This save change tracking overhead for nodes that are a priori known to change every time

Definition at line 1574 of file RooAbsArg.cxx.

◆ optimizeDirtyHook()

virtual void RooAbsArg::optimizeDirtyHook ( const RooArgSet * )
inlineprotectedvirtualinherited

Definition at line 528 of file RooAbsArg.h.

◆ overlaps()

bool RooAbsArg::overlaps ( const RooAbsArg & testArg,
bool valueOnly = false ) const
inherited

Test if any of the nodes of tree are shared with that of the given tree.

Definition at line 764 of file RooAbsArg.cxx.

◆ ownedComponents()

const RooArgSet * RooAbsArg::ownedComponents ( ) const
inlineinherited

Definition at line 486 of file RooAbsArg.h.

◆ Paint()

void TObject::Paint ( Option_t * option = "")
virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

◆ paramOn() [1/2]

RooPlot * RooAbsPdf::paramOn ( RooPlot * frame,
const RooArgSet & params,
bool showConstants = false,
const char * label = "",
double xmin = 0.65,
double xmax = 0.99,
double ymax = 0.95,
const RooCmdArg * formatCmd = nullptr )
privatevirtualinherited

Add a text box with the current parameter values and their errors to the frame.

Observables of this PDF appearing in the 'data' dataset will be omitted.

An optional label will be inserted if passed. Multi-line labels can be generated by adding \n to the label string. Use 'sigDigits' to modify the default number of significant digits printed. The 'xmin,xmax,ymax' values specify the initial relative position of the text box in the plot frame.

Definition at line 2341 of file RooAbsPdf.cxx.

◆ paramOn() [2/2]

RooPlot * RooAbsPdf::paramOn ( 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 = {} )
virtualinherited

Add a box with parameter values (and errors) to the specified frame.

The following named arguments are supported.

PyROOT

The RooAbsPdf::paramOn() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Type of CmdArg Effect on parameter box
Parameters(const RooArgSet& param) Only the specified subset of parameters will be shown. By default all non-constant parameters are shown.
ShowConstants(bool flag) Also display constant parameters
Format(const char* what,...) Parameter formatting options.
Parameter Format
const char* what Controls what is shown. "N" adds name (alternatively, "T" adds the title), "E" adds error, "A" shows asymmetric error, "U" shows unit, "H" hides the value
FixedPrecision(int n) Controls precision, set fixed number of digits
AutoPrecision(int n) Controls precision. Number of shown digits is calculated from error + n specified additional digits (1 is sensible default)
Label(const chat* label) Add label to parameter box. Use \n for multi-line labels.
Layout(double xmin, double xmax, double ymax) Specify relative position of left/right side of box and top of box. Coordinates are given as position on the pad between 0 and 1. The lower end of the box is calculated automatically from the number of lines in the box.

Example use:

pdf.paramOn(frame, Label("fit result"), Format("NEU",AutoPrecision(1)) ) ;
static char * Format(const char *format, va_list ap)
Format a string in a circular formatting buffer (using a printf style format descriptor).
Definition TString.cxx:2449

Definition at line 2286 of file RooAbsPdf.cxx.

◆ plotAsymOn()

RooPlot * RooAbsReal::plotAsymOn ( RooPlot * frame,
const RooAbsCategoryLValue & asymCat,
PlotOpt o ) const
protectedvirtualinherited

Definition at line 2176 of file RooAbsReal.cxx.

◆ plotOn() [1/3]

RooPlot * RooAbsPdf::plotOn ( 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
inlineoverridevirtualinherited

Helper calling plotOn(RooPlot*, RooLinkedList&) const.

PyROOT

The RooAbsPdf::plotOn() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Reimplemented from RooAbsReal.

Reimplemented in RooSimultaneous.

Definition at line 116 of file RooAbsPdf.h.

◆ plotOn() [2/3]

RooPlot * RooAbsPdf::plotOn ( RooPlot * frame,
PlotOpt o ) const
overrideprotectedvirtualinherited

Plot oneself on 'frame'.

In addition to features detailed in RooAbsReal::plotOn(), the scale factor for a PDF can be interpreted in three different ways. The interpretation is controlled by ScaleType

Relative - Scale factor is applied on top of PDF normalization scale factor
NumEvent - Scale factor is interpreted as a number of events. The surface area
under the PDF curve will match that of a histogram containing the specified
number of event
Raw - Scale factor is applied to the raw (projected) probability density.
Not too useful, option provided for completeness.
#define a(i)
Definition RSha256.hxx:99

Reimplemented from RooAbsReal.

Reimplemented in RooSimultaneous.

Definition at line 2222 of file RooAbsPdf.cxx.

◆ plotOn() [3/3]

RooPlot * RooAbsPdf::plotOn ( RooPlot * frame,
RooLinkedList & cmdList ) const
overridevirtualinherited

Plot (project) PDF on specified frame.

  • If a PDF is plotted in an empty frame, it will show a unit-normalized curve in the frame variable. When projecting a multi- dimensional PDF onto the frame axis, hidden parameters are taken are taken at their current value.
  • If a PDF is plotted in a frame in which a dataset has already been plotted, it will show a projection integrated over all variables that were present in the shown dataset (except for the one on the x-axis). The normalization of the curve will be adjusted to the event count of the plotted dataset. An informational message will be printed for each projection step that is performed.
  • If a PDF is plotted in a frame showing a dataset after a fit, the above happens, but the PDF will be drawn and normalised only in the fit range. If this is not desired, plotting and normalisation range can be overridden using Range() and NormRange() as documented in the table below.

This function takes the following named arguments (for more arguments, see also RooAbsReal::plotOn(RooPlot*,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&, const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&,const RooCmdArg&, const RooCmdArg&) const )

Type of argument Controlling normalisation
NormRange(const char* name) Calculate curve normalization w.r.t. specified range[s]. See the tutorial rf212_plottingInRanges_blinding.C
Note
Setting a Range() by default also sets a NormRange() on the same range, meaning that the PDF is plotted and normalised in the same range. Overriding this can be useful if the PDF was fit in limited range[s] such as side bands, NormRange("sidebandLeft,sidebandRight"), but the PDF should be drawn in the full range, Range("").
Normalization(double scale, ScaleType code)

Adjust normalization by given scale factor. Interpretation of number depends on code: RooAbsReal::Relative: relative adjustment factor RooAbsReal::NumEvent: scale to match given number of events.

Type of argument Misc control
Name(const chat* name) Give curve specified name in frame. Useful if curve is to be referenced later
Asymmetry(const RooCategory& c) Show the asymmetry of the PDF in given two-state category \( \frac{F(+)-F(-)}{F(+)+F(-)} \) rather than the PDF projection. Category must have two states with indices -1 and +1 or three states with indices -1,0 and +1.
ShiftToZero(bool flag) Shift entire curve such that lowest visible point is at exactly zero. Mostly useful when plotting -log(L) or \( \chi^2 \) distributions
AddTo(const char* name, double_t wgtSelf, double_t wgtOther) Create a projection of this PDF onto the x-axis, but instead of plotting it directly, add it to an existing curve with given name (and relative weight factors).
Components(const char* names) When plotting sums of PDFs, plot only the named components (e.g. only the signal of a signal+background model).
Components(const RooArgSet& compSet)

As above, but pass a RooArgSet of the components themselves.

Type of argument Projection control
Slice(const RooArgSet& set) Override default projection behaviour by omitting observables listed in set from the projection, i.e. by not integrating over these. Slicing is usually only sensible in discrete observables, by e.g. creating a slice of the PDF at the current value of the category observable.
Slice(RooCategory& cat, const char* label) Override default projection behaviour by omitting the specified category observable from the projection, i.e., by not integrating over all states of this category. The slice is positioned at the given label value. Multiple Slice() commands can be given to specify slices in multiple observables, e.g.
pdf.plotOn(frame, Slice(tagCategory, "2tag"), Slice(jetCategory, "3jet"));
Project(const RooArgSet& set) Override default projection behaviour by projecting over observables given in set, completely ignoring the default projection behavior. Advanced use only.
ProjWData(const RooAbsData& d) Override default projection technique (integration). For observables present in given dataset projection of PDF is achieved by constructing an average over all observable values in given set. Consult RooFit plotting tutorial for further explanation of meaning & use of this technique
ProjWData(const RooArgSet& s, const RooAbsData& d) As above but only consider subset 's' of observables in dataset 'd' for projection through data averaging
ProjectionRange(const char* rn)

When projecting the PDF onto the plot axis, it is usually integrated over the full range of the invisible variables. The ProjectionRange overrides this. This is useful if the PDF was fitted in a limited range in y, but it is now projected onto x. If ProjectionRange("<name of fit range>") is passed, the projection is normalised correctly.

Type of argument Plotting control
LineStyle(Int_t style) Select line style by ROOT line style code, default is solid
LineColor(Int_t color) Select line color by ROOT color code, default is blue
LineWidth(Int_t width) Select line with in pixels, default is 3
FillStyle(Int_t style) Select fill style, default is not filled. If a filled style is selected, also use VLines() to add vertical downward lines at end of curve to ensure proper closure
FillColor(Int_t color) Select fill color by ROOT color code
Range(const char* name) Only draw curve in range defined by given name. Multiple comma-separated ranges can be given. An empty string "" or nullptr means to use the default range of the variable.
Range(double lo, double hi) Only draw curve in specified range
VLines() Add vertical lines to y=0 at end points of curve
Precision(double eps) Control precision of drawn curve w.r.t to scale of plot, default is 1e-3. A higher precision will result in more and more densely spaced curve points. A negative precision value will disable adaptive point spacing and restrict sampling to the grid point of points defined by the binning of the plotted observable (recommended for expensive functions such as profile likelihoods)
Invisible(bool flag) Add curve to frame, but do not display. Useful in combination AddTo()
VisualizeError(const RooFitResult& fitres, double Z=1, bool linearMethod=true) Visualize the uncertainty on the parameters, as given in fitres, at 'Z' sigma. The linear method is fast but may not be accurate in the presence of strong correlations (~>0.9) and at Z>2 due to linear and Gaussian approximations made. Intervals from the sampling method can be asymmetric, and may perform better in the presence of strong correlations, but may take (much) longer to calculate
Note
To include the uncertainty from the expected number of events, the Normalization() argument with ScaleType RooAbsReal::RelativeExpected has to be passed, e.g.
pdf.plotOn(frame, VisualizeError(fitResult), Normalization(1.0, RooAbsReal::RelativeExpected));
VisualizeError(const RooFitResult& fitres, const RooArgSet& param, double Z=1, bool linearMethod=true) Visualize the uncertainty on the subset of parameters 'param', as given in fitres, at 'Z' sigma

Reimplemented from RooAbsReal.

Reimplemented in RooSimultaneous.

Definition at line 1928 of file RooAbsPdf.cxx.

◆ plotOnCompSelect()

void RooAbsReal::plotOnCompSelect ( RooArgSet * selNodes) const
protectedinherited

Helper function for plotting of composite p.d.fs.

Given a set of selected components that should be plotted, find all nodes that (in)directly depend on these selected nodes. Mark all directly and indirectly selected nodes as 'selected' using the selectComp() method

Definition at line 1436 of file RooAbsReal.cxx.

◆ plotOnWithErrorBand()

RooPlot * RooAbsReal::plotOnWithErrorBand ( RooPlot * frame,
const RooFitResult & fr,
double Z,
const RooArgSet * params,
const RooLinkedList & argList,
bool linMethod ) const
protectedinherited

Plot function or PDF on frame with support for visualization of the uncertainty encoded in the given fit result fr.

Parameters
[in]frameRooPlot to plot on
[in]frThe RooFitResult, where errors can be extracted
[in]ZThe desired significance (width) of the error band
[in]paramsIf non-zero, consider only the subset of the parameters in fr for the error evaluation
[in]argListOptional RooCmdArg that can be applied to a regular plotOn() operation
[in]linMethodBy default (linMethod=true), a linearized error is shown.
Returns
The RooPlot the band was plotted on (for chaining of plotting commands).

The linearized error is calculated as follows:

\[ \mathrm{error}(x) = Z * F_a(x) * \mathrm{Corr}(a,a') * F_{a'}^\mathrm{T}(x), \]

where

\[ F_a(x) = \frac{ f(x,a+\mathrm{d}a) - f(x,a-\mathrm{d}a) }{2}, \]

with \( f(x) \) the plotted curve and \( \mathrm{d}a \) taken from the fit result, and \( \mathrm{Corr}(a,a') \) = the correlation matrix from the fit result, and \( Z \) = requested signifance ( \( Z \sigma \) band)

The linear method is fast (required 2*N evaluations of the curve, where N is the number of parameters), but may not be accurate in the presence of strong correlations (~>0.9) and at Z>2 due to linear and Gaussian approximations made

Alternatively, a more robust error is calculated using a sampling method. In this method a number of curves is calculated with variations of the parameter values, as drawn from a multi-variate Gaussian p.d.f. that is constructed from the fit results covariance matrix. The error(x) is determined by calculating a central interval that capture N% of the variations for each value of x, where N% is controlled by Z (i.e. Z=1 gives N=68%). The number of sampling curves is chosen to be such that at least 30 curves are expected to be outside the N% interval, and is minimally 100 (e.g. Z=1->Ncurve=100, Z=2->Ncurve=659, Z=3->Ncurve=11111) Intervals from the sampling method can be asymmetric, and may perform better in the presence of strong correlations, but may take (much) longer to calculate.

Definition at line 2573 of file RooAbsReal.cxx.

◆ plotSamplingHint()

std::list< double > * RooAbsReal::plotSamplingHint ( RooAbsRealLValue & obs,
double xlo,
double xhi ) const
virtualinherited

Interface for returning an optional hint for initial sampling points when constructing a curve projected on observable obs.

Parameters
[in]obsObservable to retrieve sampling hint for.
[in]xloBeginning of range.
[in]xhiEnd of range.
Returns
The caller owns the returned std::list.

Reimplemented in ParamHistFunc, PiecewiseInterpolation, RooAddition, RooAddPdf, RooBinSamplingPdf, RooBinWidthFunction, RooFormulaVar, RooHistFunc, RooHistPdf, RooLagrangianMorphFunc, RooLinearCombination, RooMomentMorphFunc, RooParametricStepFunction, RooParamHistFunc, RooProdPdf, RooProduct, RooRangeBoolean, RooRealIntegral, RooRealSumFunc, RooRealSumPdf, RooStepFunction, and RooWrapperPdf.

Definition at line 3465 of file RooAbsReal.cxx.

◆ plotSanityChecks()

bool RooAbsReal::plotSanityChecks ( RooPlot * frame) const
protectedinherited

Utility function for plotOn(), perform general sanity check on frame to ensure safe plotting operations.

Definition at line 2846 of file RooAbsReal.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ preferredObservableScanOrder()

void RooAbsReal::preferredObservableScanOrder ( const RooArgSet & obs,
RooArgSet & orderedObs ) const
virtualinherited

Interface method for function objects to indicate their preferred order of observables for scanning their values into a (multi-dimensional) histogram or RooDataSet.

The observables to be ordered are offered in argument 'obs' and should be copied in their preferred order into argument 'orderedObs', This default implementation indicates no preference and copies the original order of 'obs' into 'orderedObs'

Reimplemented in RooCachedPdf, and RooIntegralMorph.

Definition at line 3584 of file RooAbsReal.cxx.

◆ prepareMultiGen()

RooAbsPdf::GenSpec * RooAbsPdf::prepareMultiGen ( const RooArgSet & whatVars,
const RooCmdArg & arg1 = {},
const RooCmdArg & arg2 = {},
const RooCmdArg & arg3 = {},
const RooCmdArg & arg4 = {},
const RooCmdArg & arg5 = {},
const RooCmdArg & arg6 = {} )
inherited

Prepare GenSpec configuration object for efficient generation of multiple datasets from identical specification.

PyROOT

The RooAbsPdf::prepareMultiGen() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Note
This method does not perform any generation. To generate according to generations specification call RooAbsPdf::generate(RooAbsPdf::GenSpec&) const

Details copied from RooAbsPdf::generate():

PyROOT

The RooAbsPdf::generate() function is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the function.

Generate the specified number of events or expectedEvents() if not specified.

Parameters
[in]whatVarsChoose variables in which to generate events. Variables not listed here will remain constant and not be used for event generation.
[in]arg1,arg2,arg3,arg4,arg5,arg6Optional RooCmdArg() to change behaviour of generate().
Returns
RooDataSet *, owned by caller.

Any variables of this PDF that are not in whatVars will use their current values and be treated as fixed parameters. Returns zero in case of an error.

Type of CmdArg Effect on generate
Name(const char* name) Name of the output dataset
Verbose(bool flag) Print informational messages during event generation
NumEvents(int nevt) Generate specified number of events
Extended() If no number of events to be generated is given, use expected number of events from extended likelihood term. This evidently only works for extended PDFs.
GenBinned(const char* tag) Use binned generation for all component pdfs that have 'setAttribute(tag)' set
AutoBinned(bool flag) Automatically deploy binned generation for binned distributions (e.g. RooHistPdf, sums and products of RooHistPdfs etc)
Note
Datasets that are generated in binned mode are returned as weighted unbinned datasets. This means that for each bin, there will be one event in the dataset with a weight corresponding to the (possibly randomised) bin content.
AllBinned() As above, but for all components.
Note
The notion of components is only meaningful for simultaneous PDFs as binned generation is always executed at the top-level node for a regular PDF, so for those it only mattes that the top-level node is tagged.
ProtoData(const RooAbsData& data, bool randOrder) Use specified dataset as prototype dataset. If randOrder in ProtoData() is set to true, the order of the events in the dataset will be read in a random order if the requested number of events to be generated does not match the number of events in the prototype dataset.
Note
If ProtoData() is used, the specified existing dataset as a prototype: the new dataset will contain the same number of events as the prototype (unless otherwise specified), and any prototype variables not in whatVars will be copied into the new dataset for each generated event and also used to set our PDF parameters. The user can specify a number of events to generate that will override the default. The result is a copy of the prototype dataset with only variables in whatVars randomized. Variables in whatVars that are not in the prototype will be added as new columns to the generated dataset.

Accessing the underlying event generator

Depending on the fit model (if it is difficult to sample), it may be necessary to change generator settings. For the default generator (RooFoamGenerator), the number of samples or cells could be increased by e.g. using myPdf->specialGeneratorConfig()->getConfigSection("RooFoamGenerator").setRealValue("nSample",1e4);

The foam generator e.g. has the following config options:

  • nCell[123N]D
  • nSample
  • chatLevel
    See also
    rf902_numgenconfig.C

Definition at line 1290 of file RooAbsPdf.cxx.

◆ Print()

void RooAbsArg::Print ( Option_t * options = nullptr) const
inlineoverridevirtualinherited

Print the object to the defaultPrintStream().

Parameters
[in]optionsV print verbose. T print a tree structure with all children.

Reimplemented from TObject.

Definition at line 238 of file RooAbsArg.h.

◆ printAddress()

void RooAbsArg::printAddress ( std::ostream & os) const
overridevirtualinherited

Print address of this RooAbsArg.

Reimplemented from RooPrintable.

Definition at line 1350 of file RooAbsArg.cxx.

◆ printArgs()

◆ printAttribList()

void RooAbsArg::printAttribList ( std::ostream & os) const
protectedinherited

Print the attribute list.

Definition at line 1471 of file RooAbsArg.cxx.

◆ printClassName()

void RooAbsArg::printClassName ( std::ostream & os) const
overridevirtualinherited

Print object class name.

Reimplemented from RooPrintable.

Definition at line 1344 of file RooAbsArg.cxx.

◆ printCompactTree() [1/2]

void RooAbsArg::printCompactTree ( const char * indent = "",
const char * filename = nullptr,
const char * namePat = nullptr,
RooAbsArg * client = nullptr )
inherited

Print tree structure of expression tree on stdout, or to file if filename is specified.

If namePat is not "*", only nodes with names matching the pattern will be printed. The client argument is used in recursive calls to properly display the value or shape nature of the client-server links. It should be zero in calls initiated by users.

Definition at line 1756 of file RooAbsArg.cxx.

◆ printCompactTree() [2/2]

void RooAbsArg::printCompactTree ( std::ostream & os,
const char * indent = "",
const char * namePat = nullptr,
RooAbsArg * client = nullptr )
inherited

Print tree structure of expression tree on given ostream.

If namePat is not "*", only nodes with names matching the pattern will be printed. The client argument is used in recursive calls to properly display the value or shape nature of the client-server links. It should be zero in calls initiated by users.

Definition at line 1771 of file RooAbsArg.cxx.

◆ printCompactTreeHook()

void RooAbsArg::printCompactTreeHook ( std::ostream & os,
const char * ind = "" )
virtualinherited

Hook function interface for object to insert additional information when printed in the context of a tree structure.

This default implementation prints nothing

Reimplemented in RooNumConvolution.

Definition at line 1872 of file RooAbsArg.cxx.

◆ printComponentTree()

void RooAbsArg::printComponentTree ( const char * indent = "",
const char * namePat = nullptr,
Int_t nLevel = 999 )
inherited

Print tree structure of expression tree on given ostream, only branch nodes are printed.

Lead nodes (variables) will not be shown

If namePat is not "*", only nodes with names matching the pattern will be printed.

Definition at line 1818 of file RooAbsArg.cxx.

◆ printDirty()

void RooAbsArg::printDirty ( bool depth = true) const
inherited

Print information about current value dirty state information.

If depth flag is true, information is recursively printed for all nodes in this arg tree.

Definition at line 1528 of file RooAbsArg.cxx.

◆ printEvalErrors()

void RooAbsReal::printEvalErrors ( std::ostream & os = std::cout,
Int_t maxPerNode = 10000000 )
staticinherited

Print all outstanding logged evaluation error on the given ostream.

If maxPerNode is zero, only the number of errors for each source (object with unique name) is listed. If maxPerNode is greater than zero, up to maxPerNode detailed error messages are shown per source of errors. A truncation message is shown if there were more errors logged than shown.

Definition at line 3476 of file RooAbsReal.cxx.

◆ printExtras()

void RooPrintable::printExtras ( std::ostream & os) const
virtualinherited

Interface to print extras of object.

Reimplemented in RooRealVar.

Definition at line 159 of file RooPrintable.cxx.

◆ printMetaArgs()

virtual void RooAbsArg::printMetaArgs ( std::ostream & ) const
inlinevirtualinherited

◆ printMultiline()

void RooAbsPdf::printMultiline ( std::ostream & os,
Int_t contents,
bool verbose = false,
TString indent = "" ) const
overridevirtualinherited

Print multi line detailed information of this RooAbsPdf.

Reimplemented from RooAbsArg.

Reimplemented in RooGenericPdf, and RooResolutionModel.

Definition at line 1091 of file RooAbsPdf.cxx.

◆ printName()

void RooAbsArg::printName ( std::ostream & os) const
overridevirtualinherited

Print object name.

Reimplemented from RooPrintable.

Definition at line 1330 of file RooAbsArg.cxx.

◆ printStream()

void RooPrintable::printStream ( std::ostream & os,
Int_t contents,
StyleOption style,
TString indent = "" ) const
virtualinherited

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

Each message is prefixed by string 'indent' when printed

Definition at line 71 of file RooPrintable.cxx.

◆ printTitle()

void RooAbsArg::printTitle ( std::ostream & os) const
overridevirtualinherited

Print object title.

Reimplemented from RooPrintable.

Definition at line 1337 of file RooAbsArg.cxx.

◆ printTree()

void RooAbsArg::printTree ( std::ostream & os,
TString indent = "" ) const
overridevirtualinherited

Print object tree structure.

Reimplemented from RooPrintable.

Definition at line 1448 of file RooAbsArg.cxx.

◆ printValue()

void RooAbsPdf::printValue ( std::ostream & os) const
overridevirtualinherited

Print value of p.d.f, also print normalization integral that was last used, if any.

Reimplemented from RooPrintable.

Definition at line 1072 of file RooAbsPdf.cxx.

◆ randomizeProtoOrder()

Int_t * RooAbsPdf::randomizeProtoOrder ( Int_t nProto,
Int_t nGen,
bool resample = false ) const
protectedinherited

Return lookup table with randomized order for nProto prototype events.

Definition at line 1476 of file RooAbsPdf.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ readFromStream()

bool RooAbsReal::readFromStream ( std::istream & is,
bool compact,
bool verbose = false )
overridevirtualinherited

Read object contents from stream (dummy for now).

Implements RooAbsArg.

Reimplemented in RooAbsRealLValue, RooErrorVar, RooFormulaVar, RooGenericPdf, RooLinearVar, and RooRealVar.

Definition at line 423 of file RooAbsReal.cxx.

◆ recursiveCheckObservables()

bool RooAbsArg::recursiveCheckObservables ( const RooArgSet * nset) const
inherited

Recursively call checkObservables on all nodes in the expression tree.

Definition at line 694 of file RooAbsArg.cxx.

◆ recursiveRedirectServers()

bool RooAbsArg::recursiveRedirectServers ( const RooAbsCollection & newSet,
bool mustReplaceAll = false,
bool nameChange = false,
bool recurseInNewSet = true )
inherited

Recursively replace all servers with the new servers in newSet.

This substitutes objects that we receive values from (also indirectly through other objects) with new objects that have the same name.

Copied from redirectServers:

This substitutes objects that we receive values from with new objects that have the same name. See: recursiveRedirectServers() Use recursive version if servers that are only indirectly serving this object should be replaced as well. See: redirectServers() If only the direct servers of an object need to be replaced.

Note that changing the types of objects is generally allowed, but can be wrong if the interface of an object changes. For example, one can reparametrise a model by substituting a variable with a function:

\[ f(x\, |\, a) = a \cdot x \rightarrow f(x\, |\, b) = (2.1 \cdot b) \cdot x \]

If an object, however, expects a PDF, and this is substituted with a function that isn't normalised, wrong results might be obtained or it might even crash the program. The types of the objects being substituted are not checked.

Parameters
[in]newSetOrigSet of new servers that should be used instead of the current servers.
[in]mustReplaceAllA warning is printed and error status is returned if not all servers could be substituted successfully.
[in]nameChangeIf false, an object named "x" is only replaced with an object also named "x" in newSetOrig. If the object in newSet is called differently, set nameChange to true and use setAttribute() on the x object:
objectToReplaceX.setAttribute("ORIGNAME:x")
Now, the renamed object will be selected based on the attribute "ORIGNAME:<name>".
[in]isRecursionStepInternal switch used when called from recursiveRedirectServers().
newSetRoo collection
recurseInNewSetbe recursive

Definition at line 1138 of file RooAbsArg.cxx.

◆ RecursiveRemove()

◆ redirectServers() [1/2]

bool RooAbsArg::redirectServers ( const RooAbsCollection & newSetOrig,
bool mustReplaceAll = false,
bool nameChange = false,
bool isRecursionStep = false )
inherited

Replace all direct servers of this object with the new servers in newServerList.

This substitutes objects that we receive values from with new objects that have the same name. See: recursiveRedirectServers() Use recursive version if servers that are only indirectly serving this object should be replaced as well. See: redirectServers() If only the direct servers of an object need to be replaced.

Note that changing the types of objects is generally allowed, but can be wrong if the interface of an object changes. For example, one can reparametrise a model by substituting a variable with a function:

\[ f(x\, |\, a) = a \cdot x \rightarrow f(x\, |\, b) = (2.1 \cdot b) \cdot x \]

If an object, however, expects a PDF, and this is substituted with a function that isn't normalised, wrong results might be obtained or it might even crash the program. The types of the objects being substituted are not checked.

Parameters
[in]newSetOrigSet of new servers that should be used instead of the current servers.
[in]mustReplaceAllA warning is printed and error status is returned if not all servers could be substituted successfully.
[in]nameChangeIf false, an object named "x" is only replaced with an object also named "x" in newSetOrig. If the object in newSet is called differently, set nameChange to true and use setAttribute() on the x object:
objectToReplaceX.setAttribute("ORIGNAME:x")
Now, the renamed object will be selected based on the attribute "ORIGNAME:<name>".
[in]isRecursionStepInternal switch used when called from recursiveRedirectServers().

Definition at line 885 of file RooAbsArg.cxx.

◆ redirectServers() [2/2]

bool RooAbsArg::redirectServers ( std::unordered_map< RooAbsArg *, RooAbsArg * > const & replacements)
inherited

Replace some servers of this object.

If there are proxies that correspond to the replaced servers, these proxies are adjusted as well.

Parameters
[in]replacementsMap that specifies which args replace which servers.

Definition at line 1003 of file RooAbsArg.cxx.

◆ redirectServersHook()

bool RooAbsPdf::redirectServersHook ( const RooAbsCollection & newServerList,
bool mustReplaceAll,
bool nameChange,
bool isRecursiveStep )
overrideprotectedvirtualinherited

Hook function intercepting redirectServer calls.

Discard current normalization object if any server is redirected

Reimplemented from RooAbsArg.

Reimplemented in RooAddPdf, RooGenericPdf, RooProdPdf, RooProjectedPdf, and RooResolutionModel.

Definition at line 2757 of file RooAbsPdf.cxx.

◆ registerCache()

void RooAbsArg::registerCache ( RooAbsCache & cache)
inherited

Register RooAbsCache with this object.

This function is called by RooAbsCache constructors for objects that are a datamember of this RooAbsArg. By registering itself the RooAbsArg is aware of all its cache data members and will forward server change and cache mode change calls to the cache objects, which in turn can forward them their contents

Definition at line 1881 of file RooAbsArg.cxx.

◆ registerProxy() [1/3]

void RooAbsArg::registerProxy ( RooArgProxy & proxy)
protectedinherited

Register an RooArgProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg will forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur. The proxied argument is also added as value and/or shape server

Definition at line 1173 of file RooAbsArg.cxx.

◆ registerProxy() [2/3]

void RooAbsArg::registerProxy ( RooListProxy & proxy)
protectedinherited

Register an RooListProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg will forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur.

Definition at line 1240 of file RooAbsArg.cxx.

◆ registerProxy() [3/3]

void RooAbsArg::registerProxy ( RooSetProxy & proxy)
protectedinherited

Register an RooSetProxy in the proxy list.

This function is called by owned proxies upon creation. After registration, this arg will forward pointer changes from serverRedirects and updates in cached normalization sets to the proxies immediately after they occur.

Definition at line 1211 of file RooAbsArg.cxx.

◆ removeServer()

void RooAbsArg::removeServer ( RooAbsArg & server,
bool force = false )
inherited

Unregister another RooAbsArg as a server to us, ie, declare that we no longer depend on its value and shape.

Definition at line 356 of file RooAbsArg.cxx.

◆ removeStringAttribute()

void RooAbsArg::removeStringAttribute ( const Text_t * key)
inherited

Delete a string attribute with a given key.

Definition at line 261 of file RooAbsArg.cxx.

◆ replaceServer()

void RooAbsArg::replaceServer ( RooAbsArg & oldServer,
RooAbsArg & newServer,
bool propValue,
bool propShape )
inherited

Replace 'oldServer' with 'newServer', specifying whether the new server has value or shape server properties.

Warning
This function should not be used! This method is quite unsafe for many reasons. For once, the new server will be put at the end of the server list, no matter the position of the original server. This might mess up code that expects the servers to be in a certain order. Furthermore, the proxy objects corresponding to the server are not updated, leaving the object in an invalid state where the servers are out of sync with the proxies. This can have very bad consequences. Finally, by having to manually specify the value and shape server properties, it is very easy to get them wrong.

If you want to safely replace a server, you should use RooAbsArg::redirectServers(), which replaces the server in-place at the same position of the server list, keeps the same value and shape server properties, and also updates the corresponding proxies.

Definition at line 397 of file RooAbsArg.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ resetDataToken()

void RooAbsArg::resetDataToken ( )
inlineinherited

Definition at line 638 of file RooAbsArg.h.

◆ resetErrorCounters()

void RooAbsPdf::resetErrorCounters ( Int_t resetValue = 10)
virtualinherited

Reset error counter to given value, limiting the number of future error messages for this pdf to 'resetValue'.

Reimplemented in RooAddModel, and RooAddPdf.

Definition at line 571 of file RooAbsPdf.cxx.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ selectComp()

void RooAbsReal::selectComp ( bool flag)
inlineinherited

Definition at line 374 of file RooAbsReal.h.

◆ selectNormalization()

void RooAbsReal::selectNormalization ( const RooArgSet * depSet = nullptr,
bool force = false )
protectedvirtualinherited

Interface function to force use of a given set of observables to interpret function value.

Needed for functions or p.d.f.s whose shape depends on the choice of normalization such as RooAddPdf

Reimplemented in RooAddModel, RooAddPdf, and RooSimultaneous.

Definition at line 3265 of file RooAbsReal.cxx.

◆ selectNormalizationRange()

void RooAbsReal::selectNormalizationRange ( const char * rangeName = nullptr,
bool force = false )
protectedvirtualinherited

Interface function to force use of a given normalization range to interpret function value.

Needed for functions or p.d.f.s whose shape depends on the choice of normalization such as RooAddPdf

Reimplemented in RooAddModel, RooAddPdf, RooBernstein, RooChebychev, RooProdPdf, and RooSimultaneous.

Definition at line 3273 of file RooAbsReal.cxx.

◆ selfNormalized()

virtual bool RooAbsPdf::selfNormalized ( ) const
inlinevirtualinherited

Shows if a PDF is self-normalized, which means that no attempt is made to add a normalization term.

Always returns false, unless a PDF overrides this function.

Reimplemented in PdfWrapper, RooAbsCachedPdf, RooAddModel, RooAddPdf, RooBinSamplingPdf, RooExtendPdf, RooFit::Detail::RooFixedProdPdf, RooFit::Detail::RooNormalizedPdf, RooHistConstraint, RooHistPdf, RooIntegralMorph, RooMomentMorph, RooMultiPdf, RooProdPdf, RooProjectedPdf, RooRealSumPdf, RooResolutionModel, RooSimultaneous, and RooWrapperPdf.

Definition at line 203 of file RooAbsPdf.h.

◆ serverNameChangeHook()

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

Definition at line 197 of file RooAbsArg.h.

◆ servers()

const RefCountList_t & RooAbsArg::servers ( ) const
inlineinherited

List of all servers of this object.

Definition at line 145 of file RooAbsArg.h.

◆ setActiveNormSet()

void RooAbsPdf::setActiveNormSet ( RooArgSet const * normSet) const
inlineprivateinherited

Setter for the _normSet member, which should never be set directly.

Definition at line 280 of file RooAbsPdf.h.

◆ setAttribute()

void RooAbsArg::setAttribute ( const Text_t * name,
bool value = true )
inherited

Set (default) or clear a named boolean attribute of this object.

Definition at line 224 of file RooAbsArg.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ setCacheAndTrackHints()

virtual void RooAbsArg::setCacheAndTrackHints ( RooArgSet & )
inlinevirtualinherited

◆ setCachedValue()

void RooAbsReal::setCachedValue ( double value,
bool notifyClients = true )
inlinefinalvirtualinherited

Overwrite the value stored in this object's cache.

This can be used to fake a computation that resulted in value.

Parameters
[in]valueValue to write.
[in]notifyClientsIf true, notify users of this object that its value changed. This is the default.

Reimplemented from RooAbsArg.

Definition at line 561 of file RooAbsReal.h.

◆ setData()

virtual bool RooAbsReal::setData ( RooAbsData & ,
bool = true )
inlinevirtualinherited

Reimplemented in RooAddition, RooConstraintSum, and ROOT::Experimental::XRooFit::ProgressMonitor.

Definition at line 364 of file RooAbsReal.h.

◆ setDataToken()

void RooAbsArg::setDataToken ( std::size_t index)
inherited

Sets the token for retrieving results in the BatchMode. For internal use only.

Definition at line 2261 of file RooAbsArg.cxx.

◆ setDirtyInhibit()

void RooAbsArg::setDirtyInhibit ( bool flag)
staticinherited

Control global dirty inhibit mode.

When set to true no value or shape dirty flags are propagated and cache is always considered to be dirty.

Definition at line 210 of file RooAbsArg.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ setEvalErrorLoggingMode()

void RooAbsReal::setEvalErrorLoggingMode ( RooAbsReal::ErrorLoggingMode m)
staticinherited

Set evaluation error logging mode.

Options are

PrintErrors - Print each error through RooMsgService() as it occurs CollectErrors - Accumulate errors, but do not print them. A subsequent call to printEvalErrors() will print a summary CountErrors - Accumulate error count, but do not print them.

Definition at line 4084 of file RooAbsReal.cxx.

◆ setExpensiveObjectCache()

virtual void RooAbsArg::setExpensiveObjectCache ( RooExpensiveObjectCache & cache)
inlinevirtualinherited

Reimplemented in RooRealVar.

Definition at line 439 of file RooAbsArg.h.

◆ setGeneratorConfig() [1/2]

void RooAbsPdf::setGeneratorConfig ( )
inherited

Remove the specialized numeric MC generator configuration associated with this object.

Definition at line 2672 of file RooAbsPdf.cxx.

◆ setGeneratorConfig() [2/2]

void RooAbsPdf::setGeneratorConfig ( const RooNumGenConfig & config)
inherited

Set the given configuration as default numeric MC generator configuration for this object.

Definition at line 2661 of file RooAbsPdf.cxx.

◆ setHideOffset()

void RooAbsReal::setHideOffset ( bool flag)
staticinherited

Definition at line 188 of file RooAbsReal.cxx.

◆ setIntegratorConfig() [1/2]

void RooAbsReal::setIntegratorConfig ( )
inherited

Remove the specialized numeric integration configuration associated with this object.

Definition at line 3254 of file RooAbsReal.cxx.

◆ setIntegratorConfig() [2/2]

void RooAbsReal::setIntegratorConfig ( const RooNumIntConfig & config)
inherited

Set the given integrator configuration as default numeric integration configuration for this object.

Definition at line 3243 of file RooAbsReal.cxx.

◆ setLocalNoDirtyInhibit()

void RooAbsArg::setLocalNoDirtyInhibit ( bool flag) const
inlineinherited

Definition at line 631 of file RooAbsArg.h.

◆ SetName()

void RooAbsArg::SetName ( const char * name)
overridevirtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 2097 of file RooAbsArg.cxx.

◆ SetNameTitle()

void RooAbsArg::SetNameTitle ( const char * name,
const char * title )
overridevirtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented from TNamed.

Definition at line 2109 of file RooAbsArg.cxx.

◆ setNormRange()

void RooAbsPdf::setNormRange ( const char * rangeName)
inherited

Definition at line 2723 of file RooAbsPdf.cxx.

◆ setNormRangeOverride()

void RooAbsPdf::setNormRangeOverride ( const char * rangeName)
inherited

Definition at line 2739 of file RooAbsPdf.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ setOperMode()

void RooAbsArg::setOperMode ( OperMode mode,
bool recurseADirty = true )
inherited

Set the operation mode of this node.

Change cache operation mode to given mode.

If recurseAdirty is true, then a mode change to AlwaysDirty will automatically be propagated recursively to all client nodes

Definition at line 1730 of file RooAbsArg.cxx.

◆ setParameterizeIntegral()

void RooAbsReal::setParameterizeIntegral ( const RooArgSet & paramVars)
inherited

Definition at line 4092 of file RooAbsReal.cxx.

◆ setPlotLabel()

void RooAbsReal::setPlotLabel ( const char * label)
inherited

Set the label associated with this variable.

Definition at line 413 of file RooAbsReal.cxx.

◆ setProhibitServerRedirect()

void RooAbsArg::setProhibitServerRedirect ( bool flag)
inlineinherited

Definition at line 488 of file RooAbsArg.h.

◆ setProxyNormSet()

void RooAbsArg::setProxyNormSet ( const RooArgSet * nset)
protectedinherited

Forward a change in the cached normalization argset to all the registered proxies.

Definition at line 1289 of file RooAbsArg.cxx.

◆ setShapeDirty() [1/2]

void RooAbsArg::setShapeDirty ( )
inlineinherited

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

Definition at line 431 of file RooAbsArg.h.

◆ setShapeDirty() [2/2]

void RooAbsArg::setShapeDirty ( const RooAbsArg * source)
protectedinherited

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

Mark this object as having changed its shape, and propagate this status change to all of our clients.

Definition at line 831 of file RooAbsArg.cxx.

◆ setStringAttribute()

void RooAbsArg::setStringAttribute ( const Text_t * key,
const Text_t * value )
inherited

Associate string 'value' to this object under key 'key'.

Definition at line 250 of file RooAbsArg.cxx.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ setTraceCounter()

void RooAbsPdf::setTraceCounter ( Int_t value,
bool allNodes = false )
inherited

Reset trace counter to given value, limiting the number of future trace messages for this pdf to 'value'.

Definition at line 583 of file RooAbsPdf.cxx.

◆ setTransientAttribute()

void RooAbsArg::setTransientAttribute ( const Text_t * name,
bool value = true )
inherited

Set (default) or clear a named boolean attribute of this object.

Definition at line 277 of file RooAbsArg.cxx.

◆ setTreeBranchStatus()

void RooAbsReal::setTreeBranchStatus ( TTree & t,
bool active )
overrideprotectedvirtualinherited

(De)Activate associated tree branch

Implements RooAbsArg.

Definition at line 3102 of file RooAbsReal.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ setUnit()

void RooAbsReal::setUnit ( const char * unit)
inlineinherited

Definition at line 153 of file RooAbsReal.h.

◆ setValueDirty() [1/2]

void RooAbsArg::setValueDirty ( )
inlineinherited

Mark the element dirty. This forces a re-evaluation when a value is requested.

Definition at line 425 of file RooAbsArg.h.

◆ setValueDirty() [2/2]

void RooAbsArg::setValueDirty ( const RooAbsArg * source)
protectedinherited

Force element to re-evaluate itself when a value is requested.

Mark this object as having changed its value, and propagate this status change to all of our clients.

If the object is not in automatic dirty state propagation mode, this call has no effect.

Definition at line 792 of file RooAbsArg.cxx.

◆ setWorkspace()

void RooAbsArg::setWorkspace ( RooWorkspace & ws)
inlineinherited

Definition at line 490 of file RooAbsArg.h.

◆ shapeClients()

const RefCountList_t & RooAbsArg::shapeClients ( ) const
inlineinherited

List of all shape clients of this object.

Shape clients receive property information such as changes of a value range.

Definition at line 142 of file RooAbsArg.h.

◆ sigCatName()

std::string RooEfficiency::sigCatName ( ) const
inline

Definition at line 39 of file RooEfficiency.h.

◆ sigma() [1/2]

RooAbsMoment * RooAbsReal::sigma ( RooRealVar & obs)
inlineinherited

Definition at line 358 of file RooAbsReal.h.

◆ sigma() [2/2]

RooAbsMoment * RooAbsReal::sigma ( RooRealVar & obs,
const RooArgSet & nset )
inlineinherited

Definition at line 359 of file RooAbsReal.h.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

◆ specialGeneratorConfig() [1/2]

RooNumGenConfig * RooAbsPdf::specialGeneratorConfig ( ) const
inherited

Returns the specialized integrator configuration for this RooAbsReal.

If this object has no specialized configuration, a null pointer is returned

Definition at line 2621 of file RooAbsPdf.cxx.

◆ specialGeneratorConfig() [2/2]

RooNumGenConfig * RooAbsPdf::specialGeneratorConfig ( bool createOnTheFly)
inherited

Returns the specialized integrator configuration for this RooAbsReal.

If this object has no specialized configuration, a null pointer is returned, unless createOnTheFly is true in which case a clone of the default integrator configuration is created, installed as specialized configuration, and returned

Definition at line 2634 of file RooAbsPdf.cxx.

◆ specialIntegratorConfig() [1/2]

RooNumIntConfig * RooAbsReal::specialIntegratorConfig ( ) const
inherited

Returns the specialized integrator configuration for this RooAbsReal.

If this object has no specialized configuration, a null pointer is returned.

Definition at line 3192 of file RooAbsReal.cxx.

◆ specialIntegratorConfig() [2/2]

RooNumIntConfig * RooAbsReal::specialIntegratorConfig ( bool createOnTheFly)
inherited

Returns the specialized integrator configuration for this RooAbsReal.

If this object has no specialized configuration, a null pointer is returned, unless createOnTheFly is true in which case a clone of the default integrator configuration is created, installed as specialized configuration, and returned

Definition at line 3204 of file RooAbsReal.cxx.

◆ Streamer()

void RooEfficiency::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class RooAbsArg.

Reimplemented from RooAbsPdf.

◆ StreamerNVirtual()

void RooEfficiency::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 50 of file RooEfficiency.h.

◆ stringAttributes()

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

Definition at line 267 of file RooAbsArg.h.

◆ substituteServer()

void RooAbsArg::substituteServer ( RooAbsArg * oldServer,
RooAbsArg * newServer )
privateinherited

Private helper function for RooAbsArg::redirectServers().

Definition at line 970 of file RooAbsArg.cxx.

◆ syncCache()

void RooAbsReal::syncCache ( const RooArgSet * set = nullptr)
inlineoverrideprotectedvirtualinherited

Implements RooAbsArg.

Reimplemented in RooErrorVar.

Definition at line 456 of file RooAbsReal.h.

◆ syncNormalization()

bool RooAbsPdf::syncNormalization ( const RooArgSet * nset,
bool adjustProxies = true ) const
protectedvirtualinherited

Verify that the normalization integral cached with this PDF is valid for given set of normalization observables.

If not, the cached normalization integral (if any) is deleted and a new integral is constructed for use with 'nset'. Elements in 'nset' can be discrete and real, but must be lvalues.

For functions that declare to be self-normalized by overloading the selfNormalized() function, a unit normalization is always constructed.

Definition at line 462 of file RooAbsPdf.cxx.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ traceEval()

double RooAbsReal::traceEval ( const RooArgSet * set) const
protectedinherited

Calculate current value of object, with error tracing wrapper.

Definition at line 316 of file RooAbsReal.cxx.

◆ traceEvalPdf()

bool RooAbsPdf::traceEvalPdf ( double value) const
privateinherited

Check that passed value is positive and not 'not-a-number'.

If not, print an error, until the error counter reaches its set maximum.

Definition at line 365 of file RooAbsPdf.cxx.

◆ transientAttributes()

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

Definition at line 276 of file RooAbsArg.h.

◆ treeNodeServerList()

void RooAbsArg::treeNodeServerList ( RooAbsCollection * list,
const RooAbsArg * arg = nullptr,
bool doBranch = true,
bool doLeaf = true,
bool valueOnly = false,
bool recurseFundamental = false ) const
inherited

Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node.

Parameters
[in]listOutput list
[in]argStart searching at this element of the tree.
[in]doBranchAdd branch nodes to the list.
[in]doLeafAdd leaf nodes to the list.
[in]valueOnlyOnly check if an element is a value server (no shape server).
[in]recurseFundamental

Definition at line 465 of file RooAbsArg.cxx.

◆ unRegisterCache()

void RooAbsArg::unRegisterCache ( RooAbsCache & cache)
inherited

Unregister a RooAbsCache. Called from the RooAbsCache destructor.

Definition at line 1888 of file RooAbsArg.cxx.

◆ unRegisterProxy() [1/3]

void RooAbsArg::unRegisterProxy ( RooArgProxy & proxy)
protectedinherited

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1199 of file RooAbsArg.cxx.

◆ unRegisterProxy() [2/3]

void RooAbsArg::unRegisterProxy ( RooListProxy & proxy)
protectedinherited

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1262 of file RooAbsArg.cxx.

◆ unRegisterProxy() [3/3]

void RooAbsArg::unRegisterProxy ( RooSetProxy & proxy)
protectedinherited

Remove proxy from proxy list.

This functions is called by owned proxies upon their destruction.

Definition at line 1228 of file RooAbsArg.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

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

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ valueClients()

const RefCountList_t & RooAbsArg::valueClients ( ) const
inlineinherited

List of all value clients of this object. Value clients receive value updates.

Definition at line 139 of file RooAbsArg.h.

◆ verboseDirty()

void RooAbsArg::verboseDirty ( bool flag)
staticinherited

Activate verbose messaging related to dirty flag propagation.

Definition at line 217 of file RooAbsArg.cxx.

◆ verboseEval() [1/2]

Int_t RooAbsPdf::verboseEval ( )
staticinherited

Return global level of verbosity for p.d.f. evaluations.

Definition at line 2418 of file RooAbsPdf.cxx.

◆ verboseEval() [2/2]

void RooAbsPdf::verboseEval ( Int_t stat)
staticinherited

Change global level of verbosity for p.d.f. evaluations.

Definition at line 2408 of file RooAbsPdf.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ wireAllCaches()

void RooAbsArg::wireAllCaches ( )
inherited

Definition at line 2086 of file RooAbsArg.cxx.

◆ workspace()

RooWorkspace * RooAbsArg::workspace ( ) const
inlineinherited

Definition at line 491 of file RooAbsArg.h.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

◆ writeToStream()

void RooAbsReal::writeToStream ( std::ostream & os,
bool compact ) const
overridevirtualinherited

Write object contents to stream (dummy for now).

Implements RooAbsArg.

Reimplemented in RooAbsRealLValue, RooConstVar, RooErrorVar, RooFormulaVar, RooGenericPdf, RooLinearVar, and RooRealVar.

Definition at line 433 of file RooAbsReal.cxx.

Member Data Documentation

◆ _boolAttrib

std::set<std::string> RooAbsArg::_boolAttrib
protectedinherited

Definition at line 588 of file RooAbsArg.h.

◆ _boolAttribTransient

std::set<std::string> RooAbsArg::_boolAttribTransient
protectedinherited

! Transient boolean attributes (not copied in ctor)

Definition at line 590 of file RooAbsArg.h.

◆ _cacheList

std::vector<RooAbsCache *> RooAbsArg::_cacheList
protectedinherited

! list of caches

Definition at line 571 of file RooAbsArg.h.

◆ _cat

RooCategoryProxy RooEfficiency::_cat
protected

Accept/reject categort.

Definition at line 46 of file RooEfficiency.h.

◆ _clientList

RefCountList_t RooAbsArg::_clientList
protectedinherited

Definition at line 565 of file RooAbsArg.h.

◆ _clientListShape

RefCountList_t RooAbsArg::_clientListShape
protectedinherited

Definition at line 566 of file RooAbsArg.h.

◆ _clientListValue

RefCountList_t RooAbsArg::_clientListValue
protectedinherited

Definition at line 567 of file RooAbsArg.h.

◆ _dataToken

std::size_t RooAbsArg::_dataToken = std::numeric_limits<std::size_t>::max()
protectedinherited

!

Set by the RooFitDriver for this arg to ! retrieve its result in the run context

Definition at line 661 of file RooAbsArg.h.

◆ _deleteWatch

bool RooAbsArg::_deleteWatch = false
protectedinherited

! Delete watch flag

Definition at line 626 of file RooAbsArg.h.

◆ _effFunc

RooRealProxy RooEfficiency::_effFunc
protected

Efficiency modeling function.

Definition at line 47 of file RooEfficiency.h.

◆ _eocache

RooExpensiveObjectCache* RooAbsArg::_eocache {nullptr}
mutableprotectedinherited

! Pointer to global cache manager for expensive components.

Definition at line 652 of file RooAbsArg.h.

◆ _errorCount

Int_t RooAbsPdf::_errorCount = 0
mutableprotectedinherited

Number of errors remaining to print.

Definition at line 328 of file RooAbsPdf.h.

◆ _fast

bool RooAbsArg::_fast = false
mutableprotectedinherited

Definition at line 645 of file RooAbsArg.h.

◆ _forceNumInt

bool RooAbsReal::_forceNumInt = false
protectedinherited

Force numerical integration if flag set.

Definition at line 542 of file RooAbsReal.h.

◆ _globalSelectComp

bool RooAbsReal::_globalSelectComp = false
staticprotectedinherited

Definition at line 548 of file RooAbsReal.h.

◆ _hideOffset

bool RooAbsReal::_hideOffset = true
staticprotectedinherited

Offset hiding flag.

Definition at line 549 of file RooAbsReal.h.

◆ _inhibitDirty

bool RooAbsArg::_inhibitDirty
staticprotectedinherited

Definition at line 625 of file RooAbsArg.h.

◆ _isConstant

bool RooAbsArg::_isConstant = false
protectedinherited

! Cached isConstant status

Definition at line 655 of file RooAbsArg.h.

◆ _label

TString RooAbsReal::_label
protectedinherited

Plot label for objects value.

Definition at line 541 of file RooAbsReal.h.

◆ _lastNormSetId

RooFit::UniqueId<RooArgSet>::Value_t RooAbsReal::_lastNormSetId = RooFit::UniqueId<RooArgSet>::nullval
mutableprotectedinherited

!

Definition at line 546 of file RooAbsReal.h.

◆ _localNoInhibitDirty

bool RooAbsArg::_localNoInhibitDirty = false
mutableprotectedinherited

! Prevent 'AlwaysDirty' mode for this node

Definition at line 657 of file RooAbsArg.h.

◆ _myws

RooWorkspace* RooAbsArg::_myws = nullptr
mutableprotectedinherited

! In which workspace do I live, if any

Definition at line 659 of file RooAbsArg.h.

◆ _nameLength

Int_t RooPrintable::_nameLength
staticprotectedinherited

Definition at line 57 of file RooPrintable.h.

◆ _namePtr

const TNamed* RooAbsArg::_namePtr = nullptr
mutableprotectedinherited

! De-duplicated name pointer, equal for all objects with the same name.

Definition at line 654 of file RooAbsArg.h.

◆ _negCount

Int_t RooAbsPdf::_negCount = 0
mutableprotectedinherited

Number of negative probabilities remaining to print.

Definition at line 330 of file RooAbsPdf.h.

◆ _norm

RooAbsReal* RooAbsPdf::_norm = nullptr
mutableprotectedinherited

! Normalization integral (owned by _normMgr)

Definition at line 313 of file RooAbsPdf.h.

◆ _normMgr

RooObjCacheManager RooAbsPdf::_normMgr
mutableprotectedinherited

! The cache manager

Definition at line 323 of file RooAbsPdf.h.

◆ _normRange

TString RooAbsPdf::_normRange
protectedinherited

Normalization range.

Definition at line 336 of file RooAbsPdf.h.

◆ _normRangeOverride

TString RooAbsPdf::_normRangeOverride
staticprotectedinherited

Definition at line 337 of file RooAbsPdf.h.

◆ _normSet

RooArgSet const* RooAbsPdf::_normSet = nullptr
mutableprotectedinherited

! Normalization set with for above integral

Definition at line 314 of file RooAbsPdf.h.

◆ _normSetId

RooFit::UniqueId<RooArgSet>::Value_t RooAbsPdf::_normSetId = RooFit::UniqueId<RooArgSet>::nullval
mutableprivateinherited

! Unique ID of the currently-active normalization set

Definition at line 340 of file RooAbsPdf.h.

◆ _operMode

OperMode RooAbsArg::_operMode = Auto
mutableprotectedinherited

Definition at line 644 of file RooAbsArg.h.

◆ _ownedComponents

RooArgSet* RooAbsArg::_ownedComponents = nullptr
protectedinherited

! Set of owned component

Definition at line 648 of file RooAbsArg.h.

◆ _plotBins

Int_t RooAbsReal::_plotBins = 100
protectedinherited

Number of plot bins.

Definition at line 538 of file RooAbsReal.h.

◆ _plotMax

double RooAbsReal::_plotMax = 0.0
protectedinherited

Maximum of plot range.

Definition at line 537 of file RooAbsReal.h.

◆ _plotMin

double RooAbsReal::_plotMin = 0.0
protectedinherited

Minimum of plot range.

Definition at line 536 of file RooAbsReal.h.

◆ _prohibitServerRedirect

bool RooAbsArg::_prohibitServerRedirect = false
mutableprotectedinherited

! Prohibit server redirects – Debugging tool

Definition at line 650 of file RooAbsArg.h.

◆ _proxyList

RooRefArray RooAbsArg::_proxyList
protectedinherited

Definition at line 569 of file RooAbsArg.h.

◆ _proxyListCache

ProxyListCache RooAbsArg::_proxyListCache
protectedinherited

! cache of the list of proxies. Avoids type casting.

Definition at line 621 of file RooAbsArg.h.

◆ _rawValue

double RooAbsPdf::_rawValue = 0
mutableprotectedinherited

Definition at line 312 of file RooAbsPdf.h.

◆ _selectComp

bool RooAbsPdf::_selectComp = false
protectedinherited

Component selection flag for RooAbsPdf::plotCompOn.

Definition at line 332 of file RooAbsPdf.h.

◆ _serverList

RefCountList_t RooAbsArg::_serverList
protectedinherited

Definition at line 564 of file RooAbsArg.h.

◆ _shapeDirty

bool RooAbsArg::_shapeDirty = true
mutableprotectedinherited

Definition at line 642 of file RooAbsArg.h.

◆ _sigCatName

TString RooEfficiency::_sigCatName
protected

Name of accept state of accept/reject category.

Definition at line 48 of file RooEfficiency.h.

◆ _specGeneratorConfig

std::unique_ptr<RooNumGenConfig> RooAbsPdf::_specGeneratorConfig
protectedinherited

! MC generator configuration specific for this object

Definition at line 334 of file RooAbsPdf.h.

◆ _specIntegratorConfig

std::unique_ptr<RooNumIntConfig> RooAbsReal::_specIntegratorConfig
protectedinherited

Definition at line 543 of file RooAbsReal.h.

◆ _stringAttrib

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

Definition at line 589 of file RooAbsArg.h.

◆ _traceCount

Int_t RooAbsPdf::_traceCount = 0
mutableprotectedinherited

Number of traces remaining to print.

Definition at line 329 of file RooAbsPdf.h.

◆ _treeReadBuffer

TreeReadBuffer* RooAbsReal::_treeReadBuffer = nullptr
protectedinherited

! A buffer for reading values from trees

Definition at line 544 of file RooAbsReal.h.

◆ _unit

TString RooAbsReal::_unit
protectedinherited

Unit for objects value.

Definition at line 540 of file RooAbsReal.h.

◆ _value

double RooAbsReal::_value = 0.0
mutableprotectedinherited

Cache for current value of object.

Definition at line 539 of file RooAbsReal.h.

◆ _valueDirty

bool RooAbsArg::_valueDirty = true
mutableprotectedinherited

Definition at line 641 of file RooAbsArg.h.

◆ _verboseDirty

bool RooAbsArg::_verboseDirty
staticprotectedinherited

Definition at line 624 of file RooAbsArg.h.

◆ _verboseEval

Int_t RooAbsPdf::_verboseEval = 0
staticprotectedinherited

Definition at line 308 of file RooAbsPdf.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.


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