RooAbsData Class Reference

RooAbsData is the common abstract base class for binned and unbinned datasets.

The abstract interface defines plotting and tabulating entry points for its contents and provides an iterator over its elements (bins for binned data sets, data points for unbinned datasets).

Storing global observables in RooFit datasets

RooFit groups model variables into observables and parameters, depending on if their values are stored in the dataset. For fits with parameter constraints, there is a third kind of variables, called global observables. These represent the results of auxiliary measurements that constrain the nuisance parameters. In the RooFit implementation, a likelihood is generally the sum of two terms:

• the likelihood of the data given the parameters, where the normalization set is the set of observables (implemented by RooNLLVar)
• the constraint term, where the normalization set is the set of global observables (implemented by RooConstraintSum)

Before this release, the global observable values were always taken from the model/pdf. With this release, a mechanism is added to store a snapshot of global observables in any RooDataSet or RooDataHist. For toy studies where the global observables assume a different values for each toy, the bookkeeping of the set of global observables and in particular their values is much easier with this change.

Usage example for a model with global observables g1 and g2:

auto data = model.generate(x, 1000); // data has only the single observables x
data->setGlobalObservables(g1, g2); // now, data also stores a snapshot of g1 and g2
 
// If you fit the model to the data, the global observables and their values
// are taken from the dataset:
model.fitTo(*data);
 
// You can still define the set of global observables yourself, but the values
// will be takes from the dataset if available:
model.fitTo(*data, GlobalObservables(g1, g2));
 
// To force `fitTo` to take the global observable values from the model even
// though they are in the dataset, you can use the new `GlobalObservablesSource`
// command argument:
model.fitTo(*data, GlobalObservables(g1, g2), GlobalObservablesSource("model"));
// The only other allowed value for `GlobalObservablesSource` is "data", which
// corresponds to the new default behavior explained above.

In case you create a RooFit dataset directly by calling its constructor, you can also pass the global observables in a command argument instead of calling RooAbsData::setGlobalObservables() later:

RooDataSet data{"dataset", "dataset", x, RooFit::GlobalObservables(g1, g2)};

To access the set of global observables stored in a RooAbsData, call RooAbsData::getGlobalObservables(). It returns a nullptr if no global observable snapshots are stored in the dataset.

PyROOT

Some member functions of RooAbsData that take a RooCmdArg as argument also support keyword arguments. This applies to RooAbsData::plotOn, RooAbsData::createHistogram, RooAbsData::reduce, RooAbsData::statOn. For example, the following code is equivalent in PyROOT:

# Directly passing a RooCmdArg:
data.plotOn(frame, ROOT.RooFit.CutRange("r1"))
 
# With keyword arguments:
data.plotOn(frame, CutRange="r1")

Definition at line 82 of file RooAbsData.h.

Classes
struct	PlotOpt

Public Types
using	CategorySpans = std::map< RooFit::Detail::DataKey, RooSpan< const RooAbsCategory::value_type > >
enum	ErrorType {   Poisson , SumW2 , None , Auto ,   Expected }
using	RealSpans = std::map< RooFit::Detail::DataKey, RooSpan< const double > >
enum	StorageType { Tree , Vector , Composite }
Public Types inherited from TObject
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
enum	EStatusBits {   kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,   kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }
Public Types inherited from RooPrintable
enum	ContentsOption {   kName =1 , kClassName =2 , kValue =4 , kArgs =8 ,   kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128 }
enum	StyleOption {   kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 ,   kTreeStructure =5 }

Public Member Functions
	RooAbsData ()
	Default constructor.
	RooAbsData (const RooAbsData &other, const char *newname=0)
	Copy constructor.
	RooAbsData (std::string_view name, std::string_view title, const RooArgSet &vars, RooAbsDataStore *store=0)
	Constructor from a set of variables.
virtual	~RooAbsData ()
	Destructor.
virtual void	add (const RooArgSet &row, Double_t weight=1, Double_t weightError=0)=0
void	addOwnedComponent (const char *idxlabel, RooAbsData &data)
void	attachBuffers (const RooArgSet &extObs)
Bool_t	canSplitFast () const
virtual Bool_t	changeObservableName (const char *from, const char *to)
void	checkInit () const
virtual void	convertToTreeStore ()
	Convert vector-based storage to tree-based storage.
void	convertToVectorStore ()
	Convert tree-based storage to vector-based storage.
Double_t	correlation (RooRealVar &x, RooRealVar &y, const char *cutSpec=0, const char *cutRange=0) const
TMatrixDSym *	correlationMatrix (const char *cutSpec=0, const char *cutRange=0) const
TMatrixDSym *	correlationMatrix (const RooArgList &vars, const char *cutSpec=0, const char *cutRange=0) const
Double_t	covariance (RooRealVar &x, RooRealVar &y, const char *cutSpec=0, const char *cutRange=0) const
TMatrixDSym *	covarianceMatrix (const char *cutSpec=0, const char *cutRange=0) const
TMatrixDSym *	covarianceMatrix (const RooArgList &vars, const char *cutSpec=0, const char *cutRange=0) const
TH1 *	createHistogram (const char *name, const RooAbsRealLValue &xvar, const RooCmdArg &arg1=RooCmdArg::none(), const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none()) const
	Calls createHistogram(const char *name, const RooAbsRealLValue& xvar, const RooLinkedList& argList) const.
TH1 *	createHistogram (const char *name, const RooAbsRealLValue &xvar, const RooLinkedList &argList) const
	Create and fill a ROOT histogram TH1,TH2 or TH3 with the values of this dataset.
TH1 *	createHistogram (const char *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 dataset for the variables with given names The range of each observable that is histogrammed is always automatically calculated from the distribution in the dataset.
virtual Int_t	defaultPrintContents (Option_t *opt) const
	Define default print options, for a given print style.
virtual void	Draw (Option_t *option="")
	Forward draw command to data store.
virtual RooAbsData *	emptyClone (const char *newName=0, const char *newTitle=0, const RooArgSet *vars=0, const char *wgtVarName=0) const =0
virtual void	fill ()
virtual TH1 *	fillHistogram (TH1 *hist, const RooArgList &plotVars, const char *cuts="", const char *cutRange=0) const
	Loop over columns of our tree data and fill the input histogram.
virtual const RooArgSet *	get () const
virtual const RooArgSet *	get (Int_t index) const
RealSpans	getBatches (std::size_t first=0, std::size_t len=std::numeric_limits< std::size_t >::max()) const
	Write information to retrieve data columns into evalData.spans.
CategorySpans	getCategoryBatches (std::size_t first=0, std::size_t len=std::numeric_limits< std::size_t >::max()) const
TTree *	GetClonedTree () const
	Return a clone of the TTree which stores the data or create such a tree if vector storage is used.
RooArgSet const *	getGlobalObservables () const
	Returns snapshot of global observables stored in this data.
Bool_t	getRange (const RooAbsRealLValue &var, Double_t &lowest, Double_t &highest, Double_t marginFrac=0, Bool_t symMode=kFALSE) const
	Fill Doubles 'lowest' and 'highest' with the lowest and highest value of observable 'var' in this dataset.
RooAbsData *	getSimData (const char *idxstate)
virtual RooSpan< const double >	getWeightBatch (std::size_t first, std::size_t len, bool sumW2=false) const =0
	Return event weights of all events in range [first, first+len).
Bool_t	hasFilledCache () const
virtual Bool_t	isNonPoissonWeighted () const
virtual Bool_t	isWeighted () const
Double_t	kurtosis (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
Double_t	mean (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
RooRealVar *	meanVar (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
	Create a RooRealVar containing the mean of observable 'var' in this dataset.
Double_t	moment (const RooRealVar &var, Double_t order, const char *cutSpec=0, const char *cutRange=0) const
	Calculate moment of requested order.
Double_t	moment (const RooRealVar &var, Double_t order, Double_t offset, const char *cutSpec=0, const char *cutRange=0) const
	Return the 'order'-ed moment of observable 'var' in this dataset.
const TNamed *	namePtr () const
	De-duplicated pointer to this object's name.
virtual Int_t	numEntries () const
	Return number of entries in dataset, i.e., count unweighted entries.
RooAbsData &	operator= (const RooAbsData &other)
virtual RooPlot *	plotOn (RooPlot *frame, const RooCmdArg &arg1=RooCmdArg::none(), const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none()) const
virtual RooPlot *	plotOn (RooPlot *frame, const RooLinkedList &cmdList) const
	Plot dataset on specified frame.
virtual void	Print (Option_t *options=0) const
	Print TNamed name and title.
virtual void	printClassName (std::ostream &os) const
	Print class name of dataset.
void	printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
	Interface for detailed printing of object.
virtual void	printName (std::ostream &os) const
	Print name of dataset.
virtual void	printTitle (std::ostream &os) const
	Print title of dataset.
virtual void	RecursiveRemove (TObject *obj)
	If one of the TObject we have a referenced to is deleted, remove the reference.
RooAbsData *	reduce (const char *cut)
	Create a subset of the data set by applying the given cut on the data points.
RooAbsData *	reduce (const RooArgSet &varSubset, const char *cut=0)
	Create a subset of the data set by applying the given cut on the data points and reducing the dimensions to the specified set.
RooAbsData *	reduce (const RooArgSet &varSubset, const RooFormulaVar &cutVar)
	Create a subset of the data set by applying the given cut on the data points and reducing the dimensions to the specified set.
RooAbsData *	reduce (const RooCmdArg &arg1, const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg())
	Create a reduced copy of this dataset.
RooAbsData *	reduce (const RooFormulaVar &cutVar)
	Create a subset of the data set by applying the given cut on the data points.
virtual void	reset ()
void	resetBuffers ()
RooRealVar *	rmsVar (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
	Create a RooRealVar containing the RMS of observable 'var' in this dataset.
void	setDirtyProp (Bool_t flag)
	Control propagation of dirty flags from observables in dataset.
void	setGlobalObservables (RooArgSet const &globalObservables)
	Sets the global observables stored in this data.
void	SetName (const char *name)
	Set the name of the TNamed.
void	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title).
Double_t	sigma (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
Double_t	skewness (const RooRealVar &var, const char *cutSpec=0, const char *cutRange=0) const
virtual TList *	split (const RooAbsCategory &splitCat, Bool_t createEmptyDataSets=kFALSE) const
	Split dataset into subsets based on states of given splitCat in this dataset.
virtual TList *	split (const RooSimultaneous &simpdf, Bool_t createEmptyDataSets=kFALSE) const
	Split dataset into subsets based on the categorisation of the RooSimultaneous A TList of RooDataSets is returned in which each RooDataSet is named after the state name of splitCat of which it contains the dataset subset.
Double_t	standMoment (const RooRealVar &var, Double_t order, const char *cutSpec=0, const char *cutRange=0) const
	Calculate standardized moment.
virtual RooPlot *	statOn (RooPlot *frame, const char *what, const char *label="", Int_t sigDigits=2, Option_t *options="NELU", Double_t xmin=0.15, Double_t xmax=0.65, Double_t ymax=0.85, const char *cutSpec=0, const char *cutRange=0, const RooCmdArg *formatCmd=0)
	Implementation back-end of statOn() method with named arguments.
virtual RooPlot *	statOn (RooPlot *frame, const RooCmdArg &arg1=RooCmdArg::none(), const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none())
	Add a box with statistics information to the specified frame.
RooAbsDataStore *	store ()
const RooAbsDataStore *	store () const
virtual Double_t	sumEntries () const =0
	Return effective number of entries in dataset, i.e., sum all weights.
virtual Double_t	sumEntries (const char *cutSpec, const char *cutRange=0) const =0
	Return effective number of entries in dataset inside range or after cuts, i.e.
double	sumEntriesW2 () const
	Return sum of squared weights of this data.
virtual Roo1DTable *	table (const RooAbsCategory &cat, const char *cuts="", const char *opts="") const
	Create and fill a 1-dimensional table for given category column This functions is the equivalent of plotOn() for category dimensions.
virtual Roo1DTable *	table (const RooArgSet &catSet, const char *cuts="", const char *opts="") const
	Construct table for product of categories in catSet.
const TTree *	tree () const
	Return a pointer to the TTree which stores the data.
virtual Bool_t	valid () const
virtual Double_t	weight () const =0
virtual void	weightError (double &lo, double &hi, ErrorType=Poisson) const
	Return the asymmetric errors on the current weight.
virtual double	weightError (ErrorType=Poisson) const
	Return the symmetric error on the current weight.
virtual Double_t	weightSquared () const =0
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed copy ctor.
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
	TNamed destructor.
virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.
virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.
virtual void	Copy (TObject &named) const
	Copy this to obj.
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
virtual const char *	GetName () const
	Returns name of object.
virtual const char *	GetTitle () const
	Returns title of object.
virtual ULong_t	Hash () const
	Return hash value for this object.
virtual Bool_t	IsSortable () const
virtual void	ls (Option_t *option="") const
	List TNamed name and title.
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.
Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.
	TObject (const TObject &object)
	TObject copy ctor.
virtual	~TObject ()
	TObject destructor.
void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.
ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char *	ClassName () const
	Returns name of class to which the object belongs.
virtual void	Delete (Option_t *option="")
	Delete this object.
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
virtual void	Dump () const
	Dump contents of object on stdout.
virtual void	Error (const char *method, const char *msgfmt,...) const
	Issue error message.
virtual void	Execute (const char *method, const char *params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message.
virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
virtual const char *	GetIconName () const
	Returns mime type name of object.
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).
virtual Option_t *	GetOption () const
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void	Info (const char *method, const char *msgfmt,...) const
	Issue info message.
virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".
virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.
virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.
void	InvertBit (UInt_t f)
Bool_t	IsDestructed () const
	IsDestructed.
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).
virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete[] (void *ptr)
	Operator delete [].
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)
TObject &	operator= (const TObject &rhs)
	TObject assignment operator.
virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.
virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
void	ResetBit (UInt_t f)
virtual void	SaveAs (const char *filename="", Option_t *option="") const
	Save this object in the file specified by filename.
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
virtual void	Warning (const char *method, const char *msgfmt,...) const
	Issue warning message.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.
Public Member Functions inherited from RooPrintable
	RooPrintable ()
virtual	~RooPrintable ()
virtual StyleOption	defaultPrintStyle (Option_t *opt) const
virtual void	printAddress (std::ostream &os) const
	Print class name of object.
virtual void	printArgs (std::ostream &os) const
	Interface for printing of object arguments.
virtual void	printExtras (std::ostream &os) const
	Interface to print extras of object.
virtual void	printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
	Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'.
virtual void	printTree (std::ostream &os, TString indent="") const
	Interface for tree structure printing of object.
virtual void	printValue (std::ostream &os) const
	Interface to print value of object.

Static Public Member Functions
static void	claimVars (RooAbsData *)
static StorageType	getDefaultStorageType ()
static Bool_t	releaseVars (RooAbsData *)
	If return value is true variables can be deleted.
static void	setDefaultStorageType (StorageType s)
Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.
static Bool_t	GetObjectStat ()
	Get status of object stat flag.
static void	SetDtorOnly (void *obj)
	Set destructor only flag.
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.
Static Public Member Functions inherited from RooPrintable
static std::ostream &	defaultPrintStream (std::ostream *os=0)
	Return a reference to the current default stream to use in Print().
static void	nameFieldLength (Int_t newLen)
	Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.

Protected Member Functions
Bool_t	allClientsCached (RooAbsArg *, const RooArgSet &)
	Utility function that determines if all clients of object 'var' appear in given list of cached nodes.
virtual void	attachCache (const RooAbsArg *newOwner, const RooArgSet &cachedVars)
	Internal method – Attach dataset copied with cache contents to copied instances of functions.
virtual void	cacheArgs (const RooAbsArg *owner, RooArgSet &varSet, const RooArgSet *nset=0, Bool_t skipZeroWeights=kFALSE)
	Internal method – Cache given set of functions with data.
virtual RooAbsData *	cacheClone (const RooAbsArg *newCacheOwner, const RooArgSet *newCacheVars, const char *newName=0)=0
Double_t	corrcov (const RooRealVar &x, const RooRealVar &y, const char *cutSpec, const char *cutRange, Bool_t corr) const
	Internal method to calculate single correlation and covariance elements.
TMatrixDSym *	corrcovMatrix (const RooArgList &vars, const char *cutSpec, const char *cutRange, Bool_t corr) const
	Return covariance matrix from data for given list of observables.
RooRealVar *	dataRealVar (const char *methodname, const RooRealVar &extVar) const
	Internal method to check if given RooRealVar maps to a RooRealVar in this dataset.
virtual void	optimizeReadingWithCaching (RooAbsArg &arg, const RooArgSet &cacheList, const RooArgSet &keepObsList)
	Prepare dataset for use with cached constant terms listed in 'cacheList' of expression 'arg'.
virtual RooPlot *	plotAsymOn (RooPlot *frame, const RooAbsCategoryLValue &asymCat, PlotOpt o) const
	Create and fill a histogram with the asymmetry N[+] - N[-] / ( N[+] + N[-] ), where N(+/-) is the number of data points with asymCat=+1 and asymCat=-1 as function of the frames variable.
virtual RooPlot *	plotEffOn (RooPlot *frame, const RooAbsCategoryLValue &effCat, PlotOpt o) const
	Create and fill a histogram with the efficiency N[1] / ( N[1] + N[0] ), where N(1/0) is the number of data points with effCat=1 and effCat=0 as function of the frames variable.
virtual RooPlot *	plotOn (RooPlot *frame, PlotOpt o) const
	Create and fill a histogram of the frame's variable and append it to the frame.
virtual RooAbsData *	reduceEng (const RooArgSet &varSubset, const RooFormulaVar *cutVar, const char *cutRange=0, std::size_t nStart=0, std::size_t=std::numeric_limits< std::size_t >::max(), Bool_t copyCache=kTRUE)=0
virtual void	resetCache ()
	Internal method – Remove cached function values.
virtual void	setArgStatus (const RooArgSet &set, Bool_t active)
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()

Protected Attributes
RooArgSet	_cachedVars
RooAbsDataStore *	_dstore
	External variables cached with this data set.
std::unique_ptr< RooArgSet >	_globalObservables
const TNamed *	_namePtr
std::map< std::string, RooAbsData * >	_ownedComponents
RooArgSet	_vars
StorageType	storageType
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle

Static Protected Attributes
static StorageType	defaultStorageType =RooAbsData::Vector
Static Protected Attributes inherited from RooPrintable
static Int_t	_nameLength

Private Member Functions
void	copyGlobalObservables (const RooAbsData &other)
	De-duplicated name pointer. This will be equal for all objects with the same name.

Friends
class	RooAbsArg
class	RooAbsCachedPdf
class	RooAbsOptTestStatistic
class	RooAbsReal
struct	RooFit::TestStatistics::ConstantTermsOptimizer
class	RooFit::TestStatistics::RooAbsL

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <RooAbsData.h>

Inheritance diagram for RooAbsData:

Member Typedef Documentation

CategorySpans

using RooAbsData::CategorySpans = std::map<RooFit::Detail::DataKey, RooSpan<const RooAbsCategory::value_type> >

Definition at line 160 of file RooAbsData.h.

RealSpans

using RooAbsData::RealSpans = std::map<RooFit::Detail::DataKey, RooSpan<const double> >

Definition at line 159 of file RooAbsData.h.

Member Enumeration Documentation

ErrorType

enum RooAbsData::ErrorType

Enumerator
Poisson
SumW2
None
Auto
Expected

Definition at line 136 of file RooAbsData.h.

StorageType

enum RooAbsData::StorageType

Enumerator
Tree
Vector
Composite

Definition at line 305 of file RooAbsData.h.

Constructor & Destructor Documentation

RooAbsData() [1/3]

RooAbsData::RooAbsData

(

)

Default constructor.

Definition at line 173 of file RooAbsData.cxx.

RooAbsData() [2/3]

RooAbsData::RooAbsData	(	std::string_view	name,
		std::string_view	title,
		const RooArgSet &	vars,
		RooAbsDataStore *	dstore = 0
	)

Constructor from a set of variables.

Only fundamental elements of vars (RooRealVar,RooCategory etc) are stored as part of the dataset

Definition at line 186 of file RooAbsData.cxx.

RooAbsData() [3/3]

RooAbsData::RooAbsData	(	const RooAbsData &	other,
		const char *	newname = 0
	)

Copy constructor.

Definition at line 228 of file RooAbsData.cxx.

~RooAbsData()

RooAbsData::~RooAbsData ( )

virtual

Destructor.

Definition at line 328 of file RooAbsData.cxx.

Member Function Documentation

add()

virtual void RooAbsData::add ( const RooArgSet &  row, Double_t  weight = 1, Double_t  weightError = 0  )

pure virtual

Implemented in RooDataHist, and RooDataSet.

addOwnedComponent()

void RooAbsData::addOwnedComponent	(	const char *	idxlabel,
		RooAbsData &	data
	)

Definition at line 2476 of file RooAbsData.cxx.

allClientsCached()

Bool_t RooAbsData::allClientsCached ( RooAbsArg *  var, const RooArgSet &  cacheList  )

protected

Utility function that determines if all clients of object 'var' appear in given list of cached nodes.

Definition at line 2426 of file RooAbsData.cxx.

attachBuffers()

void RooAbsData::attachBuffers

(

const RooArgSet &

extObs

)

Definition at line 2443 of file RooAbsData.cxx.

attachCache()

void RooAbsData::attachCache ( const RooAbsArg *  newOwner, const RooArgSet &  cachedVars  )

protectedvirtual

Internal method – Attach dataset copied with cache contents to copied instances of functions.

Definition at line 421 of file RooAbsData.cxx.

cacheArgs()

void RooAbsData::cacheArgs ( const RooAbsArg *  owner, RooArgSet &  varSet, const RooArgSet *  nset = 0, Bool_t  skipZeroWeights = kFALSE  )

protectedvirtual

Internal method – Cache given set of functions with data.

Definition at line 404 of file RooAbsData.cxx.

cacheClone()

virtual RooAbsData * RooAbsData::cacheClone ( const RooAbsArg *  newCacheOwner, const RooArgSet *  newCacheVars, const char *  newName = 0  )

protectedpure virtual

Implemented in RooDataHist, and RooDataSet.

canSplitFast()

Bool_t RooAbsData::canSplitFast

(

)

const

Definition at line 2457 of file RooAbsData.cxx.

changeObservableName()

Bool_t RooAbsData::changeObservableName ( const char *  from, const char *  to  )

virtual

Definition at line 361 of file RooAbsData.cxx.

checkInit()

void RooAbsData::checkInit

(

)

const

Definition at line 2502 of file RooAbsData.cxx.

claimVars()

void RooAbsData::claimVars ( RooAbsData *  data )

static

Definition at line 151 of file RooAbsData.cxx.

convertToTreeStore()

void RooAbsData::convertToTreeStore ( )

virtual

Convert vector-based storage to tree-based storage.

Reimplemented in RooDataSet.

Definition at line 2556 of file RooAbsData.cxx.

convertToVectorStore()

void RooAbsData::convertToVectorStore

(

)

Convert tree-based storage to vector-based storage.

Definition at line 350 of file RooAbsData.cxx.

copyGlobalObservables()

void RooAbsData::copyGlobalObservables ( const RooAbsData &  other )

private

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

Definition at line 314 of file RooAbsData.cxx.

corrcov()

Double_t RooAbsData::corrcov ( const RooRealVar &  x, const RooRealVar &  y, const char *  cutSpec, const char *  cutRange, Bool_t  corr  ) const

protected

Internal method to calculate single correlation and covariance elements.

Definition at line 981 of file RooAbsData.cxx.

corrcovMatrix()

TMatrixDSym * RooAbsData::corrcovMatrix ( const RooArgList &  vars, const char *  cutSpec, const char *  cutRange, Bool_t  corr  ) const

protected

Return covariance matrix from data for given list of observables.

Definition at line 1037 of file RooAbsData.cxx.

correlation()

Double_t RooAbsData::correlation ( RooRealVar &  x, RooRealVar &  y, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 274 of file RooAbsData.h.

correlationMatrix() [1/2]

TMatrixDSym * RooAbsData::correlationMatrix ( const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 277 of file RooAbsData.h.

correlationMatrix() [2/2]

TMatrixDSym * RooAbsData::correlationMatrix ( const RooArgList &  vars, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 279 of file RooAbsData.h.

covariance()

Double_t RooAbsData::covariance ( RooRealVar &  x, RooRealVar &  y, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 273 of file RooAbsData.h.

covarianceMatrix() [1/2]

TMatrixDSym * RooAbsData::covarianceMatrix ( const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 276 of file RooAbsData.h.

covarianceMatrix() [2/2]

TMatrixDSym * RooAbsData::covarianceMatrix ( const RooArgList &  vars, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 278 of file RooAbsData.h.

createHistogram() [1/3]

RooAbsData::createHistogram	(	const char *	name,
		const RooAbsRealLValue &	xvar,
		const RooCmdArg &	arg1 = RooCmdArg::none(),
		const RooCmdArg &	arg2 = RooCmdArg::none(),
		const RooCmdArg &	arg3 = RooCmdArg::none(),
		const RooCmdArg &	arg4 = RooCmdArg::none(),
		const RooCmdArg &	arg5 = RooCmdArg::none(),
		const RooCmdArg &	arg6 = RooCmdArg::none(),
		const RooCmdArg &	arg7 = RooCmdArg::none(),
		const RooCmdArg &	arg8 = RooCmdArg::none()
	)		const

Calls createHistogram(const char *name, const RooAbsRealLValue& xvar, const RooLinkedList& argList) const.

PyROOT

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

Definition at line 687 of file RooAbsData.cxx.

createHistogram() [2/3]

TH1 * RooAbsData::createHistogram	(	const char *	name,
		const RooAbsRealLValue &	xvar,
		const RooLinkedList &	argListIn
	)		const

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

This function accepts the following arguments.

Parameters

[in]	name	Name of the ROOT histogram
[in]	xvar	Observable to be mapped on x axis of ROOT histogram

Returns

Histogram now owned by user.

AutoBinning(Int_t nbins, Double_y margin)	Automatically calculate range with given added fractional margin, set binning to nbins
AutoSymBinning(Int_t nbins, Double_y margin)	Automatically calculate range with given added fractional margin, with additional constraint that mean of data is in center of range, set binning to nbins
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
YVar(const RooAbsRealLValue& var,...)	Observable to be mapped on y axis of ROOT histogram
ZVar(const RooAbsRealLValue& var,...)	Observable to be mapped on z axis of ROOT histogram

The YVar() and ZVar() arguments can be supplied with optional Binning() Auto(Sym)Range() 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")))

The caller takes ownership of the returned histogram

Definition at line 727 of file RooAbsData.cxx.

createHistogram() [3/3]

TH1 * RooAbsData::createHistogram	(	const char *	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 dataset for the variables with given names The range of each observable that is histogrammed is always automatically calculated from the distribution in the dataset.

The number of bins can be controlled using the [xyz]bins parameters. For a greater degree of control use the createHistogram() method below with named arguments

The caller takes ownership of the returned histogram

Definition at line 629 of file RooAbsData.cxx.

dataRealVar()

RooRealVar * RooAbsData::dataRealVar ( const char *  methodname, const RooRealVar &  extVar  ) const

protected

Internal method to check if given RooRealVar maps to a RooRealVar in this dataset.

Definition at line 962 of file RooAbsData.cxx.

defaultPrintContents()

Int_t RooAbsData::defaultPrintContents ( Option_t *  opt ) const

virtual

Define default print options, for a given print style.

Reimplemented from RooPrintable.

Definition at line 871 of file RooAbsData.cxx.

Draw()

void RooAbsData::Draw ( Option_t *  option = "" )

virtual

Forward draw command to data store.

Reimplemented from TObject.

Definition at line 2510 of file RooAbsData.cxx.

emptyClone()

virtual RooAbsData * RooAbsData::emptyClone ( const char *  newName = 0, const char *  newTitle = 0, const RooArgSet *  vars = 0, const char *  wgtVarName = 0  ) const

pure virtual

Implemented in RooDataHist, and RooDataSet.

fill()

void RooAbsData::fill ( )

virtual

Definition at line 374 of file RooAbsData.cxx.

fillHistogram()

TH1 * RooAbsData::fillHistogram ( TH1 *  hist, const RooArgList &  plotVars, const char *  cuts = "", const char *  cutRange = 0  ) const

virtual

Loop over columns of our tree data and fill the input histogram.

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.

Definition at line 1350 of file RooAbsData.cxx.

get() [1/2]

virtual const RooArgSet * RooAbsData::get ( ) const

inlinevirtual

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 128 of file RooAbsData.h.

get() [2/2]

const RooArgSet * RooAbsData::get ( Int_t  index ) const

virtual

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 395 of file RooAbsData.cxx.

getBatches()

RooAbsData::RealSpans RooAbsData::getBatches	(	std::size_t	begin = 0,
		std::size_t	len = std::numeric_limits<std::size_t>::max()
	)		const

Write information to retrieve data columns into evalData.spans.

All spans belonging to variables of this dataset are overwritten. Spans to other variables remain intact.

Parameters

[out]	evalData	Store references to all data batches in this struct's spans. The key to retrieve an item is the pointer of the variable that owns the data.
	first	Index of first event that ends up in the batch.
	len	Number of events in each batch.

Definition at line 2650 of file RooAbsData.cxx.

getCategoryBatches()

RooAbsData::CategorySpans RooAbsData::getCategoryBatches	(	std::size_t	first = 0,
		std::size_t	len = std::numeric_limits<std::size_t>::max()
	)		const

Definition at line 2655 of file RooAbsData.cxx.

GetClonedTree()

TTree * RooAbsData::GetClonedTree

(

)

const

Return a clone of the TTree which stores the data or create such a tree if vector storage is used.

The user is responsible for deleting the tree

Definition at line 2542 of file RooAbsData.cxx.

getDefaultStorageType()

RooAbsData::StorageType RooAbsData::getDefaultStorageType ( )

static

Definition at line 144 of file RooAbsData.cxx.

getGlobalObservables()

RooArgSet const * RooAbsData::getGlobalObservables ( ) const

inline

Returns snapshot of global observables stored in this data.

Returns

Pointer to a RooArgSet with the snapshot of global observables stored in the data. Can be nullptr if no global observales are stored.

Definition at line 315 of file RooAbsData.h.

getRange()

Bool_t RooAbsData::getRange	(	const RooAbsRealLValue &	var,
		Double_t &	lowest,
		Double_t &	highest,
		Double_t	marginFrac = 0,
		Bool_t	symMode = kFALSE
	)		const

Fill Doubles 'lowest' and 'highest' with the lowest and highest value of observable 'var' in this dataset.

If the return value is kTRUE and error occurred

Definition at line 2298 of file RooAbsData.cxx.

getSimData()

RooAbsData * RooAbsData::getSimData

(

const char *

idxstate

)

Definition at line 2467 of file RooAbsData.cxx.

getWeightBatch()

virtual RooSpan< const double > RooAbsData::getWeightBatch ( std::size_t  first, std::size_t  len, bool  sumW2 = false  ) const

pure virtual

Return event weights of all events in range [first, first+len).

If no contiguous structure of weights is stored, an empty batch can be returned. This indicates that the weight is constant. Use weight() to retrieve it.

Implemented in RooDataSet, and RooDataHist.

hasFilledCache()

Bool_t RooAbsData::hasFilledCache

(

)

const

Definition at line 2517 of file RooAbsData.cxx.

isNonPoissonWeighted()

virtual Bool_t RooAbsData::isNonPoissonWeighted ( ) const

inlinevirtual

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 184 of file RooAbsData.h.

isWeighted()

virtual Bool_t RooAbsData::isWeighted ( ) const

inlinevirtual

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 180 of file RooAbsData.h.

kurtosis()

Double_t RooAbsData::kurtosis ( const RooRealVar &  var, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 271 of file RooAbsData.h.

mean()

Double_t RooAbsData::mean ( const RooRealVar &  var, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 268 of file RooAbsData.h.

meanVar()

RooRealVar * RooAbsData::meanVar	(	const RooRealVar &	var,
		const char *	cutSpec = 0,
		const char *	cutRange = 0
	)		const

Create a RooRealVar containing the mean of observable 'var' in this dataset.

If cutSpec and/or cutRange are specified the moment is calculated on the subset of the data which pass the C++ cut specification expression 'cutSpec' and/or are inside the range named 'cutRange'

Definition at line 1133 of file RooAbsData.cxx.

moment() [1/2]

Double_t RooAbsData::moment	(	const RooRealVar &	var,
		Double_t	order,
		const char *	cutSpec = 0,
		const char *	cutRange = 0
	)		const

Calculate moment of requested order.

Parameters

[in]	var	Variable to be used for calculating the moment.
[in]	order	Order of the moment.
[in]	cutSpec	If specified, the moment is calculated on the subset of the data which pass the C++ cut specification expression 'cutSpec'
[in]	cutRange	If specified, calculate inside the range named 'cutRange' (also applies cut spec)

Returns

\( \left< \left( X - \left< X \right> \right)^n \right> \) of order \(n\).

Definition at line 904 of file RooAbsData.cxx.

moment() [2/2]

Double_t RooAbsData::moment	(	const RooRealVar &	var,
		Double_t	order,
		Double_t	offset,
		const char *	cutSpec = 0,
		const char *	cutRange = 0
	)		const

Return the 'order'-ed moment of observable 'var' in this dataset.

If offset is non-zero it is subtracted from the values of 'var' prior to the moment calculation. If cutSpec and/or cutRange are specified the moment is calculated on the subset of the data which pass the C++ cut specification expression 'cutSpec' and/or are inside the range named 'cutRange'

Definition at line 917 of file RooAbsData.cxx.

namePtr()

const TNamed * RooAbsData::namePtr ( ) const

inline

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 324 of file RooAbsData.h.

numEntries()

Int_t RooAbsData::numEntries ( ) const

virtual

Return number of entries in dataset, i.e., count unweighted entries.

Reimplemented in RooDataHist.

Definition at line 381 of file RooAbsData.cxx.

operator=()

RooAbsData & RooAbsData::operator=

(

const RooAbsData &

other

)

Definition at line 271 of file RooAbsData.cxx.

optimizeReadingWithCaching()

void RooAbsData::optimizeReadingWithCaching ( RooAbsArg &  arg, const RooArgSet &  cacheList, const RooArgSet &  keepObsList  )

protectedvirtual

Prepare dataset for use with cached constant terms listed in 'cacheList' of expression 'arg'.

Deactivate tree branches for any dataset observable that is either not used at all, or is used exclusively by cached branch nodes.

Definition at line 2363 of file RooAbsData.cxx.

plotAsymOn()

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

protectedvirtual

Create and fill a histogram with the asymmetry N[+] - N[-] / ( N[+] + N[-] ), where N(+/-) is the number of data points with asymCat=+1 and asymCat=-1 as function of the frames variable.

The asymmetry category 'asymCat' must have exactly 2 (or 3) states defined with index values +1,-1 (and 0)

The plot range and the number of plot bins is determined by the parameters of the plot variable of the frame (RooAbsReal::setPlotRange(), RooAbsReal::setPlotBins())

The optional cut string expression can be used to select the events to be plotted. The cut specification may refer to any variable contained in the data set

The drawOptions are passed to the TH1::Draw() method

Definition at line 2062 of file RooAbsData.cxx.

plotEffOn()

RooPlot * RooAbsData::plotEffOn ( RooPlot *  frame, const RooAbsCategoryLValue &  effCat, PlotOpt  o  ) const

protectedvirtual

Create and fill a histogram with the efficiency N[1] / ( N[1] + N[0] ), where N(1/0) is the number of data points with effCat=1 and effCat=0 as function of the frames variable.

The efficiency category 'effCat' must have exactly 2 +1 and 0.

The plot range and the number of plot bins is determined by the parameters of the plot variable of the frame (RooAbsReal::setPlotRange(), RooAbsReal::setPlotBins())

The optional cut string expression can be used to select the events to be plotted. The cut specification may refer to any variable contained in the data set

The drawOptions are passed to the TH1::Draw() method

Definition at line 2152 of file RooAbsData.cxx.

plotOn() [1/3]

RooAbsData::plotOn ( RooPlot *  frame, const RooCmdArg &  arg1 = RooCmdArg::none(), const RooCmdArg &  arg2 = RooCmdArg::none(), const RooCmdArg &  arg3 = RooCmdArg::none(), const RooCmdArg &  arg4 = RooCmdArg::none(), const RooCmdArg &  arg5 = RooCmdArg::none(), const RooCmdArg &  arg6 = RooCmdArg::none(), const RooCmdArg &  arg7 = RooCmdArg::none(), const RooCmdArg &  arg8 = RooCmdArg::none()  ) const

virtual

See also

RooPlot* plotOn(RooPlot* frame, const RooLinkedList& cmdList) const

PyROOT

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

Reimplemented in RooDataHist.

Definition at line 609 of file RooAbsData.cxx.

plotOn() [2/3]

RooPlot * RooAbsData::plotOn ( RooPlot *  frame, const RooLinkedList &  argList  ) const

virtual

Plot dataset on specified frame.

By default:

• An unbinned dataset will use the default binning of the target frame.
• A binned dataset will retain its intrinsic binning.

The following optional named arguments can be used to modify the behaviour:

Note

Please follow the function links in the left column to learn about PyROOT specifics for a given option.

	Data representation options
RooFit::Asymmetry(const RooCategory& c)	Show the asymmetry of the data in given two-state category [F(+)-F(-)] / [F(+)+F(-)]. Category must have two states with indices -1 and +1 or three states with indices -1,0 and +1.
RooFit::Efficiency(const RooCategory& c)	Show the efficiency F(acc)/[F(acc)+F(rej)]. Category must have two states with indices 0 and 1
RooFit::DataError(Int_t)	Select the type of error drawn: Auto(default) results in Poisson for unweighted data and SumW2 for weighted data Poisson draws asymmetric Poisson confidence intervals. SumW2 draws symmetric sum-of-weights error ( \( \left( \sum w \right)^2 / \sum\left(w^2\right) \) ) None draws no error bars
RooFit::Binning(int nbins, double xlo, double xhi)	Use specified binning to draw dataset
RooFit::Binning(const RooAbsBinning&)	Use specified binning to draw dataset
RooFit::Binning(const char* name)	Use binning with specified name to draw dataset
RooFit::RefreshNorm()	Force refreshing for PDF normalization information in frame. If set, any subsequent PDF will normalize to this dataset, even if it is not the first one added to the frame. By default only the 1st dataset added to a frame will update the normalization information
RooFit::Rescale(Double_t f)	Rescale drawn histogram by given factor.
RooFit::Cut(const char*)	Only plot entries that pass the given cut. Apart from cutting in continuous variables Cut("x>5"), this can also be used to plot a specific category state. Use something like Cut("myCategory == myCategory::stateA"), where myCategory resolves to the state number for a given entry and myCategory::stateA resolves to the state number of the state named "stateA".
RooFit::CutRange(const char*)	Only plot data from given range. Separate multiple ranges with ",". Note This often requires passing the normalisation when plotting the PDF because RooFit does not save how many events were being plotted (it will only work for cutting slices out of uniformly distributed variables). data->plotOn(frame01, CutRange("SB1")); const double nData = data->sumEntries("", "SB1"); // Make clear that the target normalisation is nData. The enumerator NumEvent // is needed to switch between relative and absolute scaling. model.plotOn(frame01, Normalization(nData, RooAbsReal::NumEvent), ProjectionRange("SB1"));
	Histogram drawing options
RooFit::DrawOption(const char* opt)	Select ROOT draw option for resulting TGraph object
RooFit::LineStyle(Style_t style)	Select line style by ROOT line style code, default is solid
RooFit::LineColor(Color_t color)	Select line color by ROOT color code, default is black
RooFit::LineWidth(Width_t width)	Select line with in pixels, default is 3
RooFit::MarkerStyle(Style_t style)	Select the ROOT marker style, default is 21
RooFit::MarkerColor(Color_t color)	Select the ROOT marker color, default is black
RooFit::MarkerSize(Size_t size)	Select the ROOT marker size
RooFit::FillStyle(Style_t style)	Select fill style, default is filled.
RooFit::FillColor(Color_t color)	Select fill color by ROOT color code
RooFit::XErrorSize(Double_t frac)	Select size of X error bar as fraction of the bin width, default is 1
	Misc. other options
RooFit::Name(const char* name)	Give curve specified name in frame. Useful if curve is to be referenced later
RooFit::Invisible()	Add curve to frame, but do not display. Useful in combination AddTo()
RooFit::AddTo(const char* name, double wgtSel, double wgtOther)	Add constructed histogram to already existing histogram with given name and relative weight factors

Reimplemented in RooDataHist.

Definition at line 1809 of file RooAbsData.cxx.

plotOn() [3/3]

RooPlot * RooAbsData::plotOn ( RooPlot *  frame, PlotOpt  o  ) const

protectedvirtual

Create and fill a histogram of the frame's variable and append it to the frame.

The frame variable must be one of the data sets dimensions.

The plot range and the number of plot bins is determined by the parameters of the plot variable of the frame (RooAbsReal::setPlotRange(), RooAbsReal::setPlotBins()).

The optional cut string expression can be used to select the events to be plotted. The cut specification may refer to any variable contained in the data set.

The drawOptions are passed to the TH1::Draw() method.

See also

RooAbsData::plotOn(RooPlot*,const RooLinkedList&) const

Reimplemented in RooDataHist, and RooDataHist.

Definition at line 1940 of file RooAbsData.cxx.

Print()

virtual void RooAbsData::Print ( Option_t *  option = 0 ) const

inlinevirtual

Print TNamed name and title.

Reimplemented from TNamed.

Definition at line 250 of file RooAbsData.h.

printClassName()

void RooAbsData::printClassName ( std::ostream &  os ) const

virtual

Print class name of dataset.

Reimplemented from RooPrintable.

Definition at line 856 of file RooAbsData.cxx.

printMultiline()

void RooAbsData::printMultiline ( std::ostream &  os, Int_t  contents, Bool_t  verbose = kFALSE, TString  indent = ""  ) const

virtual

Interface for detailed printing of object.

Reimplemented from RooPrintable.

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 863 of file RooAbsData.cxx.

printName()

void RooAbsData::printName ( std::ostream &  os ) const

virtual

Print name of dataset.

Reimplemented from RooPrintable.

Definition at line 840 of file RooAbsData.cxx.

printTitle()

void RooAbsData::printTitle ( std::ostream &  os ) const

virtual

Print title of dataset.

Reimplemented from RooPrintable.

Definition at line 848 of file RooAbsData.cxx.

RecursiveRemove()

void RooAbsData::RecursiveRemove ( TObject *  obj )

virtual

If one of the TObject we have a referenced to is deleted, remove the reference.

Reimplemented from TObject.

Definition at line 2570 of file RooAbsData.cxx.

reduce() [1/5]

RooAbsData * RooAbsData::reduce

(

const char *

cut

)

Create a subset of the data set by applying the given cut on the data points.

The cut expression can refer to any variable in the data set. For cuts involving other variables, such as intermediate formula objects, use the equivalent reduce method specifying the as a RooFormulVar reference.

Definition at line 533 of file RooAbsData.cxx.

reduce() [2/5]

RooAbsData * RooAbsData::reduce	(	const RooArgSet &	varSubset,
		const char *	cut = 0
	)

Create a subset of the data set by applying the given cut on the data points and reducing the dimensions to the specified set.

The cut expression can refer to any variable in the data set. For cuts involving other variables, such as intermediate formula objects, use the equivalent reduce method specifying the as a RooFormulVar reference.

Definition at line 561 of file RooAbsData.cxx.

reduce() [3/5]

RooAbsData * RooAbsData::reduce	(	const RooArgSet &	varSubset,
		const RooFormulaVar &	cutVar
	)

Create a subset of the data set by applying the given cut on the data points and reducing the dimensions to the specified set.

The 'cutVar' formula variable is used to select the subset of data points to be retained in the reduced data collection.

Definition at line 591 of file RooAbsData.cxx.

reduce() [4/5]

RooAbsData::reduce	(	const RooCmdArg &	arg1,
		const RooCmdArg &	arg2 = RooCmdArg(),
		const RooCmdArg &	arg3 = RooCmdArg(),
		const RooCmdArg &	arg4 = RooCmdArg(),
		const RooCmdArg &	arg5 = RooCmdArg(),
		const RooCmdArg &	arg6 = RooCmdArg(),
		const RooCmdArg &	arg7 = RooCmdArg(),
		const RooCmdArg &	arg8 = RooCmdArg()
	)

Create a reduced copy of this dataset.

The caller takes ownership of the returned dataset

The following optional named arguments are accepted

SelectVars(const RooArgSet& vars)	Only retain the listed observables in the output dataset
Cut(const char* expression)	Only retain event surviving the given cut expression
Cut(const RooFormulaVar& expr)	Only retain event surviving the given cut formula
CutRange(const char* name)	Only retain events inside range with given name. Multiple CutRange arguments may be given to select multiple ranges
EventRange(int lo, int hi)	Only retain events with given sequential event numbers
Name(const char* name)	Give specified name to output dataset
Title(const char* name)	Give specified title to output dataset

PyROOT

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

Definition at line 456 of file RooAbsData.cxx.

reduce() [5/5]

RooAbsData * RooAbsData::reduce

(

const RooFormulaVar &

cutVar

)

Create a subset of the data set by applying the given cut on the data points.

The 'cutVar' formula variable is used to select the subset of data points to be retained in the reduced data collection.

Definition at line 546 of file RooAbsData.cxx.

reduceEng()

virtual RooAbsData * RooAbsData::reduceEng ( const RooArgSet &  varSubset, const RooFormulaVar *  cutVar, const char *  cutRange = 0, std::size_t  nStart = 0, std::size_t  = std::numeric_limits< std::size_t >::max(), Bool_t  copyCache = kTRUE  )

protectedpure virtual

Implemented in RooDataHist, and RooDataSet.

releaseVars()

Bool_t RooAbsData::releaseVars ( RooAbsData *  data )

static

If return value is true variables can be deleted.

Definition at line 160 of file RooAbsData.cxx.

reset()

void RooAbsData::reset ( )

virtual

Reimplemented in RooDataHist.

Definition at line 388 of file RooAbsData.cxx.

resetBuffers()

void RooAbsData::resetBuffers

(

)

Definition at line 2450 of file RooAbsData.cxx.

resetCache()

void RooAbsData::resetCache ( )

protectedvirtual

Internal method – Remove cached function values.

Definition at line 412 of file RooAbsData.cxx.

rmsVar()

RooRealVar * RooAbsData::rmsVar	(	const RooRealVar &	var,
		const char *	cutSpec = 0,
		const char *	cutRange = 0
	)		const

Create a RooRealVar containing the RMS of observable 'var' in this dataset.

If cutSpec and/or cutRange are specified the moment is calculated on the subset of the data which pass the C++ cut specification expression 'cutSpec' and/or are inside the range named 'cutRange'

Definition at line 1169 of file RooAbsData.cxx.

setArgStatus()

void RooAbsData::setArgStatus ( const RooArgSet &  set, Bool_t  active  )

protectedvirtual

Definition at line 428 of file RooAbsData.cxx.

setDefaultStorageType()

void RooAbsData::setDefaultStorageType ( RooAbsData::StorageType  s )

static

Definition at line 133 of file RooAbsData.cxx.

setDirtyProp()

void RooAbsData::setDirtyProp

(

Bool_t

flag

)

Control propagation of dirty flags from observables in dataset.

Definition at line 436 of file RooAbsData.cxx.

setGlobalObservables()

void RooAbsData::setGlobalObservables

(

RooArgSet const &

globalObservables

)

Sets the global observables stored in this data.

A snapshot of the observables will be saved.

Parameters

[in]

globalObservables

The set of global observables to take a snapshot of.

Definition at line 2585 of file RooAbsData.cxx.

SetName()

void RooAbsData::SetName ( const char *  name )

virtual

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.

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 2600 of file RooAbsData.cxx.

SetNameTitle()

void RooAbsData::SetNameTitle ( const char *  name, const char *  title  )

virtual

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.

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 2617 of file RooAbsData.cxx.

sigma()

Double_t RooAbsData::sigma ( const RooRealVar &  var, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 269 of file RooAbsData.h.

skewness()

Double_t RooAbsData::skewness ( const RooRealVar &  var, const char *  cutSpec = 0, const char *  cutRange = 0  ) const

inline

Definition at line 270 of file RooAbsData.h.

split() [1/2]

TList * RooAbsData::split ( const RooAbsCategory &  splitCat, Bool_t  createEmptyDataSets = kFALSE  ) const

virtual

Split dataset into subsets based on states of given splitCat in this dataset.

A TList of RooDataSets is returned in which each RooDataSet is named after the state name of splitCat of which it contains the dataset subset. The observables splitCat itself is no longer present in the sub datasets. If createEmptyDataSets is kFALSE (default) this method only creates datasets for states which have at least one entry The caller takes ownership of the returned list and its contents

Definition at line 1524 of file RooAbsData.cxx.

split() [2/2]

TList * RooAbsData::split ( const RooSimultaneous &  simpdf, Bool_t  createEmptyDataSets = kFALSE  ) const

virtual

Split dataset into subsets based on the categorisation of the RooSimultaneous A TList of RooDataSets is returned in which each RooDataSet is named after the state name of splitCat of which it contains the dataset subset.

The observables splitCat itself is no longer present in the sub datasets, as well as the observables of the other categories. If createEmptyDataSets is kFALSE (default) this method only creates datasets for states which have at least one entry The caller takes ownership of the returned list and its contents

Definition at line 1614 of file RooAbsData.cxx.

standMoment()

Double_t RooAbsData::standMoment	(	const RooRealVar &	var,
		Double_t	order,
		const char *	cutSpec = 0,
		const char *	cutRange = 0
	)		const

Calculate standardized moment.

Parameters

[in]	var	Variable to be used for calculating the moment.
[in]	order	Order of the moment.
[in]	cutSpec	If specified, the moment is calculated on the subset of the data which pass the C++ cut specification expression 'cutSpec'
[in]	cutRange	If specified, calculate inside the range named 'cutRange' (also applies cut spec)

Returns

\( \frac{\left< \left( X - \left< X \right> \right)^n \right>}{\sigma^n} \), where n = order.

Definition at line 885 of file RooAbsData.cxx.

statOn() [1/2]

RooPlot * RooAbsData::statOn ( RooPlot *  frame, const char *  what, const char *  label = "", Int_t  sigDigits = 2, Option_t *  options = "NELU", Double_t  xmin = 0.15, Double_t  xmax = 0.65, Double_t  ymax = 0.85, const char *  cutSpec = 0, const char *  cutRange = 0, const RooCmdArg *  formatCmd = 0  )

virtual

Implementation back-end of statOn() method with named arguments.

Definition at line 1279 of file RooAbsData.cxx.

statOn() [2/2]

RooAbsData::statOn ( RooPlot *  frame, const RooCmdArg &  arg1 = RooCmdArg::none(), const RooCmdArg &  arg2 = RooCmdArg::none(), const RooCmdArg &  arg3 = RooCmdArg::none(), const RooCmdArg &  arg4 = RooCmdArg::none(), const RooCmdArg &  arg5 = RooCmdArg::none(), const RooCmdArg &  arg6 = RooCmdArg::none(), const RooCmdArg &  arg7 = RooCmdArg::none(), const RooCmdArg &  arg8 = RooCmdArg::none()  )

virtual

Add a box with statistics information to the specified frame.

By default a box with the event count, mean and rms of the plotted variable is added.

The following optional named arguments are accepted

What(const char* whatstr)	Controls what is printed: "N" = count, "M" is mean, "R" is RMS.
Format(const char* optStr)	Deprecated: Classing parameter formatting options, provided for backward compatibility
Format(const char* what,...)	Parameter formatting options. const char* what Controls what is shown: "N" adds name "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) VerbatimName(Bool_t flag) Put variable name in a \verb+ + clause.
Label(const chat* label)	Add header label to parameter box
Layout(Double_t xmin, Double_t xmax, Double_t ymax)	Specify relative position of left,right side of box and top of box. Position of bottom of box is calculated automatically from number lines in box
Cut(const char* expression)	Apply given cut expression to data when calculating statistics
CutRange(const char* rangeName)	Only consider events within given range when calculating statistics. Multiple CutRange() argument may be specified to combine ranges.

PyROOT

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

Definition at line 1226 of file RooAbsData.cxx.

store() [1/2]

RooAbsDataStore * RooAbsData::store ( )

inline

Definition at line 104 of file RooAbsData.h.

store() [2/2]

const RooAbsDataStore * RooAbsData::store ( ) const

inline

Definition at line 105 of file RooAbsData.h.

sumEntries() [1/2]

virtual Double_t RooAbsData::sumEntries ( ) const

pure virtual

Return effective number of entries in dataset, i.e., sum all weights.

Implemented in RooDataHist, and RooDataSet.

sumEntries() [2/2]

virtual Double_t RooAbsData::sumEntries ( const char *  cutSpec, const char *  cutRange = 0  ) const

pure virtual

Return effective number of entries in dataset inside range or after cuts, i.e.

, sum certain weights.

Parameters

[in]	cutSpec	Apply given cut when counting (e.g. 0 < x && x < 5). Passing "1" selects all events.
[in]	cutRange	If the observables have a range with this name, only count events inside this range.

Implemented in RooDataHist, and RooDataSet.

sumEntriesW2()

double RooAbsData::sumEntriesW2

(

)

const

Return sum of squared weights of this data.

Definition at line 2628 of file RooAbsData.cxx.

table() [1/2]

Roo1DTable * RooAbsData::table ( const RooAbsCategory &  cat, const char *  cuts = "", const char *  opts = ""  ) const

virtual

Create and fill a 1-dimensional table for given category column This functions is the equivalent of plotOn() for category dimensions.

The optional cut string expression can be used to select the events to be tabulated The cut specification may refer to any variable contained in the data set

The option string is currently not used

Definition at line 2237 of file RooAbsData.cxx.

table() [2/2]

Roo1DTable * RooAbsData::table ( const RooArgSet &  catSet, const char *  cuts = "", const char *  opts = ""  ) const

virtual

Construct table for product of categories in catSet.

Definition at line 810 of file RooAbsData.cxx.

tree()

const TTree * RooAbsData::tree

(

)

const

Return a pointer to the TTree which stores the data.

Returns a nullpointer if vector-based storage is used. The RooAbsData remains owner of the tree. GetClonedTree() can be used to get a tree even if the internal storage does not use one.

Definition at line 2527 of file RooAbsData.cxx.

valid()

virtual Bool_t RooAbsData::valid ( ) const

inlinevirtual

Reimplemented in RooDataHist.

Definition at line 134 of file RooAbsData.h.

weight()

virtual Double_t RooAbsData::weight ( ) const

pure virtual

Implemented in RooDataHist, and RooDataSet.

weightError() [1/2]

virtual void RooAbsData::weightError ( double &  lo, double &  hi, ErrorType  = Poisson  ) const

inlinevirtual

Return the asymmetric errors on the current weight.

See also weightError(ErrorType) const for symmetric error.

Parameters

[out]	lo	Low error.
[out]	hi	High error.
[in]	etype	Type of error to compute. May throw if not supported.

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 150 of file RooAbsData.h.

weightError() [2/2]

virtual double RooAbsData::weightError ( ErrorType  = Poisson ) const

inlinevirtual

Return the symmetric error on the current weight.

See also weightError(double&,double&,ErrorType) const for asymmetric errors.

Parameters

[in]

etype

Type of error to compute. May throw if not supported.

Reimplemented in RooDataHist, and RooDataSet.

Definition at line 140 of file RooAbsData.h.

weightSquared()

virtual Double_t RooAbsData::weightSquared ( ) const

pure virtual

Implemented in RooDataHist, and RooDataSet.

Friends And Related Symbol Documentation

RooAbsArg

friend class RooAbsArg

friend

Definition at line 352 of file RooAbsData.h.

RooAbsCachedPdf

friend class RooAbsCachedPdf

friend

Definition at line 355 of file RooAbsData.h.

RooAbsOptTestStatistic

friend class RooAbsOptTestStatistic

friend

Definition at line 354 of file RooAbsData.h.

RooAbsReal

friend class RooAbsReal

friend

Definition at line 353 of file RooAbsData.h.

RooFit::TestStatistics::ConstantTermsOptimizer

friend struct RooFit::TestStatistics::ConstantTermsOptimizer

friend

Definition at line 356 of file RooAbsData.h.

RooFit::TestStatistics::RooAbsL

friend class RooFit::TestStatistics::RooAbsL

friend

Definition at line 358 of file RooAbsData.h.

Member Data Documentation

_cachedVars

RooArgSet RooAbsData::_cachedVars

protected

Definition at line 373 of file RooAbsData.h.

_dstore

RooAbsDataStore* RooAbsData::_dstore

protected

External variables cached with this data set.

Definition at line 375 of file RooAbsData.h.

_globalObservables

std::unique_ptr<RooArgSet> RooAbsData::_globalObservables

protected

Definition at line 379 of file RooAbsData.h.

_namePtr

const TNamed* RooAbsData::_namePtr

mutableprotected

Definition at line 381 of file RooAbsData.h.

_ownedComponents

std::map<std::string,RooAbsData*> RooAbsData::_ownedComponents

protected

Definition at line 377 of file RooAbsData.h.

_vars

RooArgSet RooAbsData::_vars

protected

Definition at line 372 of file RooAbsData.h.

defaultStorageType

RooAbsData::StorageType RooAbsData::defaultStorageType =RooAbsData::Vector

staticprotected

Definition at line 334 of file RooAbsData.h.

storageType

StorageType RooAbsData::storageType

protected

Definition at line 336 of file RooAbsData.h.

Libraries for RooAbsData:

---

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

• roofit/roofitcore/inc/RooAbsData.h
• roofit/roofitcore/src/RooAbsData.cxx
• /home/sftnight/build/workspace/root-makedoc-v626/rootspi/rdoc/v626_TMP/pyzdoc/_roofit.pyzdoc