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 AtlHistFactoryTask: public AtlTask


 Class for managing tasks associated with HistFactory

 Currently thre functions are implemented:

 - CreateTemplates()
   Used for creating all templates for fitting and for shape tests,
   respectively. All templates are saved in a file, one file
   per channel.
   For the fit templates, the channel discriminant will be used and the
   corresponding histograms are saved.
   For shape analysis, the DiscrimantRef and DiscriminantShape will be
   used. These have to be set defined for each channel separatly.

 - PerformShapeTests()
   Runs Chi2 and KS tests and save results in a dedicated file, one
   file per channel.

 - CreateWorkSpace()
   Creates the histfactory workspace and saves it to disk.

 A detailed example for the configuration can be found in
 $LIBSINGLETOP/tasks/task_sChannelAnalysis_HistFactory.C


 Author: Soeren Stamm <mailto: stamm@physik.hu-berlin.de>
 Update: $Id: AtlHistFactoryTask.cxx,v 1.31 2017/06/28 15:27:23 kaphle Exp $
 Copyright: 2015 (C) Soeren Stamm

Function Members (Methods)

public:

virtual	~AtlHistFactoryTask()
virtual void	TTask::Abort()MENU
void	TObject::AbstractMethod(const char* method) const
virtual void	TTask::Add(TTask* task)
void	AtlTask::AddInputEntryLists(const char* InputFile)
void	AtlTask::AddInputFiles(const char* InputFiles)
virtual void	TObject::AppendPad(Option_t* option = "")
	AtlHistFactoryTask(const AtlHistFactoryTask&)
	AtlHistFactoryTask(const char* name, const char* title)
virtual void	TTask::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TTask::CleanTasks()
virtual void	TTask::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TTask::Continue()MENU
virtual void	TNamed::Copy(TObject& named) const
static void	AtlTask::CopyFolder(TDirectory* SrcDir, TDirectory* DestDir, Float_t scale)
virtual void	CreateGridRunScript()
virtual void	AtlTask::CreateJobHome()
void	AtlTask::CreateLogFilePath()
virtual void	CreateNAFBatchRunScript()
void	AtlTask::CreateOutFilePath()
virtual void	CreateRunScript(Option_t* option = "")
void	AtlTask::CreateRunScriptPath()
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	AtlTask::Exec(Option_t* option = "")
virtual Bool_t	ExecBatchJob(Option_t* option)
virtual void	ExecGridJob(Option_t* option)
virtual void	ExecInteractiveJob(Option_t* option)
virtual void	ExecNAFBatchJob(Option_t* option)
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	AtlTask::ExecuteTask(Option_t* option = "")MENU
virtual void	TTask::ExecuteTasks(Option_t* option)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
Bool_t	AtlTask::GetBatchJob()
Bool_t	AtlTask::GetBatchNodeAll()
Bool_t	AtlTask::GetBatchNodeAutomatic()
Char_t	AtlTask::GetBatchNodeFromPath(const char* path)
Int_t	TTask::GetBreakin() const
Int_t	TTask::GetBreakout() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
Bool_t	AtlTask::GetGridJob()
virtual const char*	TObject::GetIconName() const
Bool_t	AtlTask::GetInteractiveJob()
TList*	TTask::GetListOfTasks() const
Bool_t	AtlTask::GetLogFile()
Bool_t	AtlTask::GetNAFBatchJob()
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
virtual const char*	TNamed::GetTitle() 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	Initialize()
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	TTask::IsActive() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TTask::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TTask::ls(Option_t* option = "*") constMENU
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::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)
AtlHistFactoryTask&	operator=(const AtlHistFactoryTask&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
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	TTask::SetActive(Bool_t active = kTRUE)TOGGLE
virtual void	AtlTask::SetBatchJob(Bool_t BatchJob)TOGGLE
void	AtlTask::SetBatchNode(const char* BatchNode)MENU
void	AtlTask::SetBatchNodeAll(Bool_t BatchNodeAll)TOGGLE
void	AtlTask::SetBatchNodeAutomatic(Bool_t BatchNodeAutomatic)TOGGLE
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
void	TTask::SetBreakin(Int_t breakin = 1)TOGGLE
void	TTask::SetBreakout(Int_t breakout = 1)TOGGLE
void	AtlTask::SetDebug(Int_t level)
void	AtlTask::SetDebugBuild(Int_t level)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	AtlTask::SetFirstEntry(Int_t FirstEntry)MENU
void	AtlTask::SetGridCmtVersion(const char* CmtVersion)MENU
virtual void	AtlTask::SetGridJob(Bool_t GridJob)TOGGLE
void	AtlTask::SetGridRootVersion(const char* RootVersion)MENU
void	AtlTask::SetGridSuffix(const char* suffix)MENU
void	AtlTask::SetGridUserName(const char* UserName)MENU
virtual void	AtlTask::SetInteractiveJob(Bool_t InteractiveJob)TOGGLE
void	AtlTask::SetJobHome(const char* JobHome)MENU
void	AtlTask::SetLogFile(Bool_t LogFile)TOGGLE
void	SetMeasurement(AtlHistFactoryMeasurement* meas)
virtual void	AtlTask::SetNAFBatchJob(Bool_t NAFBatchJob)TOGGLE
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
void	AtlTask::SetNEvents(Int_t NEvents)MENU
static void	TObject::SetObjectStat(Bool_t stat)
void	AtlTask::SetOutputFile(const char* OutputFile)
void	AtlTask::SetOutputTree(const char* name, const char* title)MENU
void	SetRunMode(AtlHistFactoryTask::ERunMode mode)
void	AtlTask::SetTempOutputFile(const char* OutputFile)
void	AtlTask::SetTempOutputPath(const char* OutputPath)
virtual void	TNamed::SetTitle(const char* title = "")MENU
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 Bool_t	AtlTask::SubmitBatchJob()
virtual void	AtlTask::SubmitGridJob()
virtual void	AtlTask::SubmitNAFBatchJob()
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
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
virtual Bool_t	AtlTask::WriteEnvSetup(ofstream& out) const

protected:

void	CreatePullPlots(const char* ws_filename, const char* ws_name, const char* data_name)
void	CreateTemplates()
void	CreateWorkspace()
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	ExportPullPlots(const char* outfile, TH1* h_pulls, TH1* h_pulls_err_up, TH1* h_pulls_err_down, TH1* h_prefit_impact_up, TH1* h_prefit_impact_down, TH1* h_postfit_impact_up, TH1* h_postfit_impact_down)
void	ExportRateUncertainties()
void	FitModel()
TString*	GetDirectoryName(const char* name)
Double_t	GetGammaUncertainty(const char* name, RooWorkspace* wSpace)
void	GetImpactOnPOI(RooWorkspace* wSpace, const char* data_name, const char* snapshot, RooRealVar* par, const char* poi_name, Double_t variation, TH1F* hresult, const char* logdir)
Double_t	GetNormUncertainty(const char* name)
void	GetShapeTemplatesFileName(const char* channel, TString& filename)
TString*	GetSystematicName(const char* par_name)
void	GetTemplatesFileName(const char* channel, TString& filename)
Bool_t	IsNormParameter(const char* name)
void	TObject::MakeZombie()
TList*	MergeListOfSystematics(TList* ch_systs, TList* sample_systs)
void	PerformShapeTests()
void	RunFit(const char* ws_filename, const char* ws_name, const char* data_name)
void	RunLimit()

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static AtlHistFactoryTask::ERunMode	kCreateFitTemplates
static AtlHistFactoryTask::ERunMode	kCreateShapeTemplates
static AtlHistFactoryTask::ERunMode	kCreateWorkspace
static AtlHistFactoryTask::ERunMode	kFitModel
static TObject::EStatusBits	TObject::kHasUUID
static AtlHistFactoryTask::ERunMode	kHypoTestLimit
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static AtlHistFactoryTask::ERunMode	kPerformShapeTests
static AtlHistFactoryTask::ERunMode	kRateTable
static TObject::(anonymous)	TObject::kSingleKey
static AtlHistFactoryTask::ERunMode	kUnknown
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

Bool_t	TTask::fActive	true if task is active
Bool_t	AtlTask::fBatchJob	Batch job execution
TString	AtlTask::fBatchNode	Node on which to run the job
Bool_t	AtlTask::fBatchNodeAll	Submit batch job to all nodes
Bool_t	AtlTask::fBatchNodeAutomatic	Submit batch job to node automatically set
Int_t	TTask::fBreakin	=1 if a break point set at task extry
Int_t	TTask::fBreakout	=1 if a break point set at task exit
Int_t	AtlTask::fDebug	Debug flag for derived tasks
Int_t	AtlTask::fDebugBuild	Debug flag for derived tasks (during build)
Long64_t	AtlTask::fFirstEntry	Skip FirstEntry-1 events
TString*	AtlTask::fGridCmtVersion	Cmt version for Grid submission
Bool_t	AtlTask::fGridJob	Grid job execution
TString*	AtlTask::fGridRootVersion	Root version for Grid submission
TString*	AtlTask::fGridSuffix	Suffix for grid dataset names
TString*	AtlTask::fGridUserName	Grid user name
Bool_t	TTask::fHasExecuted	True if task has executed
TString*	fHistFactoryDir
TList*	AtlTask::fInputEntryLists	Input entry lists file names
TList*	AtlTask::fInputFiles	Input file names
Bool_t	AtlTask::fInteractiveJob	Interactive job execution
Bool_t	AtlTask::fIsTest	Is test job ?
TString*	AtlTask::fJobHome	Job working directory
Bool_t	AtlTask::fLogFile	Write output to logfile
TString*	AtlTask::fLogFilePath	Logfile path
AtlHistFactoryMeasurement*	fMeasurement
Bool_t	AtlTask::fNAFBatchJob	NAF Batch job execution
Long64_t	AtlTask::fNEvents	No. of events to process
Int_t	fNPullsPerPad	Max. number of pulls per pad
TString	TNamed::fName	object identifier
Char_t	AtlTask::fNode	Node on which to run the jpb
TString	TTask::fOption	Option specified in ExecuteTask
TString*	AtlTask::fOutputFileName	Name of the output file
TNamed*	AtlTask::fOutputTreeName	Name and title of the output tree (if any)
Double_t	fPullScaleFactor	Scale factor between pull x-axis and impact on poi x-axis
AtlHistFactoryTask::ERunMode	fRunMode
TString*	AtlTask::fRunScript	Runscript path
TString*	fScheme	Name of plotting scheme
TList*	TTask::fTasks	List of Tasks
TString*	AtlTask::fTempLogFilePath	Temporarily logfile path
TString*	AtlTask::fTempOutputFileName	Temporarily output file name
TString*	AtlTask::fTempOutputPath	Temporarily output path (must start with "/")
TString*	fTemplateDir
TString	TNamed::fTitle	object title
static TTask*	TTask::fgBeginTask	pointer to task initiator
static TTask*	TTask::fgBreakPoint	pointer to current break point

Class Charts

Inheritance Chart:

TObject

←

TNamed

←

TTask

←

AtlTask

←

AtlHistFactoryTask

←

AtlHistFactoryBreakdownEntry

AtlHistFactoryPlotterTask

AtlHistFactoryYieldTableTask

Function documentation

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

 Default constructor

~AtlHistFactoryTask()

 Default destructor

void ExecInteractiveJob(Option_t* option)

 Exec interactive job

void ExecGridJob(Option_t* option)

 Exec grid job

Bool_t ExecBatchJob(Option_t* option)

 Exec batch job

void CreateRunScript(Option_t* option = "")

 Create Run Script

void ExecNAFBatchJob(Option_t* option)

 Exec NAF batch job

void CreateNAFBatchRunScript()

 Create NAF Batch Run Script

void CreateGridRunScript()

 Create Grid Run Script

void Initialize()

 Initialize HistFactory Task
 - check if measurement is set
 - set directories used by AtlTask

void CreateTemplates()

 Create templates for given measurement

void SetRunMode(AtlHistFactoryTask::ERunMode mode)

 Turn on/off creation of templates

void PerformShapeTests()

 Create templates for given measurement

void CreateWorkspace()

 Create RooStats workspace using HistFactory

void FitModel()

 Fit Model

void RunFit(const char* ws_filename, const char* ws_name, const char* data_name)

 Fit model saved in workspace

 Create log directory

void CreatePullPlots(const char* ws_filename, const char* ws_name, const char* data_name)

 Create pull plots for given workspace

 Create log directory

void GetImpactOnPOI(RooWorkspace* wSpace, const char* data_name, const char* snapshot, RooRealVar* par, const char* poi_name, Double_t variation, TH1F* hresult, const char* logdir)

 Get Impact on POI for given NP and store the result in the
 given histogram.

 ToDo:
 - Load snapshot beforehand and just provide pdf and parameter?
   maybe model?
 - Asymmetric errors

void GetTemplatesFileName(const char* channel, TString& filename)

 Get the name of the file holding all templates for this channel

void GetShapeTemplatesFileName(const char* channel, TString& filename)

 The name of the file holding all shape templates for this channel

TList* MergeListOfSystematics(TList* ch_systs, TList* sample_systs)

 Helper function to merge channel and sample systematics

 First create a new list from the ch_systs.
 If two systematics with the same name exist in both lists:
 - remove the systematic from the newly created list
 - then append all systematics from the second list to the newly
   created list

 The user has to take care of deleting the new list.

void ExportRateUncertainties()

 Export latex table with list of all rate uncertainties

Double_t GetNormUncertainty(const char* name)

 Get the normalization uncertainty associated to this parameter

TString* GetSystematicName(const char* par_name)

 Get the systematic name for the given parameter name

void ExportPullPlots(const char* outfile, TH1* h_pulls, TH1* h_pulls_err_up, TH1* h_pulls_err_down, TH1* h_prefit_impact_up, TH1* h_prefit_impact_down, TH1* h_postfit_impact_up, TH1* h_postfit_impact_down)

 Export pull plots to pdf

 Compute number of Pads needed for all pulls

void RunLimit()

 Run Hypothesis Test:
  - Signal Hypothesis vs. Background only Hypothesis

 Modified version of $ROOTSYS/tutorials/roostats/StandardHypoTestDemo.C

Double_t GetGammaUncertainty(const char* name, RooWorkspace* wSpace)

 Get the uncertainty associated to this parameter

 Assuming gamma has a gaussian constraint
 That's a nasty way of getting the sigma parameter
 of the gamma parameters, is there any other way?

TString* GetDirectoryName(const char* name)

 Return the name to a directory within the common output
 directory.
 If a directory with this name does not yet exist, it will
 be created.

 The user is responsible for deleting the returned pointer.

Bool_t IsNormParameter(const char* name)

 Is norm parameter

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

void SetMeasurement(AtlHistFactoryMeasurement* meas)

{ fMeasurement = meas; }