Combines histograms with the same name from different files in one overlay histogram. More...

#include <PndHistoCombiner.h>

Inheritance diagram for PndHistoCombiner:

Classes
struct	fileData

struct	histoComparisonValues

Public Member Functions
	PndHistoCombiner ()

virtual	~PndHistoCombiner ()

void	AddFileNamesAndShortName (TString fileName, TString shortName)
	Adds the file which contain the histos to be plotted together. First file is the one comparisons are made to. More...

int	GenerateHistos ()
	Main method to generate histograms. More...

int	GenerateBranches ()
	Main method to generate histograms from branches. More...

void	AddHistoSelector (TString histoName)
	Only those histograms are combined with part of their matching the histoName. More...

void	AddBranchSelector (TString branchName)
	Only those branches are combined with part of their matching the branchName. More...

void	SetPicPerCan (int val)
	pictures per canvas. They will be organized in a quadratic way More...

void	SetCanvasPrefix (TString val)

void	SetCanvasOutputDir (TString val)

void	SetCanvasOutputFormat (TString val)

void	SetPulls (bool dopulls=true)

void	SetDimensions (int x=400, int y=300)

void	SetGlobalThresholds (double thresholdKol=0.03, double thresholdChi2=-1.0, double thresholdAD=-1.0)
	perform Kolmogorov or chi2 test between histograms of first file and all others. More...

void	AddHistoThresholds (TString histoName, double thresholdKol=0.03, double thresholdChi2=-1.0, double thresholdAD=-1.0)

void	AddHistoThresholds (TString histoName, std::vector< double > thresholds)

void	SetCDashOutput (bool val=true)
	Select to generate output string automatically to upload data to CDASH server. More...

void	CreateCDashOutput ()
	Generate output string to upload data to CDASH server This can be called automatically or by hand. More...

Protected Member Functions
void	InitFiles ()

bool	CheckHistoName (TString histoName)

bool	CheckBranchName (TString branchName)

bool	CheckBranchType (TString branchType)

void	DrawAndTestHistoStack (std::vector< TH1 *> &histos)

void	DrawAndTest2DHistoStack (std::vector< TH1 *> &histos)

std::pair< TPad , TPad >	SplitPadForPulls ()

void	DrawPulls (std::vector< TH1 *> &histos)

void	CreateLegend (std::vector< TH1 *> &histos)

histoComparisonValues	PerformTest (TH1 h1, TH1 h2)

bool	TestPassed (TString &histoTitle, histoComparisonValues results, histoComparisonValues thresholds)

void	AddCDashOutput (TString prefix, TString histoName, histoComparisonValues value)
	Add to output string to upload data to CDASH server. More...

TString	RemoveSpecialCharacters (TString input)

Detailed Description

Combines histograms with the same name from different files in one overlay histogram.

The class runs through all histograms or branches of the first file given and checks if histograms/branches with the same name exist in the other files. If this is the case they are plotted into a common histogram via the option "same". The legend of the histogram is filled with the short name given by the user. The histograms are saved in a canvas as jpg files. The number of histograms per canvas can be set. In addition it is possible to perform a Kolmogorov, Chisquare or Anderson test between the first and all other histograms in one stack. If the test fail the word "FAILED" will be added to the title of the histogram. Furthermore, a cdash output can be created which uploads the probability of the test to the cdash server.

Author: Tobias Stockmanns t.sto.nosp@m.ckma.nosp@m.nns@f.nosp@m.z-ju.nosp@m.elich.nosp@m..de

Date: 2021-06-01

Definition at line 32 of file PndHistoCombiner.h.

Constructor & Destructor Documentation

◆ PndHistoCombiner()

PndHistoCombiner::PndHistoCombiner ( )

◆ ~PndHistoCombiner()

virtual PndHistoCombiner::~PndHistoCombiner ( )

virtual

Member Function Documentation

◆ AddBranchSelector()

void PndHistoCombiner::AddBranchSelector ( TString branchName )

inline

Only those branches are combined with part of their matching the branchName.

Parameters

branchName part of the histo name to be compared

Definition at line 84 of file PndHistoCombiner.h.

84 { fBranchSelector.push_back(branchName); }

◆ AddCDashOutput()

void PndHistoCombiner::AddCDashOutput	(	TString	prefix,
		TString	histoName,
		histoComparisonValues	value
	)

protected

Add to output string to upload data to CDASH server.

Referenced by TestPassed().

◆ AddFileNamesAndShortName()

void PndHistoCombiner::AddFileNamesAndShortName	(	TString	fileName,
		TString	shortName
	)

inline

Adds the file which contain the histos to be plotted together. First file is the one comparisons are made to.

Parameters

fileName	full path to file
shortName	name displayed in histogram legend

Definition at line 58 of file PndHistoCombiner.h.

References GenerateBranches(), and GenerateHistos().

   {
     fileData myData(fileName, shortName);
     fFileData.push_back(myData);
   }

◆ AddHistoSelector()

void PndHistoCombiner::AddHistoSelector ( TString histoName )

inline

Only those histograms are combined with part of their matching the histoName.

Parameters

histoName part of the histo name to be compared

Definition at line 78 of file PndHistoCombiner.h.

78 { fHistoSelector.push_back(histoName); }

◆ AddHistoThresholds() [1/2]

void PndHistoCombiner::AddHistoThresholds	(	TString	histoName,
		double	thresholdKol = `0.03`,
		double	thresholdChi2 = `-1.0`,
		double	thresholdAD = `-1.0`
	)

inline

Definition at line 115 of file PndHistoCombiner.h.

References PndHistoCombiner::histoComparisonValues::fAD, PndHistoCombiner::histoComparisonValues::fChi2, and PndHistoCombiner::histoComparisonValues::fKol.

Referenced by AddHistoThresholds(), and SetGlobalThresholds().

                                                                                                                                 {
       histoComparisonValues thresholds;
       thresholds.fKol = thresholdKol;
       thresholds.fChi2 = thresholdChi2;
       thresholds.fAD = thresholdAD;
       fThresholds.push_back(std::make_pair(histoName, thresholds));
   }

◆ AddHistoThresholds() [2/2]

void PndHistoCombiner::AddHistoThresholds	(	TString	histoName,
		std::vector< double >	thresholds
	)

inline

Definition at line 123 of file PndHistoCombiner.h.

References AddHistoThresholds().

                                                                           {
       if (thresholds.size() == 3)
           AddHistoThresholds(histoName, thresholds[0], thresholds[1], thresholds[2]);
       else {
           LOG(warning) << "Wrong number of threshold values: " << histoName << " : " << thresholds.size();
       }
   }

◆ CheckBranchName()

bool PndHistoCombiner::CheckBranchName ( TString branchName )

protected

Referenced by SetCDashOutput().

◆ CheckBranchType()

bool PndHistoCombiner::CheckBranchType ( TString branchType )

protected

Referenced by SetCDashOutput().

◆ CheckHistoName()

bool PndHistoCombiner::CheckHistoName ( TString histoName )

protected

Referenced by SetCDashOutput().

◆ CreateCDashOutput()

void PndHistoCombiner::CreateCDashOutput ( )

Generate output string to upload data to CDASH server This can be called automatically or by hand.

Referenced by SetCDashOutput().

◆ CreateLegend()

void PndHistoCombiner::CreateLegend ( std::vector< TH1 *> & histos )

protected

Referenced by SetCDashOutput().

◆ DrawAndTest2DHistoStack()

void PndHistoCombiner::DrawAndTest2DHistoStack ( std::vector< TH1 *> & histos )

protected

Referenced by SetCDashOutput().

◆ DrawAndTestHistoStack()

void PndHistoCombiner::DrawAndTestHistoStack ( std::vector< TH1 *> & histos )

protected

Referenced by SetCDashOutput().

◆ DrawPulls()

void PndHistoCombiner::DrawPulls ( std::vector< TH1 *> & histos )

protected

Referenced by SetCDashOutput().

◆ GenerateBranches()

int PndHistoCombiner::GenerateBranches ( )

Main method to generate histograms from branches.

Referenced by AddFileNamesAndShortName().

◆ GenerateHistos()

int PndHistoCombiner::GenerateHistos ( )

Main method to generate histograms.

Referenced by AddFileNamesAndShortName().

◆ InitFiles()

void PndHistoCombiner::InitFiles ( )

protected

Referenced by SetCDashOutput().

◆ PerformTest()

histoComparisonValues PndHistoCombiner::PerformTest	(	TH1 *	h1,
		TH1 *	h2
	)

protected

Referenced by SetCDashOutput().

◆ RemoveSpecialCharacters()

TString PndHistoCombiner::RemoveSpecialCharacters ( TString input )

protected

Referenced by TestPassed().

◆ SetCanvasOutputDir()

void PndHistoCombiner::SetCanvasOutputDir ( TString val )

inline

Definition at line 93 of file PndHistoCombiner.h.

93 { fCanCreator.SetOutputDir(val); }

PndMultiCanvasCreator::SetOutputDir

void SetOutputDir(TString val)

Definition: PndMultiCanvasCreator.h:34

◆ SetCanvasOutputFormat()

void PndHistoCombiner::SetCanvasOutputFormat ( TString val )

inline

Definition at line 94 of file PndHistoCombiner.h.

94 { fCanCreator.SetOutputFormat(val); }

PndMultiCanvasCreator::SetOutputFormat

void SetOutputFormat(TString val)

Definition: PndMultiCanvasCreator.h:35

◆ SetCanvasPrefix()

void PndHistoCombiner::SetCanvasPrefix ( TString val )

inline

Definition at line 92 of file PndHistoCombiner.h.

92 { fCanCreator.SetPrefix(val); }

PndMultiCanvasCreator::SetPrefix

void SetPrefix(TString val)

Definition: PndMultiCanvasCreator.h:33

◆ SetCDashOutput()

void PndHistoCombiner::SetCDashOutput ( bool val = true )

inline

Select to generate output string automatically to upload data to CDASH server.

Definition at line 134 of file PndHistoCombiner.h.

References CheckBranchName(), CheckBranchType(), CheckHistoName(), CreateCDashOutput(), CreateLegend(), DrawAndTest2DHistoStack(), DrawAndTestHistoStack(), DrawPulls(), InitFiles(), PerformTest(), and SplitPadForPulls().

134 { fCreateCDashOutput = val; }

◆ SetDimensions()

void PndHistoCombiner::SetDimensions	(	int	x = `400`,
		int	y = `300`
	)

inline

Definition at line 102 of file PndHistoCombiner.h.

102 { fCanCreator.SetDimensions(x, y); }

PndMultiCanvasCreator::SetDimensions

void SetDimensions(int x=800, int y=600)

Definition: PndMultiCanvasCreator.h:27

◆ SetGlobalThresholds()

void PndHistoCombiner::SetGlobalThresholds	(	double	thresholdKol = `0.03`,
		double	thresholdChi2 = `-1.0`,
		double	thresholdAD = `-1.0`
	)

inline

perform Kolmogorov or chi2 test between histograms of first file and all others.

Parameters

val	test type. 0: none, 1: Kolmogorov test, 2: chisquare test
threshold	for the probability of the test. Every p larger than threshold will be counted as passed

Definition at line 109 of file PndHistoCombiner.h.

References AddHistoThresholds().

   {
       fThresholds.clear();
       AddHistoThresholds("", thresholdKol, thresholdChi2, thresholdAD);
   }

◆ SetPicPerCan()

void PndHistoCombiner::SetPicPerCan ( int val )

inline

pictures per canvas. They will be organized in a quadratic way

Parameters

val	number of pictures/pads

Definition at line 91 of file PndHistoCombiner.h.

91 { fCanCreator.SetPicPerCan(val); }

PndMultiCanvasCreator::SetPicPerCan

void SetPicPerCan(int val)

Definition: PndMultiCanvasCreator.h:32

◆ SetPulls()

void PndHistoCombiner::SetPulls ( bool dopulls = true )

inline

Definition at line 96 of file PndHistoCombiner.h.

   {
     fDoPulls = dopulls;
 //    SetDimensions(400, 400);
   }

◆ SplitPadForPulls()

std::pair<TPad *, TPad *> PndHistoCombiner::SplitPadForPulls ( )

protected

Referenced by SetCDashOutput().

◆ TestPassed()

bool PndHistoCombiner::TestPassed	(	TString &	histoTitle,
		histoComparisonValues	results,
		histoComparisonValues	thresholds
	)

inlineprotected

Definition at line 152 of file PndHistoCombiner.h.

References AddCDashOutput(), PndHistoCombiner::histoComparisonValues::fAD, PndHistoCombiner::histoComparisonValues::fChi2, PndHistoCombiner::histoComparisonValues::fKol, and RemoveSpecialCharacters().

   {
     bool result = true;
     if (thresholds.fKol > 0){
         if (results.fKol < thresholds.fKol)
             result = false;
         histoTitle += " P(K)= ";
         histoTitle += (TString::Format("%.2f", results.fKol));
     }
     if (thresholds.fChi2 > 0){
         if (results.fChi2 < thresholds.fChi2)
             result = false;
         histoTitle += " /P(#Chi^{2})= ";
         histoTitle += (TString::Format("%.2f", results.fChi2));
     }
     if (thresholds.fAD > 0){
         if (results.fAD < thresholds.fAD)
             result = false;
         histoTitle += " /P(AD)= ";
         histoTitle += (TString::Format("%.2f", results.fAD));
     }
     return result;
   }

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

PndHistoCombiner.h

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PndHistoCombiner()

◆ ~PndHistoCombiner()

Member Function Documentation

◆ AddBranchSelector()

◆ AddCDashOutput()

◆ AddFileNamesAndShortName()

◆ AddHistoSelector()

◆ AddHistoThresholds() [1/2]

◆ AddHistoThresholds() [2/2]

◆ CheckBranchName()

◆ CheckBranchType()

◆ CheckHistoName()

◆ CreateCDashOutput()

◆ CreateLegend()

◆ DrawAndTest2DHistoStack()

◆ DrawAndTestHistoStack()

◆ DrawPulls()

◆ GenerateBranches()

◆ GenerateHistos()

◆ InitFiles()

◆ PerformTest()

◆ RemoveSpecialCharacters()

◆ SetCanvasOutputDir()

◆ SetCanvasOutputFormat()

◆ SetCanvasPrefix()

◆ SetCDashOutput()

◆ SetDimensions()

◆ SetGlobalThresholds()

◆ SetPicPerCan()

◆ SetPulls()

◆ SplitPadForPulls()

◆ TestPassed()