Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file inheritance tree (.pdf)

Sections: class description function members data members class charts

class AtlHistogramTool: public AtlAnalysisTool

Histogram tool

The tool allows to book and fill many histograms inside an analysis in a transparent and efficient way.

For each tool a folder with the name of the tool is created inside the output file of the analysis job. The histograms can also be managed in subfolders simply by prepending the path in the hisotgram name (see the example below). The subfolders are created automatically if they do not exist.

Example:

MyAnalysis.h:

 private:
   AtlHistogramTool *fHistograms1;   // List 1
   AtlHistogramTool *fHistograms2;   // List 2
   ...

MyAnalysis::BookHistograms():

 // Pre-tagged histograms
 fHistograms1 = new AtlHistogramTool("PreTag",
                                     "Pre-tagged histograms");
 AddTool(fHistograms1)
 // Leading lepton Pt
 fHistograms1->Add("leptons/h_lep1_Pt", "Leading Lepton Pt", 40, 0., 200.,
                   "Leading lepton p_{T} [GeV]", "Events");
 // Leading lepton eta
 fHistograms1->Add("leptons/h_lep1_Eta", "Leading Lepton Eta",
                   50, -2.5, 2.5, "Leading lepton #eta", "Events");
 // Leading electron Pt
 fHistograms1->Add("leptons/el/h_el1_Pt", "Leading Electron Pt", 40, 0., 200.,
                   "Leading electron p_{T} [GeV]", "Events");
 ...
 // b-tagged histograms
 fHistograms2 = new AtlHistogramTool("bTag",
                                     "b-tagged histograms");
 AddTool(fHistograms2)
 // Leading jet Pt
 fHistograms2->Add("jets/h_jet1_Pt", "Leading Jet Pt",
                   40, 0., 200., "Leading jet p_{T} [GeV]", "Events");
    
 // Leading jet eta
 fHistograms2->Add("jets/h_jet1_Eta", "Leading Jet Eta",
                   100, -5., 5., "Leading jet #eta", "Events");
 ...

MyAnalysis::ProcessCut():

 fHistograms1->Fill("leptons/h_lep1_Pt",  lep1->Pt(), w1);
 fHistograms1->Fill("leptons/h_lep1_Eta", lep1->Eta(), w1);
 fHistograms1->Fill("leptons/el/h_el1_Pt",  el1->Pt(), w1);
 ...
 // Perform b-tagging
 ...
 fHistograms1->Fill("jets/h_jet1_Pt",  jet1->Pt(), w2);
 fHistograms1->Fill("jets/h_jet1_Eta", jet1->Eta(), w2);
 ...



 Author: Oliver Maria Kind <mailto: kind@physik.hu-berlin.de>
 Update: $Id: AtlHistogramTool.cxx,v 1.5 2017/01/22 12:16:58 kind Exp $
 Copyright: 2015 (C) Oliver Maria Kind

Function Members (Methods)

public:

virtual	~AtlHistogramTool()
void	TObject::AbstractMethod(const char* method) const
TH1D*	Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, const char* xtitle, const char* ytitle)
TH2D*	Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy, const Double_t* ybins, const char* xtitle, const char* ytitle, const char* ztitle)
TH2D*	Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy, Double_t ylow, Double_t yup, const char* xtitle, const char* ytitle, const char* ztitle)
virtual Bool_t	AtlAnalysisTool::AnalyzeEvent()
virtual void	TObject::AppendPad(Option_t* option = "")
	AtlHistogramTool(const AtlHistogramTool&)
	AtlHistogramTool(const char* name, const char* title)
virtual void	BookHistograms()
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	AtlAnalysisTool::Clear()
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
void	Fill(const char* hname, Double_t x, Double_t w)
void	Fill(const char* hname, Double_t x, Double_t y, Double_t w)
void	Fill(const char* path, const char* hname, Double_t x, Double_t w)
void	Fill(const char* path, const char* hname, Double_t x, Double_t y, Double_t w)
virtual void	TNamed::FillBuffer(char*& buffer)
virtual void	FillHistograms()
virtual void	AtlAnalysisTool::FillHistogramsNoEvtSel()
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
virtual const char*	TNamed::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
const char*	AtlAnalysisTool::GetOutputDir() const
Float_t	AtlAnalysisTool::GetPreTagEvtWeight() const
static const char*	AtlAnalysisTool::GetProcessModeName(AtlAnalysisTool::EProcessMode mode)
Float_t	AtlAnalysisTool::GetTagEvtWeight() const
virtual const char*	TNamed::GetTitle() const
AtlAnalysisTool*	AtlAnalysisTool::GetTool(const char* ClassName, const char* ToolName = "", Bool_t force = kFALSE) const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	AtlAnalysisTool::Init()
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	AtlAnalysisTool::IsIndividual() const
Bool_t	AtlAnalysisTool::IsMainAnalysis() const
Bool_t	AtlAnalysisTool::IsObjectsDefinition() const
Bool_t	AtlAnalysisTool::IsOff() const
Bool_t	TObject::IsOnHeap() const
Bool_t	AtlAnalysisTool::IsPostAnalysis() const
Bool_t	AtlAnalysisTool::IsPreAnalysis() const
Bool_t	AtlAnalysisTool::IsScaleFactor() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	AtlAnalysisTool::IsSystematics() const
Bool_t	TObject::IsZombie() const
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	AtlAnalysisTool::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
AtlHistogramTool&	operator=(const AtlHistogramTool&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print() const
Bool_t	AtlAnalysisTool::Process()
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	SetBranchStatus()
virtual void	AtlAnalysisTool::SetCutDefaults()
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	AtlAnalysisTool::SetEvent(AtlEvent* evt)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
void	AtlAnalysisTool::SetOutputDir(const char* dir)
void	AtlAnalysisTool::SetOutputFile(TFile* f)
void	AtlAnalysisTool::SetParent(AtlSelector* parent)
virtual void	TNamed::SetTitle(const char* title = "")MENU
void	AtlAnalysisTool::SetTree(TTree* t)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
virtual void	AtlAnalysisTool::Terminate()
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

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

private:

TDirectory*

MkDirWithParents(const char* dir)

Data Members

public:

TString	AtlAnalysisTool::fOutputDir	Directory in root output file, where histogram dir is created
AtlAnalysisTool::EProcessMode	AtlAnalysisTool::fProcessMode	Defines when exactly the tool is run (see AtlAnalysisTool class description for details)
Int_t	AtlAnalysisTool::fVerbosityLevel	Indicates the degree of verbosity of tool (0 = no info/debug output, 1 = info, 2 = info+debug)
static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kIndividual
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kMainAnalysis
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kObjectsDefinition
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kOff
static TObject::(anonymous)	TObject::kOverwrite
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kPostAnalysis
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kPreAnalysis
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kScaleFactor
static TObject::(anonymous)	TObject::kSingleKey
static AtlAnalysisTool::EProcessMode	AtlAnalysisTool::kSystematics
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

AtlEvent*	AtlAnalysisTool::fEvent	Pointer to current event
TString	TNamed::fName	object identifier
TString*	AtlAnalysisTool::fOption	Option string
TFile*	AtlAnalysisTool::fOutputFile	Output file
AtlSelector*	AtlAnalysisTool::fParent	Pointer to parent selector
TString	TNamed::fTitle	object title
TTree*	AtlAnalysisTool::fTree	Event tree

private:

THashList*	fHistograms	List of histograms
TDirectory*	fParentDir	Top-level folder

Class Charts

Inheritance Chart:

TObject

←

TNamed

←

AtlAnalysisTool

←

AtlHistogramTool

Function documentation

AtlHistogramTool(const char* name, const char* title)

 Default constructor

~AtlHistogramTool()

 Default destructor

TH1D* Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, const char* xtitle, const char* ytitle)

 Add TH1D histogram

 The histogram name can contain a path of subdirectories. These
 directories are created automatically if they do not exist. All
 path names are relative to the parent folder of the tool.

 Store current dirctory

TH2D* Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy, Double_t ylow, Double_t yup, const char* xtitle, const char* ytitle, const char* ztitle)

 Add TH2D histogram

 The histogram name can contain a path of subdirectories. These
 directories are created automatically if they do not exist. All
 path names are relative to the parent folder of the tool.

 Store current dirctory

TH2D* Add(const char* hname, const char* title, Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy, const Double_t* ybins, const char* xtitle, const char* ytitle, const char* ztitle)

 Add TH2D histogram

 The histogram name can contain a path of subdirectories. These
 directories are created automatically if they do not exist. All
 path names are relative to the parent folder of the tool.

 Store current dirctory

void Fill(const char* hname, Double_t x, Double_t w)

 Fill given histogram with value x and weight w

 The histogram name needs to contain the full path of the
 histogram as given when booking the histogram using the Add()
 member function.

void Fill(const char* hname, Double_t x, Double_t y, Double_t w)

 Fill given histogram with values x,y and weight w

 The histogram name needs to contain the full path of the
 histogram as given when booking the histogram using the Add()
 member function.

TDirectory* MkDirWithParents(const char* dir)

 Create the given directoy and all of its parents if necessary
 in the top-level directory

void Print() const

 Print tool configuration

AtlHistogramTool(const char* name, const char* title)

void Fill(const char* hname, Double_t x, Double_t w)

void Fill(const char* hname, Double_t x, Double_t y, Double_t w)

void SetBranchStatus()

{;}

void BookHistograms()

{;}

void FillHistograms()

{;}