FW::PlotHelpers Namespace Reference

Classes
struct	Binning
	Nested binning struct for booking plots. More...

Functions
TH1F *	bookHisto (const char *histName, const char *histTitle, const Binning &varBinning)
	book a 1D histogram
TH2F *	bookHisto (const char *histName, const char *histTitle, const Binning &varXBinning, const Binning &varYBinning)
	book a 2D histogram
void	fillHisto (TH1F *hist, float value, float weight=1.0)
	fill a 1D histogram
void	fillHisto (TH2F *hist, float xValue, float yValue, float weight=1.0)
	fill a 2D histogram
void	anaHisto (TH1D *inputHist, int j, TH1F *meanHist, TH1F *widthHist)
	extract details, i.e. mean and width of a 1D histogram and fill them into histograms
TEfficiency *	bookEff (const char *effName, const char *effTitle, const Binning &varBinning)
	book a 1D efficiency plot
TEfficiency *	bookEff (const char *effName, const char *effTitle, const Binning &varXBinning, const Binning &varYBinning)
	book a 2D efficiency plot
void	fillEff (TEfficiency *efficiency, float value, bool status)
	fill a 1D efficiency plot
void	fillEff (TEfficiency *efficiency, float xValue, float yValue, bool status)
	fill a 2D efficiency plot
TProfile *	bookProf (const char *profName, const char *profTitle, const Binning &varXBinning, const Binning &varYBinning)
	book a TProfile plot
void	fillProf (TProfile *profile, float xValue, float yValue, float weight=1.0)
	fill a TProfile plot

Function Documentation

void FW::PlotHelpers::anaHisto	(	TH1D *	inputHist,
		int	j,
		TH1F *	meanHist,
		TH1F *	widthHist
	)

extract details, i.e. mean and width of a 1D histogram and fill them into histograms

Parameters

inputHist	histogram to investigate
j	which bin number of meanHist and widthHist to fill
meanHist	histogram to fill the mean value of inputHist
widthHist	histogram to fill the width value of inputHist

Definition at line 45 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 45 of file Helpers.cpp

References r.

Referenced by FW::ResPlotTool::refinement().

Here is the caller graph for this function:

TEfficiency * FW::PlotHelpers::bookEff	(	const char *	effName,
		const char *	effTitle,
		const Binning &	varBinning
	)

book a 1D efficiency plot

Parameters

effName	the name of plot
effTitle	the title of plot
varBinning	the binning info of variable

Returns

TEfficiency pointer

Definition at line 61 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 61 of file Helpers.cpp

References FW::PlotHelpers::Binning::max, FW::PlotHelpers::Binning::min, and FW::PlotHelpers::Binning::nBins.

Referenced by FW::EffPlotTool::book(), and FW::FakeRatePlotTool::book().

Here is the caller graph for this function:

TEfficiency * FW::PlotHelpers::bookEff	(	const char *	effName,
		const char *	effTitle,
		const Binning &	varXBinning,
		const Binning &	varYBinning
	)

book a 2D efficiency plot

Parameters

effName	the name of plot
effTitle	the title of plot
varXBinning	the binning info of variable at x axis
varYBinning	the binning info of variable at y axis

Returns

TEfficiency pointer

Definition at line 68 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 68 of file Helpers.cpp

References FW::PlotHelpers::Binning::max, FW::PlotHelpers::Binning::min, and FW::PlotHelpers::Binning::nBins.

TH1F * FW::PlotHelpers::bookHisto	(	const char *	histName,
		const char *	histTitle,
		const Binning &	varBinning
	)

book a 1D histogram

Parameters

histName	the name of histogram
histTitle	the title of histogram
varBinning	the binning info of variable

Returns

histogram pointer

Definition at line 14 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 14 of file Helpers.cpp

References hist, FW::PlotHelpers::Binning::max, FW::PlotHelpers::Binning::min, FW::PlotHelpers::Binning::nBins, and FW::PlotHelpers::Binning::title.

Referenced by FW::FakeRatePlotTool::book(), and FW::ResPlotTool::book().

Here is the caller graph for this function:

TH2F * FW::PlotHelpers::bookHisto	(	const char *	histName,
		const char *	histTitle,
		const Binning &	varXBinning,
		const Binning &	varYBinning
	)

book a 2D histogram

Parameters

histName	the name of histogram
histTitle	the title of histogram
varXBinning	the binning info of variable at x axis
varYBinning	the binning info of variable at y axis

Returns

histogram pointer

Definition at line 24 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 24 of file Helpers.cpp

References hist, FW::PlotHelpers::Binning::max, FW::PlotHelpers::Binning::min, FW::PlotHelpers::Binning::nBins, and FW::PlotHelpers::Binning::title.

TProfile * FW::PlotHelpers::bookProf	(	const char *	profName,
		const char *	profTitle,
		const Binning &	varXBinning,
		const Binning &	varYBinning
	)

book a TProfile plot

Parameters

profName	the name of plot
profTitle	the title of plot
varXBinning	the binning info of variable at x axis
varYBinning	the binning info of variable at y axis

Returns

TProfile pointer

Definition at line 86 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 86 of file Helpers.cpp

References FW::PlotHelpers::Binning::max, FW::PlotHelpers::Binning::min, FW::PlotHelpers::Binning::nBins, and FW::PlotHelpers::Binning::title.

Referenced by FW::TrackSummaryPlotTool::book(), and FW::FakeRatePlotTool::book().

Here is the caller graph for this function:

void FW::PlotHelpers::fillEff	(	TEfficiency *	efficiency,
		float	value,
		bool	status
	)

fill a 1D efficiency plot

Parameters

efficiency	plot to fill
value	value to fill
status	bool to denote passed or not

Definition at line 76 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 76 of file Helpers.cpp

Referenced by FW::EffPlotTool::fill(), and FW::FakeRatePlotTool::fill().

Here is the caller graph for this function:

void FW::PlotHelpers::fillEff	(	TEfficiency *	efficiency,
		float	xValue,
		float	yValue,
		bool	status
	)

fill a 2D efficiency plot

Parameters

efficiency	plot to fill
xValue	x value to fill
yValue	y value to fill
status	bool to denote passed or not

Definition at line 81 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 81 of file Helpers.cpp

void FW::PlotHelpers::fillHisto	(	TH1F *	hist,
		float	value,
		float	weight = 1.0
	)

fill a 1D histogram

Parameters

hist	histogram to fill
value	value to fill
weight	weight to fill

Definition at line 35 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 35 of file Helpers.cpp

Referenced by FW::FakeRatePlotTool::fill(), and FW::ResPlotTool::fill().

Here is the caller graph for this function:

void FW::PlotHelpers::fillHisto	(	TH2F *	hist,
		float	xValue,
		float	yValue,
		float	weight = 1.0
	)

fill a 2D histogram

Parameters

hist	histogram to fill
xValue	x value to fill
yValue	y value to fill
weight	weight to fill

Definition at line 40 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 40 of file Helpers.cpp

void FW::PlotHelpers::fillProf	(	TProfile *	profile,
		float	xValue,
		float	yValue,
		float	weight = 1.0
	)

fill a TProfile plot

Parameters

profile	plot to fill
xValue	xvalue to fill
yValue	yvalue to fill
weight	weight to fill

Definition at line 96 of file Helpers.cpp.

View newest version in sPHENIX GitHub at line 96 of file Helpers.cpp

Referenced by FW::TrackSummaryPlotTool::fill(), and FW::FakeRatePlotTool::fill().

Here is the caller graph for this function: