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

This class is an interface to the Hbook objects in Hbook files.

Any Hbook object (1-D, 2-D, Profile, RWN or CWN can be read

NB: a THbookFile can only be used in READ mode Use the utility in $ROOTSYS/bin/h2root to convert Hbook to Root

Example of use:

gSystem->Load("libHbook");
THbookFile f("myfile.hbook");
f.ls();
TH1F *h1 = (TH1F*)f.Get(1);  //import histogram ID=1 in h1
h1->Fit("gaus");
THbookTree *T = (THbookTree*)f.Get(111); //import ntuple header
T->Print();  //show the Hbook ntuple variables
T->Draw("x","y<0"); // as in normal TTree::Draw

THbookFile can be browsed via TBrowser.

Definition at line 29 of file THbookFile.h.

Public Member Functions

 THbookFile ()
 the constructor
 
 THbookFile (const char *fname, Int_t lrecl=1024)
 Constructor for an HBook file object.
 
 ~THbookFile () override
 destructor
 
void Browse (TBrowser *b) override
 to be implemented
 
virtual Bool_t cd (const char *dirname="")
 change directory to dirname
 
virtual void Close (Option_t *option="")
 Close the Hbook file.
 
virtual TObjectConvert1D (Int_t id)
 Convert an Hbook 1-d histogram into a Root TH1F.
 
virtual TObjectConvert2D (Int_t id)
 Convert an Hbook 2-d histogram into a Root TH2F.
 
virtual TFileConvert2root (const char *rootname="", Int_t lrecl=0, Option_t *option="")
 Convert this Hbook file to a Root file with name rootname.
 
virtual TObjectConvertCWN (Int_t id)
 Convert the Column-Wise-Ntuple id to a Root Tree.
 
virtual TObjectConvertProfile (Int_t id)
 Convert an Hbook profile histogram into a Root TProfile.
 
virtual TObjectConvertRWN (Int_t id)
 Convert the Row-Wise-Ntuple id to a Root Tree.
 
void DeleteID (Int_t id)
 remove id from file and memory
 
TObjectFindObject (const char *name) const override
 return object with name in fList in memory
 
TObjectFindObject (const TObject *obj) const override
 return object with pointer obj in fList in memory
 
TObjectGet (Int_t id)
 import Hbook object with identifier idd in memory
 
const char * GetCurDir () const
 
Int_t GetEntry (Int_t entry, Int_t id, Int_t atype, Float_t *x)
 Read in memory all columns of entry number of ntuple id from the Hbook file.
 
Int_t GetEntryBranch (Int_t entry, Int_t id)
 Read in memory only the branch bname.
 
TListGetList () const
 
TListGetListOfKeys () const
 
Long64_t GetSize () const
 
void InitLeaves (Int_t id, Int_t var, TTreeFormula *formula)
 This function is called from the first entry in TTreePlayer::InitLoop It analyzes the list of variables involved in the current query and pre-process the internal Hbook tables to speed-up the search at the next entries.
 
TClassIsA () const override
 
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
virtual Bool_t IsOpen () const
 Returns kTRUE in case file is open and kFALSE if file is not open.
 
void ls (const char *path="") const override
 List contents of Hbook directory.
 
virtual void SetBranchAddress (Int_t id, const char *bname, void *add)
 Set branch address.
 
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 ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void 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.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Attributes

TString fCurDir
 
TListfKeys
 
TListfList
 
Int_t fLrecl
 
Int_t fLun
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Static Protected Attributes

static Int_tfgLuns = nullptr
 
static Bool_t fgPawInit = kFALSE
 

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 )) }
 
- 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 ()
 

#include <THbookFile.h>

Inheritance diagram for THbookFile:
[legend]

Constructor & Destructor Documentation

◆ THbookFile() [1/2]

THbookFile::THbookFile ( )

the constructor

Definition at line 255 of file THbookFile.cxx.

◆ THbookFile() [2/2]

THbookFile::THbookFile ( const char *  fname,
Int_t  lrecl = 1024 
)

Constructor for an HBook file object.

Definition at line 264 of file THbookFile.cxx.

◆ ~THbookFile()

THbookFile::~THbookFile ( )
override

destructor

Definition at line 339 of file THbookFile.cxx.

Member Function Documentation

◆ Browse()

void THbookFile::Browse ( TBrowser b)
overridevirtual

to be implemented

Reimplemented from TObject.

Definition at line 350 of file THbookFile.cxx.

◆ cd()

Bool_t THbookFile::cd ( const char *  dirname = "")
virtual

change directory to dirname

Definition at line 362 of file THbookFile.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 71 of file THbookFile.h.

◆ Close()

void THbookFile::Close ( Option_t option = "")
virtual

Close the Hbook file.

Definition at line 398 of file THbookFile.cxx.

◆ Convert1D()

TObject * THbookFile::Convert1D ( Int_t  id)
virtual

Convert an Hbook 1-d histogram into a Root TH1F.

Definition at line 929 of file THbookFile.cxx.

◆ Convert2D()

TObject * THbookFile::Convert2D ( Int_t  id)
virtual

Convert an Hbook 2-d histogram into a Root TH2F.

Definition at line 981 of file THbookFile.cxx.

◆ Convert2root()

TFile * THbookFile::Convert2root ( const char *  rootname = "",
Int_t  lrecl = 0,
Option_t option = "" 
)
virtual

Convert this Hbook file to a Root file with name rootname.

if rootname="', rootname = hbook file name with .root instead of .hbook By default, the Root file is connected and returned option: - "NO" do not connect the Root file - "C" do not compress file (default is to compress) - "L" do not convert names to lower case (default is to convert)

Definition at line 607 of file THbookFile.cxx.

◆ ConvertCWN()

TObject * THbookFile::ConvertCWN ( Int_t  id)
virtual

Convert the Column-Wise-Ntuple id to a Root Tree.

Definition at line 647 of file THbookFile.cxx.

◆ ConvertProfile()

TObject * THbookFile::ConvertProfile ( Int_t  id)
virtual

Convert an Hbook profile histogram into a Root TProfile.

the following structure is used in Hbook lcid points to the profile in array iq lcont = lq(lcid-1) lw = lq(lcont) ln = lq(lw) if option S jbyt(iq(lw),1,2) = 1 if option I jbyt(iq(lw),1,2) = 2

Definition at line 888 of file THbookFile.cxx.

◆ ConvertRWN()

TObject * THbookFile::ConvertRWN ( Int_t  id)
virtual

Convert the Row-Wise-Ntuple id to a Root Tree.

Definition at line 808 of file THbookFile.cxx.

◆ DeclFileName()

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

Definition at line 71 of file THbookFile.h.

◆ DeleteID()

void THbookFile::DeleteID ( Int_t  id)

remove id from file and memory

Definition at line 421 of file THbookFile.cxx.

◆ FindObject() [1/2]

TObject * THbookFile::FindObject ( const char *  name) const
overridevirtual

return object with name in fList in memory

Reimplemented from TObject.

Definition at line 429 of file THbookFile.cxx.

◆ FindObject() [2/2]

TObject * THbookFile::FindObject ( const TObject obj) const
overridevirtual

return object with pointer obj in fList in memory

Reimplemented from TObject.

Definition at line 437 of file THbookFile.cxx.

◆ Get()

TObject * THbookFile::Get ( Int_t  id)

import Hbook object with identifier idd in memory

Definition at line 445 of file THbookFile.cxx.

◆ GetCurDir()

const char * THbookFile::GetCurDir ( ) const
inline

Definition at line 59 of file THbookFile.h.

◆ GetEntry()

Int_t THbookFile::GetEntry ( Int_t  entry,
Int_t  id,
Int_t  atype,
Float_t x 
)

Read in memory all columns of entry number of ntuple id from the Hbook file.

Definition at line 517 of file THbookFile.cxx.

◆ GetEntryBranch()

Int_t THbookFile::GetEntryBranch ( Int_t  entry,
Int_t  id 
)

Read in memory only the branch bname.

Definition at line 531 of file THbookFile.cxx.

◆ GetList()

TList * THbookFile::GetList ( ) const
inline

Definition at line 63 of file THbookFile.h.

◆ GetListOfKeys()

TList * THbookFile::GetListOfKeys ( ) const
inline

Definition at line 64 of file THbookFile.h.

◆ GetSize()

Long64_t THbookFile::GetSize ( ) const
inline

Definition at line 62 of file THbookFile.h.

◆ InitLeaves()

void THbookFile::InitLeaves ( Int_t  id,
Int_t  var,
TTreeFormula formula 
)

This function is called from the first entry in TTreePlayer::InitLoop It analyzes the list of variables involved in the current query and pre-process the internal Hbook tables to speed-up the search at the next entries.

Definition at line 554 of file THbookFile.cxx.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 71 of file THbookFile.h.

◆ IsFolder()

Bool_t THbookFile::IsFolder ( ) const
inlineoverridevirtual

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

Reimplemented from TObject.

Definition at line 66 of file THbookFile.h.

◆ IsOpen()

Bool_t THbookFile::IsOpen ( ) const
virtual

Returns kTRUE in case file is open and kFALSE if file is not open.

Definition at line 578 of file THbookFile.cxx.

◆ ls()

void THbookFile::ls ( const char *  path = "") const
overridevirtual

List contents of Hbook directory.

Reimplemented from TObject.

Definition at line 1016 of file THbookFile.cxx.

◆ SetBranchAddress()

void THbookFile::SetBranchAddress ( Int_t  id,
const char *  bname,
void *  add 
)
virtual

Set branch address.

Definition at line 587 of file THbookFile.cxx.

◆ Streamer()

void THbookFile::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void THbookFile::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 71 of file THbookFile.h.

Member Data Documentation

◆ fCurDir

TString THbookFile::fCurDir
protected

Definition at line 36 of file THbookFile.h.

◆ fgLuns

Int_t * THbookFile::fgLuns = nullptr
staticprotected

Definition at line 39 of file THbookFile.h.

◆ fgPawInit

Bool_t THbookFile::fgPawInit = kFALSE
staticprotected

Definition at line 38 of file THbookFile.h.

◆ fKeys

TList* THbookFile::fKeys
protected

Definition at line 35 of file THbookFile.h.

◆ fList

TList* THbookFile::fList
protected

Definition at line 34 of file THbookFile.h.

◆ fLrecl

Int_t THbookFile::fLrecl
protected

Definition at line 33 of file THbookFile.h.

◆ fLun

Int_t THbookFile::fLun
protected

Definition at line 32 of file THbookFile.h.

  • hist/hbook/inc/THbookFile.h
  • hist/hbook/src/THbookFile.cxx