Virtual base class for histograms. More...

#include "NAGASH/HistBase.h"

Inheritance diagram for NAGASH::HistBase:

Public Types
enum class	SystPolicy { Average , Maximum , Variance , CTEQ , Backup }
	Policies of dealing with systematic uncertainties. More...

Public Member Functions
virtual	~HistBase ()=default

virtual bool	BookSystematicVariation (const std::vector< TString > &names, double corr_factor=0, SystPolicy policy=SystPolicy::Maximum)

virtual bool	BookSystematicVariation (const TString &name, double corr_factor=0, SystPolicy policy=SystPolicy::Maximum)

virtual bool	BookSystematicVariation (const TString &name1, const TString &name2, double corr_factor=0, SystPolicy policy=SystPolicy::Maximum)

virtual void	ClearLinkPlot ()

virtual TH1 *	GetNominalHistVirtual ()

virtual size_t	GetNVariations ()

virtual double	GetVariationCorrelationFactor (const TString &)

virtual TString	GetVariationName (uint64_t)

virtual std::vector< std::tuple< std::vector< TString >, double, SystPolicy > >	GetVariationTypes ()

virtual TH1 *	GetVariationVirtual (const TString &)

virtual TH1 *	GetVariationVirtual (uint64_t)

virtual bool	IsBackupVariation (const TString &)

virtual bool	IsBackupVariation (uint64_t)

virtual bool	Process ()

virtual bool	Recover ()

virtual bool	Recover (const TString &filename)

virtual bool	Recover (std::shared_ptr< TFileHelper >)

virtual bool	Recover (TFile *file)

virtual bool	RegroupSystematicVariation (const std::vector< TString > &names, SystPolicy policy)

virtual bool	RemoveSystematicVariation (const TString &name)

virtual bool	RenameSystematicVariation (const TString &name_old, const TString &name_new)

virtual void	Reset ()

virtual void	Scale (double)

virtual void	SetLinkPlot (uint64_t index, std::shared_ptr< HistBase > subplot)

virtual void	SetLinkType (const TString &)

virtual void	SetLinkType (std::function< double(const std::vector< double > &)>, std::function< double(const std::vector< double > &, const std::vector< double > &)>)

virtual void	SetLinkType (std::function< void(const std::vector< TH1 * > &, TH1 *)>)

virtual bool	SetSystematicVariation (const TString &name="Nominal")

virtual bool	SetSystematicVariation (uint64_t index)

virtual void	SetUnprocessed ()

virtual void	Write ()

Public Member Functions inherited from NAGASH::Result
virtual void	Combine (std::shared_ptr< Result > result)
	Return the name of the output file.

const TString &	GetOutputFileName ()
	Return the name of the result.

const TString &	GetResultName ()

virtual void	WriteToFile ()

Protected Member Functions
	HistBase (std::shared_ptr< MSGTool > MSG, std::shared_ptr< ConfigTool > c, const TString &name, const TString &filename)

virtual std::shared_ptr< HistBase >	CloneVirtual (const TString &name)

Protected Member Functions inherited from NAGASH::Result
	Result ()=delete

	Result (const Result &result)=delete

	Result (Result &&result)=delete

	Result (std::shared_ptr< MSGTool > MSG, std::shared_ptr< ConfigTool > c, const TString &rname, const TString &fname="")
	virtual interface to write the result to a file.

virtual	~Result ()=default

std::shared_ptr< ConfigTool >	ConfigUser ()
	Return the internal ConfigTool.>

std::shared_ptr< MSGTool >	MSGUser ()
	Return the internal MSGTool.

Result &	operator= (const Result &result)=delete

Result &	operator= (Result &&result)=delete

void	SetOutputFileName (const TString &fileName)
	Set the output file name of the result.

Toolkit *	ToolkitUser ()
	Return the internal Toolkit.

Friends
class	PlotGroup

Detailed Description

Virtual base class for histograms.

Definition at line 26 of file HistBase.h.

Member Enumeration Documentation

◆ SystPolicy

enum class NAGASH::HistBase::SystPolicy

strong

Policies of dealing with systematic uncertainties.

Enumerator
Average	take the average difference \(\bar{O_{\text{var}}-O_{\text{nominal}}}\) in the same group.
Maximum	take the maximum difference \(\max(O_{\text{var}}-O_{\text{nominal}})\) in the same group.
Variance	the variance of the all systematic variations in the same group.
CTEQ	up - down, \((O_\text{up}-O_\text{down})/2\)
Backup	not add to total systematic uncertainties, just for future use.

Definition at line 32 of file HistBase.h.

Constructor & Destructor Documentation

◆ HistBase()

NAGASH::HistBase::HistBase	(	std::shared_ptr< MSGTool >	MSG,
		std::shared_ptr< ConfigTool >	c,
		const TString &	name,
		const TString &	filename
	)

inlineprotected

Definition at line 42 of file HistBase.h.

◆ ~HistBase()

virtual NAGASH::HistBase::~HistBase ( )

virtualdefault

Member Function Documentation

◆ BookSystematicVariation() [1/3]

virtual bool NAGASH::HistBase::BookSystematicVariation	(	const std::vector< TString > &	names,
		double	corr_factor = `0`,
		SystPolicy	policy = `SystPolicy::Maximum`
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 48 of file HistBase.h.

◆ BookSystematicVariation() [2/3]

virtual bool NAGASH::HistBase::BookSystematicVariation	(	const TString &	name,
		double	corr_factor = `0`,
		SystPolicy	policy = `SystPolicy::Maximum`
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 46 of file HistBase.h.

◆ BookSystematicVariation() [3/3]

virtual bool NAGASH::HistBase::BookSystematicVariation	(	const TString &	name1,
		const TString &	name2,
		double	corr_factor = `0`,
		SystPolicy	policy = `SystPolicy::Maximum`
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 47 of file HistBase.h.

◆ ClearLinkPlot()

virtual void NAGASH::HistBase::ClearLinkPlot ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 49 of file HistBase.h.

◆ CloneVirtual()

virtual std::shared_ptr< HistBase > NAGASH::HistBase::CloneVirtual ( const TString & name )

inlineprotectedvirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 43 of file HistBase.h.

◆ GetNominalHistVirtual()

virtual TH1 * NAGASH::HistBase::GetNominalHistVirtual ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 50 of file HistBase.h.

◆ GetNVariations()

virtual size_t NAGASH::HistBase::GetNVariations ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 51 of file HistBase.h.

◆ GetVariationCorrelationFactor()

virtual double NAGASH::HistBase::GetVariationCorrelationFactor ( const TString & )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 52 of file HistBase.h.

◆ GetVariationName()

virtual TString NAGASH::HistBase::GetVariationName ( uint64_t )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 53 of file HistBase.h.

◆ GetVariationTypes()

virtual std::vector< std::tuple< std::vector< TString >, double, SystPolicy > > NAGASH::HistBase::GetVariationTypes ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 54 of file HistBase.h.

◆ GetVariationVirtual() [1/2]

virtual TH1 * NAGASH::HistBase::GetVariationVirtual ( const TString & )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 56 of file HistBase.h.

◆ GetVariationVirtual() [2/2]

virtual TH1 * NAGASH::HistBase::GetVariationVirtual ( uint64_t )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 55 of file HistBase.h.

◆ IsBackupVariation() [1/2]

virtual bool NAGASH::HistBase::IsBackupVariation ( const TString & )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 58 of file HistBase.h.

◆ IsBackupVariation() [2/2]

virtual bool NAGASH::HistBase::IsBackupVariation ( uint64_t )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 57 of file HistBase.h.

◆ Process()

virtual bool NAGASH::HistBase::Process ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 59 of file HistBase.h.

◆ Recover() [1/4]

virtual bool NAGASH::HistBase::Recover ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 60 of file HistBase.h.

◆ Recover() [2/4]

virtual bool NAGASH::HistBase::Recover ( const TString & filename )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 62 of file HistBase.h.

◆ Recover() [3/4]

virtual bool NAGASH::HistBase::Recover ( std::shared_ptr< TFileHelper > )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 63 of file HistBase.h.

◆ Recover() [4/4]

virtual bool NAGASH::HistBase::Recover ( TFile * file )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 61 of file HistBase.h.

◆ RegroupSystematicVariation()

virtual bool NAGASH::HistBase::RegroupSystematicVariation	(	const std::vector< TString > &	names,
		SystPolicy	policy
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 64 of file HistBase.h.

◆ RemoveSystematicVariation()

virtual bool NAGASH::HistBase::RemoveSystematicVariation ( const TString & name )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 65 of file HistBase.h.

◆ RenameSystematicVariation()

virtual bool NAGASH::HistBase::RenameSystematicVariation	(	const TString &	name_old,
		const TString &	name_new
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 66 of file HistBase.h.

◆ Reset()

virtual void NAGASH::HistBase::Reset ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 67 of file HistBase.h.

◆ Scale()

virtual void NAGASH::HistBase::Scale ( double )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 68 of file HistBase.h.

◆ SetLinkPlot()

virtual void NAGASH::HistBase::SetLinkPlot	(	uint64_t	index,
		std::shared_ptr< HistBase >	subplot
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 69 of file HistBase.h.

◆ SetLinkType() [1/3]

virtual void NAGASH::HistBase::SetLinkType ( const TString & )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 70 of file HistBase.h.

◆ SetLinkType() [2/3]

virtual void NAGASH::HistBase::SetLinkType	(	std::function< double(const std::vector< double > &)>	,
		std::function< double(const std::vector< double > &, const std::vector< double > &)>
	)

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 71 of file HistBase.h.

◆ SetLinkType() [3/3]

virtual void NAGASH::HistBase::SetLinkType ( std::function< void(const std::vector< TH1 * > &, TH1 *)> )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 72 of file HistBase.h.

◆ SetSystematicVariation() [1/2]

virtual bool NAGASH::HistBase::SetSystematicVariation ( const TString & name = "Nominal" )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 74 of file HistBase.h.

◆ SetSystematicVariation() [2/2]

virtual bool NAGASH::HistBase::SetSystematicVariation ( uint64_t index )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 73 of file HistBase.h.

◆ SetUnprocessed()

virtual void NAGASH::HistBase::SetUnprocessed ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 75 of file HistBase.h.

◆ Write()

virtual void NAGASH::HistBase::Write ( )

inlinevirtual

Reimplemented in NAGASH::NGHist< HistType >.

Definition at line 76 of file HistBase.h.

Friends And Related Symbol Documentation

◆ PlotGroup

friend class PlotGroup

friend

Definition at line 28 of file HistBase.h.

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

include/NAGASH/HistBase.h

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ SystPolicy

Constructor & Destructor Documentation

◆ HistBase()

◆ ~HistBase()

Member Function Documentation

◆ BookSystematicVariation() [1/3]

◆ BookSystematicVariation() [2/3]

◆ BookSystematicVariation() [3/3]

◆ ClearLinkPlot()

◆ CloneVirtual()

◆ GetNominalHistVirtual()

◆ GetNVariations()

◆ GetVariationCorrelationFactor()

◆ GetVariationName()

◆ GetVariationTypes()

◆ GetVariationVirtual() [1/2]

◆ GetVariationVirtual() [2/2]

◆ IsBackupVariation() [1/2]

◆ IsBackupVariation() [2/2]

◆ Process()

◆ Recover() [1/4]

◆ Recover() [2/4]

◆ Recover() [3/4]

◆ Recover() [4/4]

◆ RegroupSystematicVariation()

◆ RemoveSystematicVariation()

◆ RenameSystematicVariation()

◆ Reset()

◆ Scale()

◆ SetLinkPlot()

◆ SetLinkType() [1/3]

◆ SetLinkType() [2/3]

◆ SetLinkType() [3/3]

◆ SetSystematicVariation() [1/2]

◆ SetSystematicVariation() [2/2]

◆ SetUnprocessed()

◆ Write()

Friends And Related Symbol Documentation

◆ PlotGroup