This class is automatically called by TFile::DrawMap.

It draws a canvas showing the internal structure of a ROOT file. Each key or basket in a file is shown with a fill area drawn at the byte position of the key/basket in the file. The Y axis of the canvas shows the number of Kbytes/Mbytes. The X axis shows the bytes between y(i) and y(i+1). A color corresponding to the class in the key/basket is automatically selected using the class unique identifier.

When moving the mouse in the canvas, the "Event Status" panels shows the object corresponding to the mouse position. if the object is a key, it shows the class and object name as well as the file directory name if the file has sub-directories.

if the object is a basket, it shows:

the name of the Tree
the name of the branch
the basket number
the entry number in the basket

Special keys like the StreamerInfo record, the Keys List Record and the Free Blocks Record are also shown.

When clicking the right mouse button, a pop-up menu is shown with its title identifying the picked object and with the items:

DrawObject: in case of a key, the Draw function of the object is called in case of a basket, the branch is drawn for all entries
DumpObject: in case of a key, the Dump function of the object is called in case of a basket, tree->Show(entry) is called
InspectObject: the Inspect function is called for the object.

The normal axis zoom functionality can be used to zoom or unzoom One can also use the TCanvas context menu SetCanvasSize to make a larger canvas and use the canvas scroll bars.

When the class is built, it is possible to identify a subset of the objects to be shown. For example, to view only the keys with names starting with "abc", set the argument keys to "abc*". The default is to view all the objects. The argument options can also be used (only one option currently) When the option "same" is given, the new picture is superimposed. The option "same" is useful, eg: to draw all keys with names = "abc" in a first pass then all keys with names = "uv*" in a second pass, etc.

Definition at line 32 of file TFileDrawMap.h.

Public Member Functions
	TFileDrawMap ()
	Default TreeFileMap constructor.

	TFileDrawMap (const TFile file, const char keys, Option_t *option)
	TFileDrawMap normal constructor.

	~TFileDrawMap () override
	Tree destructor.

virtual void	AnimateTree (const char *branches="")
	Show sequence of baskets reads for the list of baskets involved in the list of branches (separated by ",")

Int_t	DistancetoPrimitive (Int_t px, Int_t py) override
	Compute distance from point px,py to this TreeFileMap.

virtual void	DrawObject ()
	Draw object at the mouse position.

virtual void	DumpObject ()
	Dump object at the mouse position.

void	ExecuteEvent (Int_t event, Int_t px, Int_t py) override
	Execute action corresponding to one event.

char *	GetObjectInfo (Int_t px, Int_t py) const override
	Redefines TObject::GetObjectInfo.

virtual void	InspectObject ()
	Inspect object at the mouse position.

TClass *	IsA () const override

void	Paint (Option_t *option) override
	Paint this TFileDrawMap.

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

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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

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

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	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

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

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 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	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 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	Pop ()
	Pop on object drawn in a pad to the top of the display list.

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

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

void	ResetBit (UInt_t f)

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

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

void	SetBit (UInt_t f)

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

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

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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

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

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

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

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

Protected Member Functions
virtual void	DrawMarker (Int_t marker, Long64_t eseek)
	Draw marker.

virtual TObject *	GetObject ()
	Retrieve object at the mouse position in memory.

virtual bool	GetObjectInfoDir (TDirectory *dir, Int_t px, Int_t py, TString &info) const
	Redefines TObject::GetObjectInfo.

virtual void	PaintBox (TBox &box, Long64_t bseek, Int_t nbytes)
	Paint the object at bseek with nbytes using the box object.

virtual void	PaintDir (TDirectory dir, const char keys)
	Paint keys in a directory.

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
TFile *	fFile
	Pointer to the file.

TH1 *	fFrame
	Histogram used to draw the map frame.

TString	fKeys
	List of keys.

TString	fOption
	Drawing options.

Int_t	fXsize
	Size in bytes of X axis.

Int_t	fYsize
	Size in K/Mbytes of Y axis.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
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 )) }

#include <TFileDrawMap.h>

Inheritance diagram for TFileDrawMap:

[legend]

Constructor & Destructor Documentation

◆ TFileDrawMap() [1/2]

TFileDrawMap::TFileDrawMap ( )

Default TreeFileMap constructor.

Definition at line 81 of file TFileDrawMap.cxx.

◆ TFileDrawMap() [2/2]

TFileDrawMap::TFileDrawMap	(	const TFile *	file,
		const char *	keys,
		Option_t *	option
	)

TFileDrawMap normal constructor.

see descriptions of arguments above

Definition at line 93 of file TFileDrawMap.cxx.

◆ ~TFileDrawMap()

TFileDrawMap::~TFileDrawMap ( )

override

Tree destructor.

Definition at line 139 of file TFileDrawMap.cxx.

Member Function Documentation

◆ AnimateTree()

void TFileDrawMap::AnimateTree ( const char * branches = "" )

virtual

Show sequence of baskets reads for the list of baskets involved in the list of branches (separated by ",")

if branches="", the branch pointed by the mouse is taken.
if branches="*", all branches are taken Example:

AnimateTree("x,y,u");

Definition at line 153 of file TFileDrawMap.cxx.

◆ Class()

static TClass * TFileDrawMap::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TFileDrawMap::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TFileDrawMap::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 62 of file TFileDrawMap.h.

◆ DeclFileName()

static const char * TFileDrawMap::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 62 of file TFileDrawMap.h.

◆ DistancetoPrimitive()

Int_t TFileDrawMap::DistancetoPrimitive	(	Int_t	px,
		Int_t	py
	)

overridevirtual

Compute distance from point px,py to this TreeFileMap.

Find the closest object to the mouse, save its path in the TFileDrawMap name.

Reimplemented from TObject.

Definition at line 227 of file TFileDrawMap.cxx.

◆ DrawMarker()

void TFileDrawMap::DrawMarker	(	Int_t	marker,
		Long64_t	eseek
	)

protectedvirtual

Draw marker.

Definition at line 243 of file TFileDrawMap.cxx.

◆ DrawObject()

void TFileDrawMap::DrawObject ( )

virtual

Draw object at the mouse position.

Definition at line 281 of file TFileDrawMap.cxx.

◆ DumpObject()

void TFileDrawMap::DumpObject ( )

virtual

Dump object at the mouse position.

Definition at line 318 of file TFileDrawMap.cxx.

◆ ExecuteEvent()

void TFileDrawMap::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py
	)

overridevirtual

Execute action corresponding to one event.

Reimplemented from TObject.

Definition at line 341 of file TFileDrawMap.cxx.

◆ GetObject()

TObject * TFileDrawMap::GetObject ( )

protectedvirtual

Retrieve object at the mouse position in memory.

Definition at line 349 of file TFileDrawMap.cxx.

◆ GetObjectInfo()

char * TFileDrawMap::GetObjectInfo	(	Int_t	px,
		Int_t	py
	)		const

overridevirtual

Redefines TObject::GetObjectInfo.

Displays the keys info in the file corresponding to cursor position px,py in the canvas status bar info panel

Reimplemented from TObject.

Definition at line 371 of file TFileDrawMap.cxx.

◆ GetObjectInfoDir()

bool TFileDrawMap::GetObjectInfoDir	(	TDirectory *	dir,
		Int_t	px,
		Int_t	py,
		TString &	info
	)		const

protectedvirtual

Redefines TObject::GetObjectInfo.

Displays the keys info in the directory corresponding to cursor position px,py

Definition at line 385 of file TFileDrawMap.cxx.

◆ InspectObject()

void TFileDrawMap::InspectObject ( )

virtual

Inspect object at the mouse position.

Definition at line 480 of file TFileDrawMap.cxx.

◆ IsA()

TClass * TFileDrawMap::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 62 of file TFileDrawMap.h.

◆ Paint()

void TFileDrawMap::Paint ( Option_t * option )

overridevirtual

Paint this TFileDrawMap.

Reimplemented from TObject.

Definition at line 489 of file TFileDrawMap.cxx.

◆ PaintBox()

void TFileDrawMap::PaintBox	(	TBox &	box,
		Long64_t	bseek,
		Int_t	nbytes
	)

protectedvirtual

Paint the object at bseek with nbytes using the box object.

Definition at line 512 of file TFileDrawMap.cxx.

◆ PaintDir()

void TFileDrawMap::PaintDir	(	TDirectory *	dir,
		const char *	keys
	)

protectedvirtual

Paint keys in a directory.

Definition at line 542 of file TFileDrawMap.cxx.

◆ Streamer()

void TFileDrawMap::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TFileDrawMap::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 62 of file TFileDrawMap.h.

Member Data Documentation

◆ fFile

TFile* TFileDrawMap::fFile

protected

Pointer to the file.

Definition at line 35 of file TFileDrawMap.h.

◆ fFrame

TH1* TFileDrawMap::fFrame

protected

Histogram used to draw the map frame.

Definition at line 36 of file TFileDrawMap.h.

◆ fKeys

TString TFileDrawMap::fKeys

protected

List of keys.

Definition at line 37 of file TFileDrawMap.h.

◆ fOption

TString TFileDrawMap::fOption

protected

Drawing options.

Definition at line 38 of file TFileDrawMap.h.

◆ fXsize

Int_t TFileDrawMap::fXsize

protected

Size in bytes of X axis.

Definition at line 39 of file TFileDrawMap.h.

◆ fYsize

Int_t TFileDrawMap::fYsize

protected

Size in K/Mbytes of Y axis.

Definition at line 40 of file TFileDrawMap.h.

Libraries for TFileDrawMap:

[legend]

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

tree/treeplayer/inc/TFileDrawMap.h
tree/treeplayer/src/TFileDrawMap.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TFileDrawMap() [1/2]

◆ TFileDrawMap() [2/2]

◆ ~TFileDrawMap()

Member Function Documentation

◆ AnimateTree()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ DistancetoPrimitive()

◆ DrawMarker()

◆ DrawObject()

◆ DumpObject()

◆ ExecuteEvent()

◆ GetObject()

◆ GetObjectInfo()

◆ GetObjectInfoDir()

◆ InspectObject()

◆ IsA()

◆ Paint()

◆ PaintBox()

◆ PaintDir()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fFile

◆ fFrame

◆ fKeys

◆ fOption

◆ fXsize

◆ fYsize