A version of the TBrowser that can be used to interact with RooFit models and datasets.

Also available under the ROOT::Experimental::RooBrowser alias.

To get started with the xRooBrowser, open any ROOT file containing a workspace and then create an instance of the xRooBrowser just like creating an instance of a TBrowser. A window will be displayed with a navigable tree structure on the left that lets you explore the content of the workspaces present in the loaded file. Note that additional files, including json workspace files, can be loaded through the Browser --> Open menu in the top left corner.

The context menu for each node (access by right clicking on the node) in the tree structure can be used to get more information about the node. In particular, the Draw command can be selected on many of the nodes that are part of a statistical model, which will visualize that part of the model in the browser window. A number of options are available for the Draw command, including (some options can be combined):

"e" : calculate and visualize propagated model uncertainty
"auxratio" : Draw a ratio auxiliary plot below the main plot
"auxsignif" : Draw a significance auxiliary plot below the main plot
"pull" : show panel of current parameter values, which can be dragged in order to change the values and visualize the effect on the model (very experimental feature).

Once a node has been drawn, the styling of subsequent draws can be controlled through TStyle objects that will now appear in the objects folder in the workspace.

A model can be fit to a dataset from the workspace using the fitTo context menu command and specifying the name of a dataset in the workspace (if no name is given, an expected dataset corresponding to the current state of the model will be used). A dialog will display the fit result status code when the fit completes and then a fits folder will be found under the workspace (the workspace may need to be collapsed and re-expanded to make it appear) where the fit result can be found, selected, and visualized. In multi-channel models the channels that are included in the fit can be controlled with the checkboxes in the browser. Clicking the checkbox will cycle through three states: checked, unchecked with grey-underline, and checked with grey-underline. The grey-underline indicates that channel wont be included in the fit (and will appear greyed out when the model is visualized)

Many more features are available in the xRooBrowser, and further documentation and development can be found at the xRooFit repository, which is the library where the browser has been originally developed. The author (Will Buttinger) is also very happy to be contacted with questions or feedback about this new functionality.

Definition at line 30 of file xRooBrowser.h.

Public Member Functions
	xRooBrowser ()

	xRooBrowser (xRooNode *o)

void	cd (const char *path)

xRooNode *	GetSelected ()

void	HandleMenu (Int_t id)

TClass *	IsA () const override

void	ls (const char *path=nullptr) const override
	List TNamed name and title.

xRooNode *	Open (const char *filename)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TBrowser
	TBrowser (const char name, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title, position, width and height.

	TBrowser (const char name, const char title, UInt_t width, UInt_t height, TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title, width and height.

	TBrowser (const char name, TObject obj, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name, TObject obj, const char title, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name, TObject obj, const char title="ROOT Object Browser", Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name, void obj, TClass cl, const char objname, const char title, Int_t x, Int_t y, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name, void obj, TClass cl, const char objname, const char title, UInt_t width, UInt_t height, Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name, void obj, TClass cl, const char objname="", const char title="ROOT Foreign Browser", Option_t opt="")
	Create a new browser with a name, title, width and height for TObject *obj.

	TBrowser (const char name="Browser", const char title="ROOT Object Browser", TBrowserImp extimp=nullptr, Option_t opt="")
	Create a new browser with a name, title.

virtual	~TBrowser ()
	Delete the browser.

void	Add (TObject obj, const char name=nullptr, Int_t check=-1)
	Add object with name to browser.

void	Add (void obj, TClass cl, const char *name=nullptr, Int_t check=-1)
	Add foreign object with name to browser.

void	AddCheckBox (TObject *obj, Bool_t check=kFALSE)
	Add checkbox for this item.

void	BrowseObject (TObject *obj)

void	CheckObjectItem (TObject *obj, Bool_t check=kFALSE)
	Change status of checkbox for this item.

virtual void	Create (TObject *obj=nullptr)
	Create the browser, called by the ctors.

virtual void	Destructor ()
	Actual browser destructor.

Longptr_t	ExecPlugin (const char name=nullptr, const char fname=nullptr, const char *cmd=nullptr, Int_t pos=1, Int_t subpos=-1)

void	ExecuteDefaultAction (TObject *obj)
	Execute default action for selected object (action is specified in the `$HOME/.root.mimes` or `$ROOTSYS/etc/root.mimes file`).

TBrowserImp *	GetBrowserImp () const

TContextMenu *	GetContextMenu () const

Option_t *	GetDrawOption () const override
	Get option used by the graphics system to draw this object.

Bool_t	GetRefreshFlag () const

TObject *	GetSelected () const

void	Iconify ()

void	RecursiveRemove (TObject *obj) override
	Recursively remove obj from browser.

void	Refresh ()
	Refresh browser contents.

void	RemoveCheckBox (TObject *obj)
	Remove checkbox for this item.

void	SetBrowserImp (TBrowserImp *i)

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

void	SetRefreshFlag (Bool_t flag)

void	SetSelected (TObject *clickedObject)
	Assign the last selected object.

void	SetStatusText (const char *txt, Int_t col)

void	Show ()

void	StartEmbedding (Int_t pos, Int_t subpos)

void	StopEmbedding (const char *name="")

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

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

virtual	~TNamed ()
	TNamed destructor.

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

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

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

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

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

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

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

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

Bool_t	IsSortable () const override

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

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

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

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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	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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

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

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

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

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

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

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

virtual 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 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 (the base implementation is no-op).

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

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	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	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

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

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

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

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor.

virtual	~TQObject ()
	TQObject Destructor.

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

virtual void	ChangedBy (const char *method)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes.

Bool_t	Connect (const char signal, const char receiver_class, void receiver, const char slot)
	Non-static method is used to connect from the signal of this object to the receiver slot.

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=nullptr, void receiver=nullptr, const char *slot=nullptr)
	Disconnects signal of this object from slot of receiver.

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter.

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments.

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class.

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal.

virtual void	HighPriority (const char signal_name, const char slot_name=nullptr)

virtual void	LowPriority (const char signal_name, const char slot_name=nullptr)

virtual void	Message (const char *msg)

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object.

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TBrowser
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

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

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

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

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static Bool_t	Connect (const char sender_class, const char signal, const char receiver_class, void receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot.

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

static const char *	DeclFileName ()

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=nullptr, const char slot=nullptr)
	Disconnects "class signal".

static Bool_t	Disconnect (TQObject sender, const char signal=nullptr, void receiver=nullptr, const char slot=nullptr)
	Disconnects signal in object sender from slot_method in object receiver.

Private Attributes
std::shared_ptr< xRooNode >	fNode

std::shared_ptr< xRooNode >	fTopNode

Additional Inherited Members
Public Types inherited from TBrowser
enum	EStatusBits { kNoHidden = (1ULL << ( 9 )) }

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

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

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

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

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

Protected Member Functions inherited from TBrowser
Bool_t	InitGraphics ()

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 Member Functions inherited from TQObject
virtual void *	GetSender ()

virtual const char *	GetSenderClassName () const

Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject sender, TClass sender_class, const char signal, TClass receiver_class, const char *slot)
	Checking of consistency of sender/receiver methods/arguments.

static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature.

static Bool_t	ConnectToClass (const char sender_class, const char signal, TClass receiver_class, void receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object.

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver.

Protected Attributes inherited from TBrowser
TContextMenu *	fContextMenu {nullptr}
	Browser's timer.

TBrowserImp *	fImp {nullptr}

Bool_t	fNeedRefresh {kFALSE}
	Context menu pointer.

TBrowserTimer *	fTimer {nullptr}
	Window system specific browser implementation.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals

#include <RooFit/xRooFit/xRooBrowser.h>

Inheritance diagram for ROOT::Experimental::XRooFit::xRooBrowser:

[legend]

Constructor & Destructor Documentation

◆ xRooBrowser() [1/2]

xRooBrowser::xRooBrowser ( )

Definition at line 153 of file xRooBrowser.cxx.

◆ xRooBrowser() [2/2]

xRooBrowser::xRooBrowser ( xRooNode * o )

Definition at line 80 of file xRooBrowser.cxx.

Member Function Documentation

◆ cd()

void xRooBrowser::cd ( const char * path )

Definition at line 186 of file xRooBrowser.cxx.

◆ Class()

static TClass * ROOT::Experimental::XRooFit::xRooBrowser::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * ROOT::Experimental::XRooFit::xRooBrowser::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t ROOT::Experimental::XRooFit::xRooBrowser::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 49 of file xRooBrowser.h.

◆ DeclFileName()

static const char * ROOT::Experimental::XRooFit::xRooBrowser::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 49 of file xRooBrowser.h.

◆ GetSelected()

xRooNode * xRooBrowser::GetSelected ( )

Definition at line 192 of file xRooBrowser.cxx.

◆ HandleMenu()

void xRooBrowser::HandleMenu ( Int_t id )

Definition at line 118 of file xRooBrowser.cxx.

◆ IsA()

TClass * ROOT::Experimental::XRooFit::xRooBrowser::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TBrowser.

Definition at line 49 of file xRooBrowser.h.

◆ ls()

void xRooBrowser::ls ( const char * option = nullptr ) const

overridevirtual

List TNamed name and title.

Reimplemented from TNamed.

Definition at line 174 of file xRooBrowser.cxx.

◆ Open()

xRooNode * xRooBrowser::Open ( const char * filename )

Definition at line 165 of file xRooBrowser.cxx.

◆ Streamer()

void ROOT::Experimental::XRooFit::xRooBrowser::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TBrowser.

◆ StreamerNVirtual()

void ROOT::Experimental::XRooFit::xRooBrowser::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 49 of file xRooBrowser.h.

Member Data Documentation

◆ fNode

std::shared_ptr<xRooNode> ROOT::Experimental::XRooFit::xRooBrowser::fNode

private

Definition at line 45 of file xRooBrowser.h.

◆ fTopNode

std::shared_ptr<xRooNode> ROOT::Experimental::XRooFit::xRooBrowser::fTopNode

private

Definition at line 46 of file xRooBrowser.h.

Libraries for ROOT::Experimental::XRooFit::xRooBrowser:

[legend]

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

roofit/xroofit/inc/RooFit/xRooFit/xRooBrowser.h
roofit/xroofit/src/xRooBrowser.cxx

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ xRooBrowser() [1/2]

◆ xRooBrowser() [2/2]

Member Function Documentation

◆ cd()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetSelected()

◆ HandleMenu()

◆ IsA()

◆ ls()

◆ Open()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fNode

◆ fTopNode